Skip to content

Commit e314193

Browse files
authored
Merge pull request #94218 from max-cx/OBSDOCS-1775
OBSDOCS-1775: Cumulative-to-Delta Processor as a sidecar
2 parents 4635a51 + 859f3fe commit e314193

File tree

1 file changed

+23
-19
lines changed

1 file changed

+23
-19
lines changed

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

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -408,10 +408,12 @@ Optionally, you can create an `attribute_source` configuration, which defines wh
408408
[id="cumulativetodelta-processor_{context}"]
409409
== Cumulative-to-Delta Processor
410410

411-
The Cumulative-to-Delta Processor processor converts monotonic, cumulative-sum, and histogram metrics to monotonic delta metrics.
411+
The Cumulative-to-Delta Processor converts monotonic, cumulative-sum, and histogram metrics to monotonic delta metrics.
412412

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

415+
Because this processor calculates delta by storing the previous value of a metric, you must set up the metric source to send the metric data to a single stateful Collector instance rather than a deployment of multiple Collectors.
416+
415417
This processor does not convert non-monotonic sums and exponential histograms.
416418

417419
:FeatureName: The Cumulative-to-Delta Processor
@@ -421,24 +423,26 @@ include::snippets/technology-preview.adoc[]
421423
[source,yaml]
422424
----
423425
# ...
424-
config:
425-
processors:
426-
cumulativetodelta:
427-
include: # <1>
428-
match_type: strict # <2>
429-
metrics: # <3>
430-
- <metric_1_name>
431-
- <metric_2_name>
432-
exclude: # <4>
433-
match_type: regexp
434-
metrics:
435-
- "<regular_expression_for_metric_names>"
436-
# ...
437-
----
438-
<1> Optional: Configures which metrics to include. When omitted, all metrics, except for those listed in the `exclude` field, are converted to delta metrics.
439-
<2> Defines a value provided in the `metrics` field as a `strict` exact match or `regexp` regular expression.
440-
<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.
441-
<4> Optional: Configures which metrics to exclude. When omitted, no metrics are excluded from conversion to delta metrics.
426+
mode: sidecar # <1>
427+
config:
428+
processors:
429+
cumulativetodelta:
430+
include: # <2>
431+
match_type: strict # <3>
432+
metrics: # <4>
433+
- <metric_1_name>
434+
- <metric_2_name>
435+
exclude: # <5>
436+
match_type: regexp
437+
metrics:
438+
- "<regular_expression_for_metric_names>"
439+
# ...
440+
----
441+
<1> To tie the Collector's lifecycle to the metric source, you can run the Collector as a sidecar to the application that emits the cumulative temporality metrics.
442+
<2> Optional: You can limit which metrics the processor converts by explicitly defining which metrics you want converted in this stanza. If you omit this field, the processor converts all metrics, except the metrics that are listed in the `exclude` field.
443+
<3> Defines the value that you provided in the `metrics` field as an exact match by using the `strict` parameter or a regular expression by using the `regex` parameter.
444+
<4> Lists the names of the metrics that you want to convert. The processor converts exact matches or matches for regular expressions. If a metric matches both the `include` and `exclude` filters, the `exclude` filter takes precedence.
445+
<5> Optional: You can exclude certain metrics from conversion by explicitly defining them here.
442446

443447
[id="groupbyattrsprocessor-processor_{context}"]
444448
== Group-by-Attributes Processor

0 commit comments

Comments
 (0)