pipeline: parsers: decoders: general cleanup #1878
Open
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
Signed-off-by: Alexa Kreizinger <[email protected]>
alexakreizinger
commented
Jul 8, 2025
Signed-off-by: Alexa Kreizinger <[email protected]>
cnorris-cs
reviewed
Jul 9, 2025
| There are cases where the log messages being parsed contain encoded data. A typical | ||
| use case can be found in containerized environments with Docker. Docker logs its | ||
| data in JSON format, which uses escaped strings. | ||
| There are cases where the log messages that you want to parse contain encoded data. A typical use case can be found in containerized environments with Docker. Docker logs its data in JSON format, which uses escaped strings. |
There was a problem hiding this comment.
Suggested change
| There are cases where the log messages that you want to parse contain encoded data. A typical use case can be found in containerized environments with Docker. Docker logs its data in JSON format, which uses escaped strings. | |
| There are cases where the log messages you want to parse contain encoded data. A typical use case can be found in containerized environments with Docker. Docker logs its data in JSON format, which uses escaped strings. |
cnorris-cs
reviewed
Jul 9, 2025
| @@ -16,20 +14,18 @@ The Docker log message encapsulates something like this: | |||
| {"log":"{\"status\": \"up and running\"}\r\n","stream":"stdout","time":"2018-03-09T01:01:44.851160855Z"} | |||
| ``` | |||
|
|
|||
| The original message is handled as an escaped string. Fluent Bit wants to use the | |||
| original structured message and not a string. | |||
| The original message is handled as an escaped string. Fluent Bit wants to use the original structured message and not a string. | |||
There was a problem hiding this comment.
Wanting something is what a human would do, and not an application. It can request things. It can do things. But it doesn't want things.
Suggested change
| The original message is handled as an escaped string. Fluent Bit wants to use the original structured message and not a string. | |
| The original message is handled as an escaped string. Fluent Bit will use the original structured message, and not a string. |
cnorris-cs
reviewed
Jul 9, 2025
|
|
||
| Decoders are a built-in feature available through the Parsers file. Each parser | ||
| definition can optionally set one or more decoders. There are two types of decoders: | ||
| Decoders are a built-in feature of parsers in Fluent Bit. Each parser definition can optionally set one or more decoders. There are two types of decoders: |
There was a problem hiding this comment.
You don't have to use this exact suggestion, but I'm trying to get us out of the habit of saying "here are the two types" or "select from these three options", because putting a number in there makes potential technical debt. What if they add another type? Then we need to not only add the info, but to update the intro section for that list. It's a small thing, but it adds up.
Suggested change
| Decoders are a built-in feature of parsers in Fluent Bit. Each parser definition can optionally set one or more decoders. There are two types of decoders: | |
| Decoders are a built-in feature of parsers in Fluent Bit. Each parser definition can optionally set one or more decoders. Select from one of these decoder types: |
cnorris-cs
reviewed
Jul 9, 2025
| - `Decode_Field`: If successful, can only be applied once for the same field. | ||
| `Decode`_Field` is intended to decode a structured message. | ||
| - `Decode_Field_As`: If successful, another decoder of the same type and the same field can be applied only if the data continues being an unstructured message (raw text). | ||
| - `Decode_Field`: If successful, can only be applied once for the same field. `Decode_Field` is intended to decode a structured message. |
There was a problem hiding this comment.
Suggested change
| - `Decode_Field`: If successful, can only be applied once for the same field. `Decode_Field` is intended to decode a structured message. | |
| - `Decode_Field`: If successful, can be applied only once for the same field. `Decode_Field` is intended to decode a structured message. |
cnorris-cs
approved these changes
Jul 9, 2025
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.
this PR is part of the effort to meet guidelines for style, clarity, and consistency.