Skip to content

Conversation

@alexakreizinger
Copy link
Member

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.

Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
@alexakreizinger alexakreizinger requested review from a team as code owners November 4, 2025 03:29
Copy link
Contributor

@cosmo0920 cosmo0920 left a 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.

@eschabell eschabell added waiting-for-user Waiting for user/contributors feedback or requested changes waiting-on-review Waiting on a review from mainteners labels Nov 4, 2025
Copy link
Contributor

@esmerel esmerel left a 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

| 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. |
Copy link
Contributor

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.

Copy link
Member Author

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]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Copy link
Contributor

@cosmo0920 cosmo0920 left a 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. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting-for-user Waiting for user/contributors feedback or requested changes waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants