Skip to content

Commit 25222db

Browse files
rubenvp8510max-cx
authored andcommitted
OBSDOCS-1146: Documentation for the group-by-attribute processor
Signed-off-by: Ruben Vargas <[email protected]>
1 parent 07b4f7a commit 25222db

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

observability/otel/otel-collector/otel-collector-processors.adoc

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -397,18 +397,18 @@ config: |
397397
You can optionally create an `attribute_source` configuration, which defines where to look for the attribute in `from_attribute`. The allowed value is `context` to search the context, which includes the HTTP headers, or `resource` to search the resource attributes.
398398

399399
[id="cumulativetodelta-processor_{context}"]
400-
== Cumulative to Delta Processor
400+
== Cumulative-to-Delta Processor
401401

402-
This processor converts monotonic, cumulative-sum, and histogram metrics to monotonic delta metrics.
402+
The Cumulative-to-Delta Processor processor converts monotonic, cumulative-sum, and histogram metrics to monotonic delta metrics.
403403

404404
You can filter metrics by using the `include:` or `exclude:` fields and specifying the `strict` or `regexp` metric name matching.
405405

406406
This processor does not convert non-monotonic sums and exponential histograms.
407407

408-
:FeatureName: The Cumulative to Delta Processor
408+
:FeatureName: The Cumulative-to-Delta Processor
409409
include::snippets/technology-preview.adoc[]
410410

411-
.Example of an OpenTelemetry Collector custom resource with an enabled Cumulative to Delta Processor
411+
.Example of an OpenTelemetry Collector custom resource with an enabled Cumulative-to-Delta Processor
412412
[source,yaml]
413413
----
414414
# ...
@@ -430,3 +430,26 @@ config: |
430430
<2> Defines a value provided in the `metrics` field as a `strict` exact match or `regexp` regular expression.
431431
<3> Lists the metric names, which are exact matches or matches for regular expressions, of the metrics to be converted to delta metrics. If a metric matches both the `include` and `exclude` filters, the `exclude` filter takes precedence.
432432
<4> Optional: Configures which metrics to exclude. When omitted, no metrics are excluded from conversion to delta metrics.
433+
434+
[id="groupbyattrsprocessor-processor_{context}"]
435+
== Group-by-Attributes Processor
436+
437+
The Group-by-Attributes Processor groups all spans, log records, and metric datapoints that share the same attributes by reassigning them to a Resource that matches those attributes.
438+
439+
:FeatureName: The Group-by-Attributes Processor
440+
include::snippets/technology-preview.adoc[]
441+
442+
At minimum, configuring this processor involves specifying an array of attribute keys to be used to group spans, log records, or metric datapoints together, as in the following example:
443+
444+
[source,yaml]
445+
----
446+
# ...
447+
processors:
448+
groupbyattrs:
449+
keys: # <1>
450+
- <key1> # <2>
451+
- <key2>
452+
# ...
453+
----
454+
<1> Specifies attribute keys to group by.
455+
<2> If a processed span, log record, or metric datapoint contains at least one of the specified attribute keys, it is reassigned to a Resource that shares the same attribute values; and if no such Resource exists, a new one is created. If none of the specified attribute keys is present in the processed span, log record, or metric datapoint, then it remains associated with its current Resource. Multiple instances of the same Resource are consolidated.

0 commit comments

Comments
 (0)