Skip to content

Commit f81ef77

Browse files
committed
Add steps to resolve breaking changes to changelog
1 parent df1b78c commit f81ef77

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

.chloggen/signalfx_exporter_remove_translation_rules.yaml

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,43 @@ issues: [35332]
1616
# These lines will be padded with 2 spaces and then inserted directly into the document.
1717
# Use pipe (|) for multiline entries.
1818
subtext: |
19-
Please use the processors to handle desired metric transformations instead.
19+
Please use the processors to handle desired metric transformations instead. Find guidance and examples below for each transformation type.
20+
- rename_dimension_keys - Use the metricstransform processor's rename label functionality.
21+
- Example for one metric: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor#rename-labels
22+
- Example for multiple/all metrics: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor#rename-labels-for-multiple-metrics
23+
24+
- rename_metrics - Use the metrictransform processor's rename metric functionality instead.
25+
- Example for one metric: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor#rename-metric
26+
- Example for multiple metrics: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor#rename-multiple-metrics-using-substitution
27+
28+
- multiply_int. divide_int, multiply_float - Use the metrictransform processor's scale value functionality instead.
29+
- Example: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor#scale-value
30+
31+
- convert_values - Use the transform processor's Double or Int converter on a DataPoint context instead.
32+
- Double converter: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/pkg/ottl/ottlfuncs#double
33+
- Int converter: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/pkg/ottl/ottlfuncs#int
34+
35+
- copy_metrics - Use the metricstransform processor's insert functionality instead.
36+
- Example for copying all datapoints to a new metric: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor#create-a-new-metric-from-an-existing-metric
37+
- Example for conditionally copying datapoints: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor#create-a-new-metric-from-an-existing-metric-with-matching-label-values
38+
39+
- split_metric - Use the metricstransform processor's insert functionality to create the new metrics instead. Use the filter processor to drop the original metrics that are no longer required.
40+
- Refer to the replacement guidance for the `copy_metrics` and `drop_metrics` translation rules.
41+
42+
- aggregate_metric - Use the transform processor's `aggregate_on_attributes` function with the metric context instead.
43+
- Reference: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor#aggregate_on_attributes
44+
45+
- calculate_new_metric
46+
47+
- drop_metrics - Use the filter processor to drop metrics by name instead.
48+
- Example here for dropping metrics by name and value: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/filterprocessor#dropping-specific-metric-and-value
49+
50+
- delta_metric - Use the cumulativetodelta processor to create delta metrics from cumulative metrics instead.
51+
- Example here for specifying which metrics to create new delta metrics for: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/cumulativetodeltaprocessor#examples
52+
53+
- drop_dimensions - Use the transform processor's delete_keys function with the datapoint context to drop metric attributes instead.
54+
- Example and description here: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/pkg/ottl/ottlfuncs#delete_key
55+
- Dropping attributes conditionally, based upon the metric name or dimension value, can be done using a "where" clause with the given example.
2056
2157
# If your change doesn't affect end users or the exported elements of any package,
2258
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.

exporter/signalfxexporter/internal/translation/translator.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ const (
4646

4747
// ActionCopyMetrics copies metrics using Rule.Mapping.
4848
// Rule.DimensionKey and Rule.DimensionValues can be used to filter datapoints that must be copied,
49-
// if these fields are set, only metics having a dimension with key == Rule.DimensionKey and
49+
// if these fields are set, only metrics having a dimension with key == Rule.DimensionKey and
5050
// value in Rule.DimensionValues will be copied.
5151
ActionCopyMetrics Action = "copy_metrics"
5252

0 commit comments

Comments
 (0)