-
Notifications
You must be signed in to change notification settings - Fork 540
fix confusing/misleading info about parser support in YAML config #2133
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
base: master
Are you sure you want to change the base?
fix confusing/misleading info about parser support in YAML config #2133
Conversation
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a comment for the top level elements of YAML configuration.
administration/configuring-fluent-bit/yaml/configuration-file.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
one minor nit, but looks good to me
🎉 ship it
Co-authored-by: Lynette Miles <[email protected]> Signed-off-by: Alexa Kreizinger <[email protected]>
| | Name | Description | | ||
| | ---- | ----------- | | ||
| | `inputs` | Specifies the name of the plugin responsible for collecting or receiving data. This component serves as the data source in the pipeline. Examples of input plugins include `tail`, `http`, and `random`. | | ||
| | `processors` | **Unique to YAML configuration**, processors are specialized plugins that handle data processing directly attached to input plugins. Unlike filters, processors aren't dependent on tag or matching rules. Instead, they work closely with the input to modify or enrich the data before it reaches the filtering or output stages. Processors are defined within an input plugin section. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I follow the reasoning around removing this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's part of a larger change that I'm planning to make in the near future, but TLDR is that I think it's misleading to include processors on the same "level" as inputs/filters/outputs since processors are nested one level below them; this table layout makes them all appear to be on the same hierarchal level. when I revisit this page (and others) I'm hoping to make it clearer exactly how processors get attached to inputs and outputs, and that that they're not a direct parallel to filters.
Signed-off-by: Alexa Kreizinger <[email protected]>
administration/configuring-fluent-bit/yaml/configuration-file.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For technical perspective, it looks great to me. Thanks for your great modification. 👍
bear with me... this is going to be the first PR in a series of PRs trying to clarify some confusing stuff related to parsers, processors, and other YAML configuration-related topics. but I'm starting with this because it was the tiny thread that kept unraveling the more I pulled at it.
long story short, I thought it was odd that one of the configuration file pages stated that YAML configuration files don't support parsers. then I realized that it's because YAML configuration files don't have a dedicated parsers section—which is to say, that parsers are defined on a per-plugin basis.
so this PR attempts to perform the minimum viable amount of cleanup to clear up that confusion. that said, I'm going to need to revisit some of the docs in this section to cut through other things that are potentially misleading and to consolidate duplicated/scattered info.