Monitoring Azure API Management Service

Supported information

Configuring Azure API Management sensor

By default, the Azure API Management sensor is enabled. You can disable the sensor and filter by tags and resource groups by using the agent configuration file <agentinstall_dir>/etc/instana/configuration.yaml. See the following example:

com.instana.plugin.azure.apimanagement:
  # Valid values: true, false
  enabled: false # enabled (true) by default
  # Comma separated list of tags in key:value format
  include_tags:
  # Comma separated list of tags in key:value format
  exclude_tags:
  # Comma separated list of resource groups
  include_resource_groups:
  # Comma separated list of resource groups
  exclude_resource_groups:

You can disable the Azure API Management sensor. To stop monitoring Azure API Management services, use the following configuration:

com.instana.plugin.azure.apimanagement:
  enabled: false

You can define multiple tags and resource groups, which are separated by a comma. Provide tags as key-value pairs separated by :. To simplify the configuration, you can specify the tags and resource groups that you want to include or exclude from discovery. If a tag or resource group appears in both the include and exclude lists, the exclude list takes priority. If you don't need to filter services, you don't need to configure it. It is not mandatory to define all values to enable filtering.

To include services by tags in the discovery, use the following configuration:

com.instana.plugin.azure.apimanagement:
  include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)

To exclude services by tags from discovery use following configuration:

com.instana.plugin.azure.apimanagement:
  exclude_tags: # Comma separated list of tags in key:value format (e.g. env:dev,env:test)

To include services by resource groups into discovery use following configuration:

com.instana.plugin.azure.apimanagement:
  include_resource_groups: # Comma separated list of resource groups (e.g. rg_prod,rg_staging)

To exclude services by resource groups from discovery use following configuration:

com.instana.plugin.azure.apimanagement:
  exclude_resource_groups: # Comma separated list of resource groups (e.g. rg_dev,rg_test)

You can configure discovery filtering globally for all Azure services. If you set a filter for the Azure API Management service, it overrides the global filters. For more information about global Azure service discovery filtering, see the Azure Configuration.

Viewing metrics

To view the metrics, complete the following steps:

1. In the Instana UI sidebar, select Infrastructure.
2. Click a specific monitored host to view its dashboard, which displays all collected metrics and monitored processes.

Metrics are pulled every minute, which is the resolution Azure provides for monitoring of these services.