You are here
404: Not Found
Cloud - Azure - API Management Services Opspack
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.
What You Can Monitor
This Opspack 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.
|Host Template||Service Check||Description|
|Cloud - Azure - API Management Services||Azure - API Management Service - Requests||Total number of requests by status [Default Timespan = 5mins, Granularity = 5mins]|
|Cloud - Azure - API Management Services||Azure - API Management Service - Duration||Overall Duration of Gateway Requests in milliseconds [Default Timespan = 5mins, Granularity = 5mins]|
|Cloud - Azure - API Management Services||Azure - API Management Service - Capacity||Utilization metric for ApiManagement service, in percent [Default Timespan = 5mins, Granularity = 5mins]|
- Ensure your Opsview Monitor version is newer than 07 September 2018. Check Opsview Release Notes for the latest version of Opsview Monitor.
Setup Azure for Monitoring
To monitor your Azure environment, you need to configure it for monitoring. This requires Administrator access on Azure.
You need to retrieve the following credentials, which will allow Opsview Monitor access to the metrics for your Azure VM:
- Subscription ID
- Tenant/Directory ID
- Client/Application ID
- Secret Key
Follow the below steps to retrieve this information.
Step 1: Find Subscription ID
The Subscription ID can be found in the Subscriptions section under the All services section from the Azure dashboard.
Step 2 : Find the Tenant/Directory ID
The Tenant/Directory ID can be found in the Azure Active Directory under the Properties section from the Azure dashboard.
Step 3: Find the Client/Application ID for your application
You need to create and register your application if you haven't already. Use the following documentation from Microsoft: Create an Azure Active Directory application
The Client/Application ID can be found in Azure Active Directory under the App registrations section from the Azure dashboard.
Step 4: Generate the Secret Key for your application
You will need to create a Secret Key for your application, once this has been created its value will be hidden so save the value during creation.
To create the Secret Key, select your application from the list, select the Settings within your application and then select the Keys option.
There you can create a new key by adding the description and expiration period and the value will be generated.
Step 5: Provide access to the subscription you wish to monitor
Navigate to the Subscriptions section and select the Subscription you selected before.
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
If you are running more than one subscription these steps will need to be done for each one you wish to monitor.
Setup and Configuration
To configure and utilize this Opspack, you simply need to add the 'Cloud - Azure - API Management Services' Opspack to your Opsview Monitor system.
Step 1: Import the Opspack
Download the cloud-azure-api-management-services.opspack file from the Releases section of this repository. Navigate to Host Template Settings inside Opsview Monitor and select Import Opspack in the top left corner.
Then click Browse and select the cloud-azure-api-management-services.opspack file. Click Upload and then click Import when the file is uploaded. You may see a 'CONFLICT' warning message after uploading - this is because all 'Cloud - Azure' Opspacks utilize the same variable (AZURE_CREDENTIALS) for authorizing access to your resources. Just click Overwrite and the Opspack should import successfully.
Step 2: Add the host template
Add the relevant host template (as listed in the Service Checks table above). If this is a resource that is applicable for a host check (has a valid hostname or IP) then you can fill in the Primary Hostname/IP field with this, and then open the Advanced section at the bottom and change the Host Check Command type to TCP Port 80 (HTTP). If the resource has no hostname or public IP, then change Host Check Command to Always assumed to be UP.
Step 3: Add and configure variables required for this host
Add 'AZURE_CREDENTIALS' to the host, then override the Subscription ID, Client ID, Secret Key and Tenant ID to match the values retrieved earlier.
Depending on your host template, you will require different additional variables declared as specified below:
|Host Template||Variables Required|
|Cloud - Azure - API Management Services||AZURE_RESOURCE_DETAILS|
These can be filled out as follows:
Step 4: Apply changes and the system will now be monitored
ODI-2057 Fixes and Improvements to Parameter handling
Improvements to user input verification and errors.
ODI-1747 Fixes and Improvements to Authentication Process
Improvements to Azure authentication error handling
ODI-1453 Initial Release of Azure Opspacks for Opsview Monitor 6.0
Initial release of Opspack to work with Opsview Monitor 6.0