Monitoring Azure API Management Service
Get full control and visibility over your Azure API Management Service with Nodinite. Monitor, manage, and secure your API Management resources, detect disruptions instantly, and give your team actionable insights and role-based access.
- ✅ Detect disruptions and human errors in your Azure API Management Service instantly
- ✅ Limit direct access to Azure services and increase security
- ✅ Give your team role-based Monitor Views and Remote Actions
- ✅ Get alerts through Alarm Plugins and review the alert history
Learn how to monitor the Azure API Management Service with the Nodinite Azure Monitoring Agent.
Nodinite also provides Monitoring for these Azure API Management Service types:
This page explains the Azure API Management Service monitoring options in Nodinite, from one or more role-based Monitor Views. Nodinite monitors the state of content in Azure API Management Service against the global or specific thresholds you define. You manage configured Azure API Management Services and use Remote Actions to address reported problems swiftly. The Managing Azure API Management Service page details the Remote Actions.
Example list of monitored Azure API Management Services in a Nodinite Monitor View.
How Monitoring Works
Operational"] AG --> WA["fa:fa-triangle-exclamation Warning
Bad provisioning state"] AG --> UN["fa:fa-ban Unavailable
Network or security problem"] WA --> AP["fa:fa-bell Alarm Plugins"] UN --> AP WA --> RA["fa:fa-bolt Remote Actions
Details, Create Event Hub Logger"] style OK fill:#93d16d style WA fill:#FFD525 style UN fill:#c33d34,color:#fff style AG fill:#2678BD,color:#fff
Diagram: The agent evaluates each API Management Service into OK (green), Warning (yellow) for a bad provisioning state, or Unavailable (red) when it can't reach the service. State changes raise alerts, and you investigate with Remote Actions.
Monitoring Features
- State Evaluation - Nodinite provides state according to user-defined thresholds.
If Nodinite can't check your Azure API Management Service items' state, no one else can use them either.
- Automatic Discovery - The Nodinite Azure Agent uses the Azure Rest API and manages Azure API Management Services dynamically.
- Category-based monitoring - Nodinite sorts Azure API Management Service items by grouping monitored Resources in Categories.
- Role-based access - Share access to individual items with your Users through one or more role-based Monitor Views.
- Alerts - The Monitoring Service sends state changes to your Alarm Plugins.
State evaluation for Azure API Management Service items
The Azure API Management Services in the configured Subscriptions appear in Nodinite as Resources. For example, if you have two Services, you have two Resources in Nodinite.
- The Nodinite Resource name is the name of the deployed Azure API Management Service.
- Monitored Azure API Management Service items belong to one of the following 'Azure API Management Service' Categories:
List of monitored categories.
Many other Azure-related Categories exist as well; review the Azure Logging and Monitoring Overview.
- Nodinite constructs the Application name as
/ConfigurationName/ResourceGroupName/..... This naming scheme provides uniqueness, even if you deploy the same set of artifacts or services with the same name in different monitored Azure Subscriptions.
Illustration: Unique application path structure for Azure resources in Nodinite.
Each item (presented in Nodinite as a Resource) evaluates to a state (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 API Management Service resource mainly acts as the parent of the related services. You can also create new Event Hub Loggers with the Create Event Hub Logger Remote Action.
For API Management Service, Nodinite evaluates the state 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 exist
|
|
| ✅ OK | Within user-defined thresholds | Operational | Create Event Hub Logger Details |
When the state is 🚫 Unavailable, verify the Azure access rights and the firewall settings for the agent.
Alert history for Azure API Management Service
During root cause analysis or other purposes, it helps 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 Services or individually. The generic instructions on how to Add or manage Monitor View detail this topic.
| 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 checkbox (default is checked). The Configuration user guide details this setting.
The screenshot shows the Remote Configuration form, available from the Monitoring Agents administration page.
Example with the monitoring disabled for Azure API Management Service (includes all API-related artifacts).
How do I log API requests and responses?
Monitoring covers the state of the service. To log the API traffic itself, see the Azure API Management logging guide, and create the Event Hub Logger with the Create Event Hub Logger Remote Action.
Next Steps
- Managing API Management Service
- Azure API Management Service Overview
- Azure Logging and Monitoring Overview