[exporter/signalfxexporter] Updated documentation in the SignalFX exp…

…orter for translation rules (open-telemetry#7875)
sakulali · Feb 21, 2022 · 522073a · 522073a
1 parent d2fefb3
commit 522073a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/exporter/signalfxexporter/README.md b/exporter/signalfxexporter/README.md
@@ -154,14 +154,14 @@ The rule language is expressed in yaml mappings and is [documented here](./inter
 
 * `aggregate_metric` - Aggregates a metric through removal of specified dimensions
 * `calculate_new_metric` - Creates a new metric via operating on two consistuent ones
-* `convert_values` - Convert float values to int for specified metric names
+* `convert_values` - Convert float values to int or int to float for specified metric names
 * `copy_metrics` - Creates a new metric as a copy of another
 * `delta_metric` - Creates a new delta metric for a specified non-delta one
 * `divide_int` - Scales a metric's integer value by a given factor
 * `drop_dimensions` - Drops dimensions for specified metrics, or globally
 * `drop_metrics` - Drops all metrics with a given name
-* `multiply_float` - Scales a metric's integer value by a given float factor
-* `multiply_int` - Scales a metric's integer value by a given int factor
+* `multiply_float` - Scales a metric's float value by a given float factor
+* `multiply_int` - Scales a metric's int value by a given int factor
 * `rename_dimension_keys` - Renames dimensions for specified metrics, or globally
 * `rename_metrics` - Replaces a given metric name with specified one
 * `split_metric` - Splits a given metric into multiple new ones for a specified dimension

diff --git a/exporter/signalfxexporter/internal/translation/translator.go b/exporter/signalfxexporter/internal/translation/translator.go
@@ -46,11 +46,12 @@ const (
  // Rule.ScaleFactorsInt key/values as metric_name/divisor
  ActionDivideInt Action = "divide_int"
 
- // ActionMultiplyFloat scales integer metric by dividing their values using
+ // ActionMultiplyFloat scales integer metric by multiplying their values using
  // Rule.ScaleFactorsFloat key/values as metric_name/multiplying_factor
+ // This rule can only be applied to metrics that are a float value
  ActionMultiplyFloat Action = "multiply_float"
 
- // ActionConvertValues converts float metrics values to integer values using
+ // ActionConvertValues converts metric values from int to float or float to int
  // Rule.TypesMapping key/values as metric_name/new_type.
  ActionConvertValues Action = "convert_values"