forked from mirrors/statsd_exporter
Use _total suffix for counters
According to the project's naming best practices[0], the suffix to indicate a counter type is called `_total`. [0]: https://prometheus.io/docs/practices/naming/
This commit is contained in:
parent
3fd85c92fc
commit
c11d1e9cf2
1 changed files with 7 additions and 6 deletions
13
README.md
13
README.md
|
@ -130,7 +130,7 @@ wildcard match in the matching line. That allows for dynamic rewrites, such as:
|
||||||
```yaml
|
```yaml
|
||||||
mappings:
|
mappings:
|
||||||
- match: test.*.*.counter
|
- match: test.*.*.counter
|
||||||
name: "${2}_counter"
|
name: "${2}_total"
|
||||||
labels:
|
labels:
|
||||||
provider: "$1"
|
provider: "$1"
|
||||||
```
|
```
|
||||||
|
@ -142,7 +142,7 @@ could be written as:
|
||||||
mappings:
|
mappings:
|
||||||
- match: test\.(\w+)\.(\w+)\.counter
|
- match: test\.(\w+)\.(\w+)\.counter
|
||||||
match_type: regex
|
match_type: regex
|
||||||
name: "${2}_counter"
|
name: "${2}_total"
|
||||||
labels:
|
labels:
|
||||||
provider: "$1"
|
provider: "$1"
|
||||||
```
|
```
|
||||||
|
@ -152,6 +152,7 @@ label names.
|
||||||
|
|
||||||
If the default metric help text is insufficient for your needs you may use the YAML
|
If the default metric help text is insufficient for your needs you may use the YAML
|
||||||
configuration to specify a custom help text for each mapping:
|
configuration to specify a custom help text for each mapping:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
mappings:
|
mappings:
|
||||||
- match: http.request.*
|
- match: http.request.*
|
||||||
|
@ -161,7 +162,7 @@ mappings:
|
||||||
code: "$1"
|
code: "$1"
|
||||||
```
|
```
|
||||||
|
|
||||||
In the configuration, one may also set the timer type to "histogram". The
|
In the configuration, one may also set the timer type to "histogram". The
|
||||||
default is "summary" as in the plain text configuration format. For example,
|
default is "summary" as in the plain text configuration format. For example,
|
||||||
to set the timer type for a single metric:
|
to set the timer type for a single metric:
|
||||||
|
|
||||||
|
@ -215,7 +216,7 @@ mappings:
|
||||||
# This will be a histogram using the buckets set in `defaults`.
|
# This will be a histogram using the buckets set in `defaults`.
|
||||||
- match: test.timing.*.*.*
|
- match: test.timing.*.*.*
|
||||||
name: "my_timer"
|
name: "my_timer"
|
||||||
labels:
|
labels:
|
||||||
provider: "$2"
|
provider: "$2"
|
||||||
outcome: "$3"
|
outcome: "$3"
|
||||||
job: "${1}_server"
|
job: "${1}_server"
|
||||||
|
@ -223,7 +224,7 @@ mappings:
|
||||||
- match: other.timing.*.*.*
|
- match: other.timing.*.*.*
|
||||||
timer_type: summary
|
timer_type: summary
|
||||||
name: "other_timer"
|
name: "other_timer"
|
||||||
labels:
|
labels:
|
||||||
provider: "$2"
|
provider: "$2"
|
||||||
outcome: "$3"
|
outcome: "$3"
|
||||||
job: "${1}_server_other"
|
job: "${1}_server_other"
|
||||||
|
@ -236,7 +237,7 @@ mappings:
|
||||||
# This metric would match as normal.
|
# This metric would match as normal.
|
||||||
- match: test.timing.*.*.*
|
- match: test.timing.*.*.*
|
||||||
name: "my_timer"
|
name: "my_timer"
|
||||||
labels:
|
labels:
|
||||||
provider: "$2"
|
provider: "$2"
|
||||||
outcome: "$3"
|
outcome: "$3"
|
||||||
job: "${1}_server"
|
job: "${1}_server"
|
||||||
|
|
Loading…
Reference in a new issue