Cloud APM

Cloud tests can export their metrics in near real-time to application performance monitoring (APM) platforms. By combining k6 Cloud with an APM, you can correlate and query testing metrics with other system metrics.

⭐️  Cloud APM integrations are available on Pro and Enterprise plans, as well as the annual Team plan and Trial.

Configure APM export on the test level

Each test has to set up its APM settings to export the metrics of its run. Some ways you can customize export to your use case:

• Configure a test to export to multiple different APM providers.
• Configure the APM settings using the k6 Cloud app and test builder or scripting the k6 test.

For details, refer to the instructions on integrating different APM platforms:

• Grafana Cloud
• Azure Monitor
• Datadog
• New Relic.
• Prometheus

Default APM Metrics

By default, the APM integrations export only the default APM metrics, a subset of all k6 metrics.

The includeDefaultMetrics option in the k6 script controls whether to export the default APM metrics or not. The default APM metrics are:

If you're unfamiliar with the different types of k6 metrics, refer to the Metrics reference.

By default, k6 limits export to only these metrics to avoid unexpected costs with your APM provider. APM providers charge based on the number of stored metrics, and a load test can generate a massive volume of metrics.

To select the metrics to export, use the metrics option. In the k6 script, you can set both options - includeDefaultMetrics and metrics - as follows:

export const options = {
  ext: {
    loadimpact: {
      apm: [
        {
          provider: 'your-provider',

          // Whether it exports the default APM metrics. Default is true.
          includeDefaultMetrics: false,
          // List of built-in and custom metrics to export. Default is empty.
          metrics: ['vus', 'http_req_duration', 'http_req_sending', 'my_rate', 'my_gauge'], //...
          //....
        },
      ],
    },
  },
};