Skip to content

Azure API Management

Availability BadgeResource Discovery Support Badge

You can scrape an Azure API Management via the ApiManagement resource type.

When using declared resources, the following fields need to be provided:

  • instanceName - The name of the Azure API Management instance.
  • locationName - The name of the regional deployment of the gateway. (optional)

All supported metrics are documented in the official Azure Monitor documentation.

Multi-region support

Azure API Management instances can be deployed to multiple regions across the world.

Promitor supports different scenarios:

  1. Report metrics for metrics for all locations (default)
  2. Scope metric to a single region by configuring locationName.
  3. Report metrics but split it across all regions by using the Location dimension.

The following scraper-specific metric label will be added for scenario 2 & 3:

  • location - Name of the location

Example

Here is an example configuration:

name: promitor_demo_azureapimanagement_capacity
description: "The amount of capacity used an Azure API Management instance."
resourceType: ApiManagement
azureMetricConfiguration:
  metricName: Capacity
  aggregation:
    type: Average
resources: # Optional, required when no resource discovery is configured
- instanceName: promitor-api-gateway
resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://docs.promitor.io/latest/how-it-works#using-resource-discovery)
- name: api-management-landscape