Skip to content

Commit 49ec102

Browse files
andreasgerstmayrmax-cx
authored andcommitted
TRACING-4063: document cumulativetodeltaprocessor
Signed-off-by: Andreas Gerstmayr <[email protected]>
1 parent eae1e41 commit 49ec102

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

modules/otel-collector-components.adoc

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,40 @@ config: |
557557
<2> The default exporter when the attribute value is not present in the table in the next section.
558558
<3> The table that defines which values are to be routed to which exporters.
559559

560-
You can optionally create an `attribute_source` configuratiion, 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.
560+
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.
561+
562+
[id="cumulativetodelta-processor_{context}"]
563+
=== Cumulative to Delta Processor
564+
565+
This processor converts monotonic, cumulative-sum, and histogram metrics to monotonic delta metrics.
566+
567+
You can filter metrics by using the `include:` or `exclude:` fields and specifying the `strict` or `regexp` metric name matching.
568+
569+
This processor does not convert non-monotonic sums and exponential histograms.
570+
571+
:FeatureName: The Cumulative to Delta Processor
572+
include::snippets/technology-preview.adoc[]
573+
574+
.Example of an OpenTelemetry Collector custom resource with an enabled Cumulative to Delta Processor
575+
[source,yaml]
576+
----
577+
config: |
578+
processors:
579+
cumulativetodelta:
580+
include: # <1>
581+
match_type: strict # <2>
582+
metrics: # <3>
583+
- <metric_1_name>
584+
- <metric_2_name>
585+
exclude: # <4>
586+
match_type: regexp
587+
metrics:
588+
- "<regular_expression_for_metric_names>"
589+
----
590+
<1> Optional: Configures which metrics to include. When omitted, all metrics, except for those listed in the `exclude` field, are converted to delta metrics.
591+
<2> Defines a value provided in the `metrics` field as a `strict` exact match or `regexp` regular expression.
592+
<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.
593+
<4> Optional: Configures which metrics to exclude. When omitted, no metrics are excluded from conversion to delta metrics.
561594

562595
[id="exporters_{context}"]
563596
== Exporters

0 commit comments

Comments
 (0)