diff --git a/processor/metricstransformprocessor/README.md b/processor/metricstransformprocessor/README.md index 1dd2c162b407..515a661453e3 100644 --- a/processor/metricstransformprocessor/README.md +++ b/processor/metricstransformprocessor/README.md @@ -50,59 +50,61 @@ later transformations or operations may reference the result of previous transformations or operations. ```yaml -# transforms is a list of transformations with each element transforming a metric selected by metric name -transforms: - - # SPECIFY WHICH METRIC(S) TO MATCH - - # include specifies the metric name used to determine which metric(s) to operate on - - include: - # match_type specifies whether the include name should be used as a strict match or regexp match, default = strict - match_type: {strict, regexp} - - # experimental_match_labels specifies the label set against which the metric filter will work. If experimental_match_labels is specified, transforms will only be applied to those metrics which - # have the provided metric label values. This works for both strict and regexp match_type. This is an experimental feature. - experimental_match_labels: {: , : } - - # SPECIFY THE ACTION TO TAKE ON THE MATCHED METRIC(S) - - # action specifies if the operations (specified below) are performed on metrics in place (update), on an inserted clone (insert), or on a new combined metric (combine) - action: {update, insert, combine} +processors: + metricstransform: + # transforms is a list of transformations with each element transforming a metric selected by metric name + transforms: - # SPECIFY HOW TO TRANSFORM THE METRIC GENERATED AS A RESULT OF APPLYING THE ABOVE ACTION + # SPECIFY WHICH METRIC(S) TO MATCH + + # include specifies the metric name used to determine which metric(s) to operate on + - include: + # match_type specifies whether the include name should be used as a strict match or regexp match, default = strict + match_type: {strict, regexp} - # new_name specifies the updated name of the metric; if action is insert or combine, new_name is required - new_name: - # aggregation_type defines how combined data points will be aggregated; if action is combine, aggregation_type is required - aggregation_type: {sum, mean, min, max} - # submatch_case specifies the case that should be used when adding label values based on regexp submatches when performing a combine action; leave blank to use the submatch value as is - submatch_case: {lower, upper} - # operations contain a list of operations that will be performed on the resulting metric(s) - operations: - # action defines the type of operation that will be performed, see examples below for more details - - action: {add_label, update_label, delete_label_value, toggle_scalar_data_type, experimental_scale_value, aggregate_labels, aggregate_label_values} - # label specifies the label to operate on - label: