open-telemetry
/
opentelemetry-collector
mirror of https://github.com/open-telemetry/opentelemetry-collector.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update processor README (#9284) 

- Update recommended processors
- Update ordering processors

For recommended processors, either the log signal could be added or
documentation could be made signal agnostic - opted for the latter.
This commit is contained in:
Steve Flanders 2024-01-14 16:57:01 -05:00 committed by GitHub
parent 55a8c6b651
commit 353a930c16
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
processor/README.md
View File

@ -21,26 +21,18 @@ The [contrib repository](https://github.com/open-telemetry/opentelemetry-collect
## Recommended Processors
By default, no processors are enabled. Depending on the data source, it may be recommended that multiple processors be enabled. Processors must be
enabled for every data source: Not all processors support all data sources.
By default, no processors are enabled. Depending on the data source, it may be
recommended that multiple processors be enabled. Processors must be enabled
for every data source and not all processors support all data sources.
In addition, it is important to note that the order of processors matters. The
order in each section below is the best practice. Refer to the individual
processor documentation for more information.
### Traces
1. [memory_limiter](memorylimiterprocessor/README.md)
2. *any sampling processors*
2. Any sampling or initial filtering processors
3. Any processor relying on sending source from `Context` (e.g. `k8sattributes`)
3. [batch](batchprocessor/README.md)
4. *any other processors*
### Metrics
1. [memory_limiter](memorylimiterprocessor/README.md)
2. Any processor relying on sending source from `Context` (e.g. `k8sattributes`)
3. [batch](batchprocessor/README.md)
4. *any other processors*
4. Any other processors
## Data Ownership
@ -114,4 +106,4 @@ data cloning described in Exclusive Ownership section.
## Ordering Processors
The order processors are specified in a pipeline is important as this is the
order in which each processor is applied to traces and metrics.
order in which each processor is applied.