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.

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
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Only do for extra metrics
  • Loading branch information
sarah-witt committed May 17, 2022
commit 6f8103ec5a3358f8c03535a2b042720b3f14b232
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:

extra_metrics:
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:

extra_metrics:
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:

extra_metrics:
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:

extra_metrics:
metrics:
- ^network_(ingress|egress)_.+
- .+:
type: gauge
Expand Down