Skip to content

Update metric name restrictions #1331

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 1 commit into from
Oct 10, 2023
+2 −2
Merged

Update metric name restrictions #1331

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
4 changes: 2 additions & 2 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 @@ -109,9 +109,9 @@ For details of all metrics, refer to the [Metrics reference](/using-k6/metrics/r

## Metric name restrictions

Metric names must comply with OpenTelemetry and [Prometheus limitations](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).
Metric names must comply with OpenTelemetry and [Prometheus limitations](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). The character limit is the same limit k6 had before restricting the character set down.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove this sentence. If someone is new to k6 and reads this, it doesn't really give them any meaningful information and can just make this more confusing. If they are already familiar with k6, they might also not remember the limit.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is better if it stays - as it explains the reason for the specific limit.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's letting the reader know there were changes to the character limit, but it doesn't really give any details on why this has changed, unless we add more information. And I feel like that could quickly become irrelevant in the future...

Is this important for users if they're upgrading from previous versions to 0.47? If it is, we could also switch this to a <blockquote mod='attention'>.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

know there were changes to the character limit

There no loonger is a change.

We currently limit to 128, we started giving warning for characters outside of what Otel and Promehtesu support and found out that Otel has a limit of 63, so we added that to the new warning as well.

Now we foud out the 63 limit for Otel is lifted. So the warning got 128 character as the limti - which is also the current error limit.

So in practice the 128 character limit isn't new it is very old, we just didn't end up adding a new one 63 character limti


That means they must not start with a number and a metric name can be 1 to 63 symbols of:
That means they must not start with a number and a metric name can be 1 to 128 symbols of:
1. any Unicode Letters
2. any Unicode Number
3. `_` (an underscore)