Skip to content

Commit 70098ed

Browse files
Document a new metrics restriction (#1426)
* Document a new metrics restriction --------- Co-authored-by: Heitor Tashiro Sergent <[email protected]>
1 parent 5f2d4dc commit 70098ed

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

docs/sources/next/using-k6/metrics/_index.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ To make a test fail a certain criteria, you can write a [Threshold](https://graf
2121
To filter metrics, you can use [Tags and groups](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/tags-and-groups).
2222
You can also export metrics in various summary and granular formats, as documented in [Results output](https://grafana.com/docs/k6/<K6_VERSION>/results-output).
2323

24-
| On this page... | Read about... |
25-
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
24+
| On this page... | Read about... |
25+
| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
2626
| [Built-in metrics](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/metrics/reference) | Each built-in metric for each supported [protocol](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/protocols) |
27-
| [Create custom metrics](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/metrics/create-custom-metrics) | How to build your own metric for each metric type |
27+
| [Create custom metrics](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/metrics/create-custom-metrics) | How to build your own metric for each metric type |
2828

2929
## What metrics to look at?
3030

@@ -42,7 +42,7 @@ However, if you're unsure about the metrics to focus on, you can start with the
4242
In other terminology, these metrics measure traffic (in requests), availability (in error rate), and latency (in request duration).
4343
SREs might recognize these metrics as three of the [four Golden Signals](https://sre.google/sre-book/monitoring-distributed-systems/#xref_monitoring_golden-signals).
4444

45-
{{% /admonition %}}
45+
{{% /admonition %}}
4646

4747
## Example output
4848

@@ -111,8 +111,7 @@ For details of all metrics, refer to the [Metrics reference](https://grafana.com
111111
112112
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.
113113
114-
That means they must not start with a number and a metric name can be 1 to 128 symbols of:
114+
That means metrics names must:
115115
116-
1. any Unicode Letters
117-
2. any Unicode Number
118-
3. `_` (an underscore)
116+
- Include up to 128 symbols (ASCII letters, numbers, or underscores).
117+
- Start with a letter or an underscore.

0 commit comments

Comments
 (0)