While we intend to keep experimental modules as stable as possible, we may need to introduce breaking changes. This could happen at future k6 releases until the module becomes fully stable and graduates as a k6 core module. For more information, refer to the extension graduation process.
Experimental modules maintain a high level of stability and follow regular maintenance and security measures. Feel free to open an issue if you have any feedback or suggestions.
For instance, when using the experimental-prometheus-rw output, k6 can send test-result metrics to the remote-write endpoint and store them in Prometheus.
The output, during the k6 run execution, gets all the generated time-series data points for the k6 metrics. It then generates the equivalent Prometheus time series and sends them to the Prometheus remote write endpoint.
All k6 metric types are converted into an equivalent Prometheus metric type. The output maps the metrics into time series with Name labels. As much as possible, k6 respects the naming best practices that the Prometheus project defines:
- All time series are prefixed with the k6_ namespace.
- All time series are suffixed with the base unit of the sample value (if k6 knows what the base unit is).
- Trends and rates have the relative suffixes, to make them more discoverable.
|Counter and Gauges (default) or Native Histogram
This output provides two distinct mechanisms to send k6 Trend metrics to Prometheus:
Both options provide efficient storage of test results while providing high-precision queries.
Note that k6 aggregates trend metric data before sending it to Prometheus in both options. The reasons for aggregating data are:
- Prometheus stores data in a millisecond precision (ms), but k6 metrics collect data points with higher accuracy, nanosecond (ns).
- A load test could generate vast amounts of data points. High-precision raw data could quickly become expensive and complex to scale and is unnecessary when analyzing performance trends.
By default, Prometheus supports Counter and Gauge Metric types. Therefore, this option is the default of this output and converts all the k6 Trend metrics to Counter and Gauges Prometheus metrics.
You can configure how to convert all the k6 trend metrics with the K6_PROMETHEUS_RW_TREND_STATS option that accepts a comma-separated list of stats functions: count, sum, min, max, avg, med, p(x). The default is p(99).
Given the list of stats functions, k6 converts all trend metrics to the respective math functions as Prometheus metrics.
For example, K6_PROMETHEUS_RW_TREND_STATS=p(90),p(95),max transforms each trend metric into three Prometheus metrics as follows:
This option provides a configurable solution to represent Trend metrics in Prometheus but has the following drawbacks:
- Convert a k6 Trend metric to several Prometheus metrics.
- It is impossible to aggregate some gauge values (especially percentiles).
- It uses a memory-expensive k6 data structure.
To address the limitations of the previous option, you can convert k6 trend metrics to high-fidelity histograms enabling Prometheus native histograms.
With this option, each k6 trend metric maps to its corresponding Prometheus histogram metric: k6_*. You can then query them using Prometheus histogram functions, such as histogram_quantile().
🌟 To learn the benefits and outcomes of using Histograms, watch High-resolution Histograms in Prometheus.
⚠️ Note that Native Histogram is an experimental feature released in Prometheus v2.40.0, and other remote write implementations might not support it yet. In the future, when Prometheus makes this feature stable, k6 will consider using it as the default conversion method for Trend metrics.
To send k6 metrics to a remote write endpoint without native histograms:
Set up a running remote write endpoint and ensure k6 can reach it.
Run your k6 script with the --out flag and the URL of the RW endpoint as follows:Trend statsHTTP Basic Authentication
Optionally, pass the K6_PROMETHEUS_RW_TREND_STATS to gain the ability to query additional stats for trend metrics. The default is p(99).Multiple Trend Stats Metrics
To send k6 metrics to a remote write endpoint with native histograms:
Enable the feature flag --enable-feature=native-histograms in Prometheus 2.40.0 or higher. Set up a running remote write endpoint and ensure k6 can reach it.
Run your k6 script with the --out flag, enabling the K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM option, and the URL of the RW endpoint as follows:Native HistogramHTTP Basic Authentication
When running the previous k6 run commands, k6 starts sending time-series metrics to Prometheus. All the time series have a k6_ prefix. In the Prometheus Web UI, they appear like this:
k6 has special options for remote write output.
|URL of the Prometheus remote write implementation's endpoint. Default is http://localhost:9090/api/v1/write
|Additional header to include in the HTTP requests. It can be set using the described format, for example K6_PROMETHEUS_RW_HEADERS_CUSTOM-HEADER-KEY=custom-header-value.
|A comma-separated list of key-values
|Additional headers to include in the HTTP requests. K6_PROMETHEUS_RW_HTTP_HEADERS=key1:value1,key2:value2.
|Interval between the metrics' aggregation and upload to the endpoint. Default is 5s.
|If true, maps all the defined trend metrics as Native Histograms. Default is false.
|list of string
|If Native Histogram is not enabled, then it defines the stats functions to map for all of the defined trend metrics. It's a comma-separated list of stats functions to include (e.g. p(90),avg,sum). Check the trend section to see the list of supported stats. Default is p(99).
|If true, the HTTP client skips TLS verification on the endpoint. Default is false.
|If true, the output at the end of the test marks all the seen time series as stale. Default is false.
|Username for the HTTP Basic authentication at the Prometheus remote write endpoint.
|Password for the HTTP Basic authentication at the Prometheus remote write endpoint.
|A path to the PEM (Privacy-Enhanced Mail) formatted client certificate.
|A path to the PEM formatted client private key.
|Sets the Authorization Bearer Token Header.
This k6 output can mark the time series at the end of the test as stale. To enable the stale marker option, set the K6_PROMETHEUS_RW_STALE_MARKERS environment variable to true.
By default, the metrics are active for 5 minutes after the last flushed sample. They are automatically marked as stale after. For details about staleness, refer to the Prometheus docs.
To visualize time series with Grafana, you can use the Explore UI or import any of the existing pre-built dashboards:
- k6 Prometheus dashboard by Grafana k6
- k6 Prometheus (Native Histograms) dashboard by Grafana k6
- Other public dashboards available from the community
If you are a Grafana Cloud user, please refer to the Grafana Cloud Prometheus docs.
For a local environment, the xk6-output-prometheus-remote repository includes a docker-compose setup that provisions the k6 Prometheus and k6 Prometheus (Native Histograms) dashboards:
Clone the repository to get started and follow these steps for using the docker-compose.yml file that starts Prometheus and Grafana:
Start the docker compose environment.
Prometheus is started with Native Histogram enabled. You can use the same Prometheus instance to receive k6 trend metrics as native histograms or multiple metric stats.
Run the k6 test with one of the options detailed on Send test metrics to a remote write endpoint.Trend statsNative Histograms
Optionally, you can set the testid tag as a wide test tag to segment metrics into discrete test runs and filter specific test results on the pre-built Grafana dashboards or in PromQL queries. testid can be any unique string that let you clearly identify the test run.Trend statsNative Histograms
After running the test, visit http://localhost:3000. If you enabled native histograms, select the k6 Prometheus (Native Histograms) dashboard; otherwise, select the k6 Prometheus Dashboard.