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

Clarified parser behavior in documentation #1392

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

gvozdetsky
Copy link

This change clarifies the sequential parser application process and provides a concrete example for better understanding.

@@ -88,7 +88,7 @@ pipeline:
{% endtab %}
{% endtabs %}

The two options separated by a comma means multi-format: try `docker` and `cri` multiline formats.
The two options separated by a comma mean Fluent Bit will try each parser in the list in order, applying the first one that matches the log (i.e. use the first parser which has a `start_state` that matches the log). For example, it will first try `docker`, and if `docker` does not match, it will then try `cri`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our style would have us wrap lines around 80 characters in length, and we avoid words like i.e.

Does this suggestion still technically describe the behavior of Fluent Bit here?

Mentioning @alexakreizinger for awareness.

Suggested change
The two options separated by a comma mean Fluent Bit will try each parser in the list in order, applying the first one that matches the log (i.e. use the first parser which has a `start_state` that matches the log). For example, it will first try `docker`, and if `docker` does not match, it will then try `cri`.
Having the the two options separated by a comma causes Fluent Bit to attempt each
parser in the list in order. Fluent But will apply the first parser that matches the
log (such as the first parser that has a `start_state` that matches the log). For
example, Fluent Bit will first try `docker`, and if `docker` doesn't match, it will
then try `cri`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically this is accurate and a good addition - it confuses people that this is a mutually exclusive list of options (XOR) with first parser to match "winning" and no further parsers used.

@gvozdetsky
Copy link
Author

Can anyone review this?

@patrick-stephens
Copy link
Contributor

Can anyone review this?

Did you update from the previous review?

@gvozdetsky
Copy link
Author

Can anyone review this?

Did you update from the previous review?

Sorry, I thought that I have already commited this :)

@patrick-stephens
Copy link
Contributor

Please resolve the DCO failure as well - that's required in order to merge.

gvozdetsky and others added 2 commits July 2, 2024 11:26
This change clarifies the sequential parser application process and provides a concrete example for better understanding.

Signed-off-by: gvozdetsky <[email protected]>
Signed-off-by: Eugene Gvozdetsky <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants