Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formatters can not fail when formatting an event #47

Merged
merged 1 commit into from
Oct 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Clear in-memory subscriptions when a SIGHUP signal is received, resulting in all file descriptors used by subscriptions being closed (#37)
- `heartbeats_queue_size` now defaults to 2048 instead of 32 (#37)
- **Breaking change**: Keytab file path must be specified only once for all collectors (using Kerberos authentication)
- A malformed event will no longer stop the event stream (for a computer/subscription) because formatters are not allowed to fail. In problematic cases, some work is done to try to recover the raw data of the event, and an `OpenWEC.Error` field is added (in the JSON formatter) to help catch the problem (#47)

## [0.1.0] - 2023-05-30

Expand Down
6 changes: 6 additions & 0 deletions doc/formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ openwec_data := {
"Version": string,
"Uuid": string,
"Uri": string
},
/* Only in case of error during event parsing or serializing */
"Error": {
"OriginalContent": string,
"Type": string,
"Message": string
}
}

Expand Down
Loading