Monitoring Azure API Management Service
Learn how to monitor the Azure API Management Service.
Nodinite also has Monitoring for these other Azure API Management Service types:
This page provides documentation about Azure API Management Service Monitoring options using Nodinite from one or more role-based Monitor Views. Nodinite monitors the state of content in Azure API Management Service, as specified by user-defined thresholds, either global or specific. You can manage configured Azure API Management Services; Remote commands are available as Actions to help you swiftly address reported problems. The Remote Actions are detailed on the Managing Azure API Management Service page.
Example list of monitored Azure API Management Services in a Nodinite Monitor View.
Monitoring Features
- State Evaluation - Provide state according to user-defined thresholds.
If Nodinite can't check your Azure API Management Service items' state, chances are no one else can use them either.
- Services have Automatic Discovery
- The Nodinite Azure Agent makes use of the Azure Rest API. Hence, Azure API Management Services are dynamically managed.
- Category-based monitoring - To help you sort out the different Azure API Management Service items, the monitored Resources groups by the Nodinite concept of Categories.
- Share access to individual items from within Nodinite using one or more role-based Monitor Views.
State evaluation for Azure API Management Service items
The configured Subscriptions with Azure API Management Services to monitor manifests within Nodinite as one or more Resources. For example, if you have two Services, you will have two Resources in Nodinite.
- The Nodinite Resources name is the name of the deployed Azure API Management Service.
- Monitored Azure API Management Services belong to one of the following 'Azure API Management Service' Categories:
List of monitored categories
Many other Azure related Categories exists as well, please review the Azure Logging and Monitoring Overview
- The Application name is constructed as
/ConfigurationName/ResourceGroupName/..... This naming scheme provides uniqueness, even if you deploy the same set of artifacts/services with the same name in different Monitored Azure Subscriptions.
Each item (presented in Nodinite as a Resource) evaluates with a state (i.e. OK, Warning, Error, Unavailable).
You can override the evaluation process by configuring the Expected State option available for all Nodinite Resources.
API Management Service
The main purposos of the API Management Service resource is to provide the parent for relates services. You can also create new Event Hub Loggers from the Remote Actions.
For API Management Service, the state evaluates as described in the table below:
| State | Status | Description | Actions | |
|---|---|---|---|---|
| Unavailable | Resource not available |
|
Review prerequisites | |
| Error | Error threshold is breached | N/A | ||
| Warning | Warning threshold is breached | One or more problems exists
|
||
| OK | Within user-defined thresholds | Operational | Create Event Hub Logger Details |
Alert history for Azure API Management Service
During root cause analysis or other purposes, it might be helpful to understand how often your Azure API Management Service problems happen. If your Monitor View allows it, you can search for historical state changes for the provided time-span either for all your Azure API Management Service or individually. This topic is further detailed within the generic instructions on how to Add or manage Monitor View page.
| Search | Resource history |
|---|---|
 Search for alert history for all resources in the Monitor View |
 Alert history for the selected Azure API Management Service item |
Frequently asked questions
Use the troubleshooting guide to find the FAQ and answers to known problems.
How do I enable monitoring of Azure API Management Service
To Monitor Azure API Management Service; Check the Enable monitoring check box (default is checked). This is detailed in the 'Configuration' user guide.
The screenshot shows the remote configuration form; Available from within the Monitoring Agents administration page.
Example with the monitoring disabled for Azure API Management Service (include all API related artifacts).