Skip to main content

Azure API Management

Overview

Azure API Management allows you to create, manage and publish APIs for existing back-end services.

The Centreon Monitoring Connector Azure API Management can rely on Azure API or Azure CLI to collect the metrics related to the API Management service.

Pack Assets

Monitored Objects

  • Azure API Management instances :
    • Capacity
    • Events
    • Requests
    • Requests duration

Discovery rules

The Centreon Monitoring Connector Azure API Management includes a Host Discovery provider to automatically discover the Azure instances of a given subscription and add them to the Centreon configuration. This provider is named Microsoft Azure API Management:

image

This discovery feature is only compatible with the 'api' custom mode. 'azcli' is not supported yet.

More information about the Host Discovery module is available in the Centreon documentation: Host Discovery

Collected metrics & status

Metric NameDescriptionUnit
apimanagement.capacity.percentageCapacity Statistics Percentage%

Prerequisites

Please find all the prerequisites needed for Centreon to get information from Azure on the dedicated page.

Setup

  1. Install the Centreon package on every Centreon poller expected to monitor Azure API Management resources:
yum install centreon-plugin-Cloud-Azure-Management-ApiManagement-Api
  1. On the Centreon Web interface, install the Azure API Management Centreon Monitoring Connector on the Configuration > Monitoring Connector Manager page

Configuration

Host

  • Log into Centreon and add a new Host through "Configuration > Hosts".

  • In the IP Address/FQDN field, set the following IP address: '127.0.0.1'.

  • Select the Cloud-Azure-Management-ApiManagement-custom template to apply to the Host.

  • Once the template applied, some Macros marked as 'Mandatory' hereafter have to be configured. These mandatory Macros differ regarding the custom mode used.

Two methods can be used to set the Macros:

  • full ID of the Resource (/subscriptions/<subscription_id>/resourceGroups/<resourcegroup_id>/providers/Microsoft.Network/<resource_type>/<resource_name>) in AZURERESOURCE
  • Resource Name in AZURERESOURCE associated with Resource Group (in AZURERESOURCEGROUP) and Resource Type (in AZURERESOURCETYPE)
MandatoryNomDescription
XAZURECUSTOMMODECustom mode 'api'
XAZURESUBSCRIPTIONSubscription ID
XAZURETENANTTenant ID
XAZURECLIENTIDClient ID
XAZURECLIENTSECRETClient secret
XAZURERESOURCEID or name of the API Management resource
AZURERESOURCEGROUPAssociated Resource Group if resource name is used
AZURERESOURCETYPEAssociated Resource Type if resource name is used

How to check in the CLI that the configuration is OK and what are the main options for ?

Once the Plugin installed, log into your Centreon Poller CLI using the centreon-engine user account and test the Plugin by running the following command:

/usr/lib/centreon/plugins/centreon_azure_management_apimanagement_api.pl \
--plugin=cloud::azure::management::apimanagement::plugin \
--mode=requests \
--custommode=api \
--subscription='xxxxxxxxx' \
--tenant='xxxxxxxxx' \
--client-id='xxxxxxxxx' \
--client-secret='xxxxxxxxx' \
--resource='APP001ABCD' \
--resource-group='RSG1234' \
--timeframe='900' \
--interval='PT5M' \
--aggregation='Total' \
--warning-requests='80' \
--critical-requests='90' \
--filter-dimension="GatewayResponseCodeCategory eq '4XX'"

Expected command output is shown below:

OK: Instance 'APP001ABCD' Statistic 'total' Metrics Failed Requests: 0.00, Total Requests: 523.00 |
'APP001ABCD~total#appgateway.requests.failed.count'=0.00;0:80;0:90;0; 'APP001ABCD~total#appgateway.requests.total.count'=523.00;;;0;

The command above checks the requests of an Azure API Management instance using the 'api' custom-mode (--plugin=cloud::azure::management::apimanagement::plugin --mode=requests --custommode=api). This Event Hub instance is identified by its id (--resource='APP001ABCD') and its associated group (--resource-group='RSG1234'). The authentication parameters to be used with the custom mode are specified in the options (--subscription='xxxxxxxxx' --tenant='xxxxxxx' --client-id='xxxxxxxx' --client-secret='xxxxxxxxxx').

The calculated metrics are the total values (--aggregation='Total') of a 900 secondes / 15 min period (--timeframe='900') with one sample per 5 minutes (--interval='PT5M').

This command would trigger a WARNING alarm if the number of failed requests (--filter-dimension="GatewayResponseCodeCategory eq '2XX'") is reported as over 80 (--warning-requests='80') and a CRITICAL alarm over 90 requests (--critical-requests='90').

All the available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_azure_management_apimanagement_api.pl \
--plugin=cloud::azure::management::apimanagement::plugin \
--mode=requests \
--help

Troubleshooting

The Azure credentials have changed and the Plugin does not work anymore

The Plugin is using a cache file to keep connection information and avoid an authentication at each call. If some of the authentication parameters change, you must delete the cache file.

The cache file can be found within /var/lib/centreon/centplugins/ folder with a name similar to azureapi<md5>_<md5>_<md5>_<md5>.

UNKNOWN: Login endpoint API returns error code 'ERROR_NAME' (add --debug option for detailed message)

It means that some parameters used to authenticate the API request are wrong. The 'ERROR_NAME' string gives some hints about where the problem stands.

As an example, if my Client ID or Client Secret are wrong, 'ERROR_DESC' value will be 'invalid_client'.

UNKNOWN: 500 Can't connect to login.microsoftonline.com:443

This error message means that the Centreon Plugin couldn't successfully connect to the Azure Login API. Check that no third party device (such as a firewall) is blocking the request. A proxy connection may also be necessary to connect to the API. This can be done by using this option in the command: --proxyurl='http://proxy.mycompany:8080'.

UNKNOWN: No metrics. Check your options or use --zeroed option to set 0 on undefined values

This command result means that Azure does not have any value for the requested period. This result can be overriden by adding the --zeroed option in the command. This will force a value of 0 when no metric has been collected and will prevent the UNKNOWN error message.