You are here
404: Not Found
Included in the Cloud - Azure Opspack
Host Template: Cloud - Azure - API Management Services
Azure API Management helps organizations publish APIs to unlock the potential of their data and services. API Management provides the essentials to ensure a successful API program through developer engagement, business insights, analytics, security, and protection. You can use Azure API Management to take any backend and create a complete API program based on it.
This Host Template allows you to monitor all the metrics you need to efficiently run Azure API Management Services on Microsoft Azure. After installation, you'll be able to check the total number of requests, the overall duration of gateway requests as well as the utilisation percentage.
This Host Template includes the following Service Checks:
|Service Check Name||Description||Default Thresholds (Warning, Critical)||UOM|
|Azure - API Management Service - Requests||Total number of requests by status [Default Timespan = 5mins, Granularity = 5mins]||N/A||N/A|
|Azure - API Management Service - Duration||Overall Duration of Gateway Requests in milliseconds [Default Timespan = 5mins, Granularity = 5mins]||N/A||ms|
|Azure - API Management Service - Capacity||Utilization metric for ApiManagement service, in percent [Default Timespan = 5mins, Granularity = 5mins]||capacity=70,90||%|
To use this Host Template you will need to provide access to the subscription you wish to monitor
Navigate to the Subscriptions section and select your Subscription.
In the Subscription to be monitored, click Access Control (IAM).
Then click the Add button, select the required role and select the application, once for each of the following roles: * Reader
Repeat these steps for each subscription you wish to monitor.
Step 1: Add this Host Template
Add the Cloud - Azure - API Management Services Host Template to your Opsview Monitor host. If the resource you're monitoring has no hostname or public IP, then open the Advanced settings pane and change Host Check Command to Always assumed to be UP.
For more information, refer to Opsview Knowledge Center - Adding Host Templates to Hosts.
Step 2: Add and configure variables required for this Host Template
The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance when you import the Opspack:
The Value is not used and therefore can be set to anything. Override the arguments with your Azure Credentials.
| Parameter | Position in Variable | Name | Description |
| --subscription-id | Arg1 | Subscription ID | The Subscription ID of your Azure Subscription |
| --client-id | Arg2 | Client ID | The Client ID of your Azure Subscription |
| --secret-key | Arg3 | Secret Key | The Secret Key of your Azure Subscription |
| --tenant-id | Arg4 | Tenant ID | The Tenant ID of your Azure Subscription |
The Value is not used and therefore can be set to anything. Override the arguments with your Azure Resource Details.
|Parameter||Position in Variable||Name||Description|
|--resource-group||Arg1||Resource Group||Name of the Azure resource group to be monitored|
|--resource-name||Arg2||Resource Name||Name of the Azure resource to be monitored|
For more information, refer to Opsview Knowledge Center - Adding Variables to Hosts.
For mode-specific help, run the plugin with the
-h -m <mode> flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:
|Service Check Name||Mode|
|Azure - API Management Service - Requests||
|Azure - API Management Service - Duration||
|Azure - API Management Service - Capacity||
Step 3: Apply changes and the system will now be monitored
ODI-3806 Cloud Azure Opspack
Initial release for Cloud Azure Opspack