Skip to content

Document metric name restrictions #1205

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

Merged
merged 2 commits into from
Jun 19, 2023
Merged

Document metric name restrictions #1205

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da8d340
Document metric name restrictions
mstoykov Jun 8, 2023
833a159
Apply suggestions from code review
mstoykov Jun 12, 2023
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
15 changes: 15 additions & 0 deletions src/data/markdown/translated-guides/en/02 Using k6/02 Metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,18 @@ default ✓ [======================================] 1 VUs 00m03.8s/10m0s 1/1
In that output, all the metrics that start with `http`, `iteration`, and `vu` are _built-in_ metrics, which get written to stdout at the end of a test.
For details of all metrics, refer to the [Metrics reference](/using-k6/metrics/reference/).


### Metric name restrictions

<Blockquote mod="warning" title="">

In the future, metrics names will be further limited to comply with OpenTelemetry and Prometheus limitations.

That means metric names can be 1 to 63 symbols of ASCII letters, numbers, or `_`. Metric names must not start with a number.

</Blockquote>

At the moment, a metric name can be 1 to 128 symbols of:
1. any Unicode Letters
2. any Unicode Number
3. `.`, `_`, ` `, `!`, `?`. `/`, `#`, `(`. `)`, `<`, `>`, `%` and `-`