Skip to content

utf8: update doc for deprecated bool #2698

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
Jul 24, 2025
Merged

utf8: update doc for deprecated bool #2698

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
908c112
utf8: update doc for deprecated bool
ywwg Jul 23, 2025
51150ce
typo
ywwg Jul 23, 2025
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
33 changes: 13 additions & 20 deletions docs/guides/utf8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,20 @@ This document guides you through the UTF-8 transition details.

## Go Instrumentation

Currently, metrics created by the official Prometheus [client_golang library](https://github.com/prometheus/client_golang) will reject UTF-8 names
by default. It is necessary to change the default validation scheme to allow
UTF-8. The requirement to set this value will be removed in a future version of
the common library.
Currently, metrics created by the official Prometheus [client_golang
library](https://github.com/prometheus/client_golang) accept UTF-8 names by
default.

```golang
import "github.com/prometheus/common/model"

func init() {
model.NameValidationScheme = model.UTF8Validation
}
```

If users want to enforce the legacy character set, they can set the validation
scheme to `LegacyValidation`.

Setting the validation scheme must be done before the instantiation of metrics
and can be set on the fly if desired.
Previously, documentation recommended that users override the value of
`model.NameValidationScheme` to select legacy validation by default. This
boolean is now deprecated and should always be set to UTF8Validation. Legacy
validation enforcement, if desired, should be done by individual implementations
calling the appropriate validation APIs and is no longer a library feature.

### Instrumenting in other languages

Other client libraries may have similar requirements to set the validation
scheme. Check the documentation for the library you are using.
Other client libraries may not yet support UTF-8 and may require special
handling or configuration. Check the documentation for the library you are using.

## Configuring Name Validation during Scraping

Expand Down Expand Up @@ -98,7 +89,9 @@ is no way to enforce the legacy character set validation with Remote Write 2.0.

## OTLP Metrics

OTLP receiver in Prometheus 3.0 still normalizes all names to Prometheus format by default. You can change this in `otlp` section of the Prometheus configuration as follows:
OTLP receiver in Prometheus 3.0 still normalizes all names to Prometheus format
by default. You can change this in `otlp` section of the Prometheus
configuration as follows:


otlp:
Expand Down