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.

Sign up for GitHub

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

Jump to bottom

Clarify that attribute processor does not drop signals #5178

Merged
merged 2 commits into from
Sep 18, 2023
Merged

Clarify that attribute processor does not drop signals #5178

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ff6564
Clarify that attribute processor does not drop signals
ptodev Sep 13, 2023
87b25ea
Use admonition type="note"
ptodev Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/sources/flow/reference/components/otelcol.processor.attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ For example, adding a `span_names` filter could cause the component to error if

The `exclude` block provides an option to exclude data from being fed into the [action] blocks based on the properties of a span, log, or metric records.
Copy link
Member

Choose a reason for hiding this comment

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

Is this true?

Suggested change
The `exclude` block provides an option to exclude data from being fed into the [action] blocks based on the properties of a span, log, or metric records.
The `exclude` block provides an option to exclude data from being fed into the [action] blocks based on the properties of a span, log, or metric records. Excluded data will be forwarded as-is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is true, but I will add it to the new block that I'm adding now, since clarifying this is the whole purpose of the block. I'm also not sure if readers would know what is meant by "forwarded". I'll change this:

Signals excluded by the exclude block will still be propagated to downstream components.

To:

Signals excluded by the exclude block will still be propagated to downstream components as-is.


> **NOTE**: Signals excluded by the `exclude` block will still be propagated to downstream components.
> If you would like to not propagate certain signals to downstream components,
> consider a processor such as [otelcol.processor.tail_sampling](../otelcol.processor.tail_sampling/).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
> **NOTE**: Signals excluded by the `exclude` block will still be propagated to downstream components.
> If you would like to not propagate certain signals to downstream components,
> consider a processor such as [otelcol.processor.tail_sampling](../otelcol.processor.tail_sampling/).
{{% admonition type="note" %}}
Signals excluded by the `exclude` block are still be sent to downstream components.
To prevent specific signals from being sent to downstream components, you can use a processor
such as [otelcol.processor.tail_sampling](../otelcol.processor.tail_sampling/).
{{% /admonition %}}

Better to use the admonition shortcode for notes where we can.


{{< docs/shared lookup="flow/reference/components/match-properties-block.md" source="agent" version="<AGENT VERSION>" >}}

One of the following is also required:
Expand Down