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

[docs] add status headers to attribute/filter/span processors #11120

Merged
merged 2 commits into from
Jun 17, 2022
Merged

[docs] add status headers to attribute/filter/span processors #11120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cde897e
[docs] add status headers to attribute/filter/span processors
Jun 17, 2022
cae073b
fix link
Jun 17, 2022
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
10 changes: 9 additions & 1 deletion processor/attributesprocessor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Attributes Processor

Supported pipeline types: traces, logs, metrics.
| Status | |
| ------------------------ | --------------------- |
| Stability | [alpha] |
| Supported pipeline types | traces, metrics, logs |
| Distributions | [core], [contrib] |

The attributes processor modifies attributes of a span, log, or metric. Please refer to
[config.go](./config.go) for the config spec.
Expand Down Expand Up @@ -256,3 +260,7 @@ regexp:
# cachemaxnumentries is the max number of entries of the LRU cache; ignored if cacheenabled is false.
cachemaxnumentries: <int>
```

[alpha]:https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[core]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
10 changes: 9 additions & 1 deletion processor/filterprocessor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Filter Processor

Supported pipeline types: logs, metrics
| Status | |
| ------------------------ | ----------------- |
| Stability | [alpha] |
| Supported pipeline types | metrics, logs |
| Distributions | [core], [contrib] |

The filter processor can be configured to include or exclude:

Expand Down Expand Up @@ -204,3 +208,7 @@ processors:
```

In case the no metric names are provided, `matric_names` being empty, the filtering is only done at resource level.

[alpha]:https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[core]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
12 changes: 10 additions & 2 deletions processor/spanprocessor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Span Processor

Supported pipeline types: traces
| Status | |
| ------------------------ | ----------------- |
| Stability | [alpha] |
| Supported pipeline types | traces |
| Distributions | [core], [contrib] |

The span processor modifies the span name based on its attributes or extract span attributes from the span name. It also allows
to change span status. Please refer to [config.go](./config.go) for the config spec.

It optionally supports the ability to [include/exclude spans](../README.md#includeexclude-spans).
It optionally supports the ability to [include/exclude spans](../attributesprocessor/README.md#includeexclude-filtering).

The following actions are supported:

Expand Down Expand Up @@ -122,3 +126,7 @@ span/set_status:

Refer to [config.yaml](./testdata/config.yaml) for detailed
examples on using the processor.

[alpha]:https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[core]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol