Skip to content

Commit

Permalink
[exporter/signalfx] document list of default excluded metrics (open-t…
Browse files Browse the repository at this point in the history
…elemetry#5181)

We exclude several metrics by default with our exporter - it is good practice to list them out in the readme.
  • Loading branch information
Mark Stumpf committed Sep 22, 2021
1 parent 372e040 commit b225da0
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion exporter/signalfxexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The following configuration options can also be configured:
excluded from sending to Signalfx backend. If `translation_rules` options
are enabled, the exclusion will be applied on translated metrics.
See [here](./testdata/config.yaml) for examples. Apart from the values explicitly
provided via this option, by default, [these](./translation/default_metrics.go) are
provided via this option, by default, [these](./internal/translation/default_metrics.go) are
also appended to this list. Setting this option to `[]` will override all the default
excludes.
- `include_metrics`: List of filters to override exclusion of any metrics.
Expand Down Expand Up @@ -114,6 +114,21 @@ One of `realm` and `api_url` are required.
- `cleanup_interval` (default = 1 minute): How frequently to purge duplicate requests.
- `sync_attributes` (default = `{"k8s.pod.uid": "k8s.pod.uid", "container.id": "container.id"}`) Map containing key of the attribute to read from spans to sync to dimensions specified as the value.

## Default Metric Filters
[List of metrics excluded by default](./internal/translation/default_metrics.go)

Some OpenTelemetry receivers may send metrics that SignalFx considers to be categorized as custom metrics. In order to prevent unwanted overage usage due to custom metrics from these receivers, the SignalFx exporter has a [set of metrics excluded by default](./internal/translation/default_metrics.go). Some exclusion rules use regex to exclude multiple metric names. Some metrics are only excluded if specific resource labels (dimensions) are present. If `translation_rules` are configured and new metrics match a default exclusion, the new metric will still be excluded. Users may configure the SignalFx exporter's `include_metrics` config option to override the any of the default exclusions, as `include_metrics` will always take precedence over any exclusions. An example of `include_metrics` is shown below.

```
exporters:
signalfx:
include_metrics:
- metric_names: [cpu.interrupt, cpu.user, cpu.system]
- metric_name: system.cpu.time
dimensions:
state: [interrupt, user, system]
```

## Translation Rules and Metric Transformations

The `translation_rules` metrics configuration field accepts a list of metric-transforming actions to
Expand Down

0 comments on commit b225da0

Please sign in to comment.