Skip to content

docs: explain quoted Unicode metric names #2571

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

Open
arnabnandy7 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: explain quoted Unicode metric names #2571

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions docs/content/exporters/unicode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,19 @@ When `escaping=allow-utf-8` is passed, add valid UTF-8 characters to the metric
without replacing them. This allows you to use dots in metric and label names, as well as
other UTF-8 characters, without any replacements.

Names outside the legacy character set must use the quoted syntax in the Prometheus and
OpenMetrics 1.0 text formats. A quoted metric name is written inside braces, followed by its
labels. For example, a counter named `test_我喜欢茶` with a `test` label is exposed as:

```text
# TYPE "test_我喜欢茶" counter
{"test_我喜欢茶_total",test="test_我喜欢茶"} 1.0
```

The braces do not turn the metric name into a label. They are the required text-format notation
for a quoted metric name. See the [Prometheus exposition
format](https://prometheus.io/docs/instrumenting/exposition_formats/) for the complete syntax.

OpenMetrics 2.0 supports UTF-8 names natively, so when the OpenMetrics 2.0 writer serves a request
that explicitly asks for `version=2.0.0`, names are not escaped unless the request also contains an
`escaping` parameter.
Expand Down
Loading