Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix extra metrics description example #12043

Merged
merged 3 commits into from
May 18, 2022
Merged

Fix extra metrics description example #12043

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8eefe16
update extra_metrics docs
sarah-witt May 17, 2022
6f8103e
Only do for extra metrics
sarah-witt May 17, 2022
c16c7b9
Sync config
sarah-witt May 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
update extra_metrics docs
  • Loading branch information
@sarah-witt
sarah-witt committed May 17, 2022
commit 8eefe163ac8b7ceb602442b22ec92139bee1eb35
16 changes: 8 additions & 8 deletions ..._checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@
1. If the item is a string, then it represents the exposed metric name, and
the sent metric name will be identical. For example:

metrics:
extra_metrics:
- <METRIC_1>
- <METRIC_2>
2. If the item is a mapping, then the keys represent the exposed metric names.

a. If a value is a string, then it represents the sent metric name. For example:

metrics:
extra_metrics:
- <EXPOSED_METRIC_1>: <SENT_METRIC_1>
- <EXPOSED_METRIC_2>: <SENT_METRIC_2>
b. If a value is a mapping, then it must have a `name` and/or `type` key.
The `name` represents the sent metric name, and the `type` represents how
the metric should be handled, overriding any type information the endpoint
may provide. For example:

metrics:
extra_metrics:
- <EXPOSED_METRIC_1>:
name: <SENT_METRIC_1>
type: <METRIC_TYPE_1>
Expand All @@ -61,7 +61,7 @@

Regular expressions may be used to match the exposed metric names, for example:

metrics:
extra_metrics:
- ^network_(ingress|egress)_.+
- .+:
type: gauge
Expand Down Expand Up @@ -90,22 +90,22 @@
1. If the item is a string, then it represents the exposed metric name, and
the sent metric name will be identical. For example:

metrics:
extra_metrics:
- <METRIC_1>
- <METRIC_2>
2. If the item is a mapping, then the keys represent the exposed metric names.

a. If a value is a string, then it represents the sent metric name. For example:

metrics:
extra_metrics:
- <EXPOSED_METRIC_1>: <SENT_METRIC_1>
- <EXPOSED_METRIC_2>: <SENT_METRIC_2>
b. If a value is a mapping, then it must have a `name` and/or `type` key.
The `name` represents the sent metric name, and the `type` represents how
the metric should be handled, overriding any type information the endpoint
may provide. For example:

metrics:
extra_metrics:
- <EXPOSED_METRIC_1>:
name: <SENT_METRIC_1>
type: <METRIC_TYPE_1>
Expand All @@ -123,7 +123,7 @@

Regular expressions may be used to match the exposed metric names, for example:

metrics:
extra_metrics:
- ^network_(ingress|egress)_.+
- .+:
type: gauge
Expand Down
8 changes: 4 additions & 4 deletions openmetrics/datadog_checks/openmetrics/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,22 +69,22 @@ instances:
## 1. If the item is a string, then it represents the exposed metric name, and
## the sent metric name will be identical. For example:
##
## metrics:
## extra_metrics:
## - <METRIC_1>
## - <METRIC_2>
## 2. If the item is a mapping, then the keys represent the exposed metric names.
##
## a. If a value is a string, then it represents the sent metric name. For example:
##
## metrics:
## extra_metrics:
## - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
## - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
## b. If a value is a mapping, then it must have a `name` and/or `type` key.
## The `name` represents the sent metric name, and the `type` represents how
## the metric should be handled, overriding any type information the endpoint
## may provide. For example:
##
## metrics:
## extra_metrics:
## - <EXPOSED_METRIC_1>:
## name: <SENT_METRIC_1>
## type: <METRIC_TYPE_1>
Expand All @@ -102,7 +102,7 @@ instances:
##
## Regular expressions may be used to match the exposed metric names, for example:
##
## metrics:
## extra_metrics:
## - ^network_(ingress|egress)_.+
## - .+:
## type: gauge
Expand Down