With this integration, you can export test result metrics from the k6 Cloud to a Prometheus instance hosted by Grafana Cloud, allowing you to use Grafana to query, visualize, and correlate k6 metrics with all your other metrics.
⭐️ Cloud APM integrations are available on Pro and Enterprise plans, as well as the annual Team plan and Trial.
If you do not have a Grafana Cloud account, you can sign up here. The free plan includes 10,000 Prometheus series.
To set up the integration on the k6 Cloud, you need the following data from your Grafana Cloud Prometheus instance:
Log in to Grafana.com and visit the Cloud Portal. Click on the Details button of your Prometheus service.
Copy the URL of the Remote Write Endpoint and the Username / Instance ID.
For the password, create and copy an API key of MetricsPublisher role.
Now, you can set the URL, username, and password on the k6 Cloud to authorize exporting k6 Cloud metrics to your Prometheus instance.
You have to set up the Grafana Cloud settings for each test that you want to export its test result metrics when running the test.
Currently, there are two options to set up the Cloud APM settings in the test:
you have to configure the Grafana Cloud integration for an organization. Click the Cloud APM option on the left sidebar menu under the Manage section, and select Grafana Cloud from the list.
In this form, set the URL, username, and password that you copied previously. For more information on the other input fields, see configuration parameters.
Save the Grafana Cloud configuration for the current organization.
Note that configuring the Grafana Cloud settings for an organization does not enable the integration. You have to enable it manually for each test using the test builder.
Now, create a new test with the test builder or select a test - previously created with the test builder. Click the Cloud APM option on the test builder sidebar to enable the integration for the test.
If you script your k6 tests, you can also configure the Cloud APM settings using the apm option in the k6 script.
The parameters to export the k6 metrics to a Grafana Cloud Prometheus instance are as follows:
|provider(required)||For this integration, the value must be prometheus.|
|remoteWriteURL(required)||URL of the Prometheus remote write endpoint. |
For example: https://prometheus-us-central1.grafana.net/api/prom/push.
|credentials(required)||The credentials to authenticate with the Grafana Cloud Prometheus instance. The required parameters are: |
- username: the Prometheus username or instance ID.
- password: a Grafana Cloud API key of type MetricsPublisher.
|includeDefaultMetrics||Whether it exports the default APM metrics: data_sent, data_received, http_req_duration, http_reqs, iterations, and vus. Default is true.|
|metrics||List of built-in and custom metrics to export. |
Metric names are validated against the Prometheus metric name conventions—ignoring nonconforming metrics.
|includeTestRunId||Whether all the exported metrics include a test_run_id tag whose value is the k6 Cloud test run id. Default is false. |
Be aware that enabling this setting might increase the cost of your APM provider.
|resampleRate||The rate by which the metrics are resampled and sent to the APM provider in seconds. Default is 3 and acceptable values are integers between 1 and 10.|
Once you have set up the Grafana Cloud settings in the test, you can run a cloud test as usual. The k6 Cloud will continuously export the test results metrics to the Prometheus endpoint during the test execution.
To test the integration, use the Prometheus query field to find k6 metrics.
You can now start using all Grafana visualization capabilities for the k6 metrics. And correlate k6 metrics with other metrics of your systems to get better insights into what happens during your tests.