Azure Monitor

You can export test result metrics from the k6 Cloud to Azure Monitor, using Azure Monitor to store and analyze all your data from your Azure and other environments.

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

Azure Monitor Setup

To set up the Azure Monitor integration on the k6 Cloud, you need the following settings:

1. Make sure you have an active subscription on Azure. Copy the subscription ID for subscriptionId setting.

   

2. Create a resource group under your active subscription. Copy the name for the resourceGroupName setting.

   

3. Create a service principal by adding a new app to Azure app registrations. Copy the name for the tenantId setting.

   

4. Create a client secret in your service principal. Copy the clientId and clientSecret settings.

   

5. Go to your resource group and assign "Monitoring Metrics Publisher" role to the user and the service principal.

   

6. Create a log analytics workspace. The region is now created. Copy the region name for the azureRegion setting.

   

7. Create an app under application insights with your log analytics workspace. The region should match the log analytics workspace. Copy the app name for the insightsAppName setting.

   

k6 Cloud test configuration

You have to enable the Azure Monitor integration for each test that you want to export its k6 metrics when running the test.

Currently, there are two options to set up the Cloud APM settings in the test:

• Using the test builder
• Scripting the k6 test

Configuration using the test builder

First, you have to configure the Azure Monitor settings for an organization. Click the Cloud APM option on the left sidebar menu under the Manage section, and select Azure Monitor from the list.

In this form, set the parameters that you copied in the previous steps. For more information on the other input fields, see configuration parameters.

Save the Azure Monitor configuration for the current organization.

Note that configuring the Azure Monitor 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 an existing test previously created using the test builder. Click the Cloud APM option on the test builder sidebar to enable the integration for the test.

Configuration in the k6 script

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 Azure Monitor are as follows:

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

          tenantId: '<Directory (tenant) ID>',
          clientId: '<Application (client) ID>',
          clientSecret: '<Client secret>',
          subscriptionId: '<Subscription ID>',
          resourceGroupName: '<Resource Group Name>',
          insightsAppName: '<Application Insights Name>',
          // optional
          azureRegion: '<Region>',

          // optional
          metrics: ['http_req_sending', 'my_rate', 'my_gauge'], // ...
          includeDefaultMetrics: true,
          includeTestRunId: false,
        },
      ],
    },
  },
};

Configuration Parameters

Supported Regions

The supported Azure Monitor regions are:

Run the cloud test

Once you have set up the Azure Monitor settings in the test, you can run a cloud test as usual. The k6 Cloud will continuously export the test results metrics to Azure Monitor during the test execution with a 3~4 minutes delay.

You can now view the k6 metrics on Azure Monitor. Just choose application insights name as scope, k6 as metrics namespace and your metrics (and their associated aggregation methods) will be shown in metric dropdown. If you didn't see the results, try to narrow down the time range to last 30 minutes or less.

See also

• Cloud APM