fix(gelf encoder): gelf encoder error message #23021
Open
+9
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The error message in case the field name contains incorrect characters is misleading and can cause
quite an confusion.
The issue can be reproduced with following Vector config:
```yaml
sources:
test:
type: demo_logs
format: shuffle
decoding:
codec: json
count: 1
lines:
- '{"foo:baz": "baz", "short_message": "x"}'
sinks:
console:
type: console
encoding:
codec: gelf
inputs:
- test
```
With current version of vector I got:
```sh
❯ vector -c /tmp/vector.yaml -q
2025-05-09T19:55:47.827681Z ERROR sink{component_kind="sink" component_id=console component_type=console}: vector::internal_events::codecs: Failed serializing frame. error=LogEvent does not contain required field: "foo:baz" error_code="encoder_serialize" error_type="encoder_failed" stage="sending" internal_log_rate_limit=true
2025-05-09T19:55:47.827769Z ERROR sink{component_kind="sink" component_id=console component_type=console}: vector_common::internal_event::component_events_dropped: Events dropped intentional=false count=1 reason="Failed serializing frame." internal_log_rate_limit=true
2025-05-09T19:55:47.827800Z ERROR sink{component_kind="sink" component_id=console component_type=console}: vector::topology: An error occurred that Vector couldn't handle: the task completed with an error.
```
The part where it says `LogEvent does not contain required field: "foo:baz"` is quite confusing,
because the field is there and it's certainly not required. (though that might not be obvious for
less unusual field name)
It looks like the error message was there since early gelf implementation and not really
intentional. (possibly a placeholder that was never replaced)
The fixed version generates pretty straightforward message:
```
❯ vector -c /tmp/vector.yaml -q
2025-05-09T20:22:13.387678Z ERROR sink{component_kind="sink" component_id=console component_type=console}: vector::internal_events::codecs: Failed serializing frame. error=LogEvent contains field with invalid character in name: "foo:baz" error_code="encoder_serialize" error_type="encoder_failed" stage="sending" internal_log_rate_limit=true
2025-05-09T20:22:13.388008Z ERROR sink{component_kind="sink" component_id=console component_type=console}: vector_common::internal_event::component_events_dropped: Events dropped intentional=false count=1 reason="Failed serializing frame." internal_log_rate_limit=true
2025-05-09T20:22:13.388544Z ERROR sink{component_kind="sink" component_id=console component_type=console}: vector::topology: An error occurred that Vector couldn't handle: the task completed with an error.
```
This should hopefully be much easier to troubleshoot.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The error message in case the field name contains incorrect characters is misleading and can cause quite an confusion.
The issue can be reproduced with following Vector config:
With current version of vector I got:
❯ vector -c /tmp/vector.yaml -q 2025-05-09T19:55:47.827681Z ERROR sink{component_kind="sink" component_id=console component_type=console}: vector::internal_events::codecs: Failed serializing frame. error=LogEvent does not contain required field: "foo:baz" error_code="encoder_serialize" error_type="encoder_failed" stage="sending" internal_log_rate_limit=true 2025-05-09T19:55:47.827769Z ERROR sink{component_kind="sink" component_id=console component_type=console}: vector_common::internal_event::component_events_dropped: Events dropped intentional=false count=1 reason="Failed serializing frame." internal_log_rate_limit=true 2025-05-09T19:55:47.827800Z ERROR sink{component_kind="sink" component_id=console component_type=console}: vector::topology: An error occurred that Vector couldn't handle: the task completed with an error.The part where it says
LogEvent does not contain required field: "foo:baz"is quite confusing, because the field is there and it's certainly not required. (though that might not be obvious for less unusual field name)It looks like the error message was there since early gelf implementation and not really intentional. (possibly a placeholder that was never replaced)
The fixed version generates pretty straightforward message:
This should hopefully be much easier to troubleshoot.
Change Type
Is this a breaking change?
How did you test this PR?
I've tested it with above configuration.
Does this PR include user facing changes?