Skip to content

Commit

Permalink
Document a new metrics restriction (#1426)
Browse files Browse the repository at this point in the history
* Document a new metrics restriction

---------

Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
  • Loading branch information
olegbespalov and heitortsergent authored Nov 29, 2023
1 parent 5f2d4dc commit 70098ed
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/sources/next/using-k6/metrics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ To make a test fail a certain criteria, you can write a [Threshold](https://graf
To filter metrics, you can use [Tags and groups](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/tags-and-groups).
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).

| On this page... | Read about... |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| On this page... | Read about... |
| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| [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) |
| [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 |
| [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 |

## What metrics to look at?

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

{{% /admonition %}}
{{% /admonition %}}

## Example output

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

0 comments on commit 70098ed

Please sign in to comment.