Skip to content

Commit fb5056d

Browse files
authored
Merge pull request #75128 from max-cx/otel-cumulativetodeltaprocessor
OBSDOCS-938/TRACING-4063: Write documentation for cummulative to delta component
2 parents c8264b0 + 49ec102 commit fb5056d

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
@@ -720,7 +720,40 @@ config: |
720720
<2> The default exporter when the attribute value is not present in the table in the next section.
721721
<3> The table that defines which values are to be routed to which exporters.
722722

723-
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.
723+
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.
724+
725+
[id="cumulativetodelta-processor_{context}"]
726+
=== Cumulative to Delta Processor
727+
728+
This processor converts monotonic, cumulative-sum, and histogram metrics to monotonic delta metrics.
729+
730+
You can filter metrics by using the `include:` or `exclude:` fields and specifying the `strict` or `regexp` metric name matching.
731+
732+
This processor does not convert non-monotonic sums and exponential histograms.
733+
734+
:FeatureName: The Cumulative to Delta Processor
735+
include::snippets/technology-preview.adoc[]
736+
737+
.Example of an OpenTelemetry Collector custom resource with an enabled Cumulative to Delta Processor
738+
[source,yaml]
739+
----
740+
config: |
741+
processors:
742+
cumulativetodelta:
743+
include: # <1>
744+
match_type: strict # <2>
745+
metrics: # <3>
746+
- <metric_1_name>
747+
- <metric_2_name>
748+
exclude: # <4>
749+
match_type: regexp
750+
metrics:
751+
- "<regular_expression_for_metric_names>"
752+
----
753+
<1> Optional: Configures which metrics to include. When omitted, all metrics, except for those listed in the `exclude` field, are converted to delta metrics.
754+
<2> Defines a value provided in the `metrics` field as a `strict` exact match or `regexp` regular expression.
755+
<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.
756+
<4> Optional: Configures which metrics to exclude. When omitted, no metrics are excluded from conversion to delta metrics.
724757

725758
[id="exporters_{context}"]
726759
== Exporters

0 commit comments

Comments
 (0)