Manage Azure API Management Service Monitoring

Manage monitoring options and perform remote administrative actions on Azure API Management Service related items for configured Azure subscriptions.

To Manage other parts of Azure API Management Service using Nodinite; Review the following user guides:

• Manage API
• Manage Certificate
• Manage Event Hub Logger
• Manage Private Endpoint

For your business and other end-users; Delegate the power to manage, and gain insights to selected Azure API Management Services in Azure. Nodinite Monitoring aids the support and maintenance team's people in having additional data for root cause analysis without having individual direct access to the Microsoft Azure Portal. Reducing access limits the number of attack vectors, and having fewer people with fewer access rights minimizes the risk for disruption of mission-critical services.

Management Features

For Resources in the Role-based Monitor Views with the Remote Actions privilege grant; The following Remote Actions grouped by Category are available:

As an Administrator with access to the Configuration for Monitoring Agents, the additional monitoring options are available:

API Management Service

The 'API Management Service' Category provides one resource for each 'Azure API Management Service' for configured Azure Subscriptions and Resource Groups with the deployed Azure name, as the resource name:

Example from a Monitor View with a list of configured 'API Management Services'

See Monitoring Azure API Management Service for additional details about Azure API Management Service Monitoring.

The API Management Service category provides Resources that displays the evaluated monitored state according to user-defined thresholds.

The following Remote Actions are available for the API Management Service Category.

1. Details
2. Create Logger

Example with a list of Remote Actions as seen from the dropdown menu of the Actions button.

Details

To view the selected API Management Service resource; Click the Action button and then click on the Details menu item within the 'Control Center' section.

Use the 'Details' action menu item to open the details modal for the selected API Management Service.

Next, click the option to present the modal.

Here's an example of details for selected Azure API Management Service.

Create Event Hub Logger

Logging to Nodinite using a Policy, is detailed in the API Logging user guide.

If you are Logging from an API using the Azure API Management Service, then your policy contains a named Logger. This logger can be managed from within Nodinite. You can perform the folloing CRUD operation:

• Create
• Modify
• Delete

To Create a new Event Hub Logger; Click the Action button and then click on the Create Logger menu item within the 'Control Center' section.

Create Logger Action button menu item.

Next, click the option to present the modal.

Here's an example of the create new logger modal.

1. Logger Name - Enter the name of the Event Hub logger, this name should rarely change since your hard-coded policy uses this name.
2. Event Hub Name - Enter the name of the Event Hub entity to use as target for the Nodinite JSON Log Event.
3. Event Hub Connection String - Enter the connection string with access to write events triggered by the policy.

   Note

   EntityPath should not be part of the Connection String.

4. Resource ID ^{New 6.2.1.2} - Enter the path to the target Event Hub entity:

Format: /subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/eventhubs/{eventhub-name}
Example: subscriptions/ae3da538-3e2b-4490-9feb-7dfe30a6683c/resourceGroups/Default-Storage-NorthEurope/providers/Microsoft.EventHub/namespaces/{NAMESPACENAME}/eventhubs/{EventHubName}

Note

This configuration is manual and can be tricky to set up correctly, especially since the target Event Hub entity might be located in a different resource group or namespace than the API Management Service where this Event Hub logger will be utilized.

5. Description - Optionally, you can provide a user friendly desription for this logger instance.
6. Is Buffered - The default is checked.

Click the Create button to persist changes.

Create operation button.

Tip

Use the Post remote action and send a JSON Log Event using an example from the Swagger in the Nodinite Log API to Event Hub entity operation to validate you have an operational configuration.
✅ Azure Agent config with the right to post to an Event Hub entity
✅ Pickup Service properly configured to read from the Event Hub entity
✅ Verify the Event Hub Logger is operational
✅ Verify the Policy is operational in Azure APIM Servie API

Next Step

Global Configuration of the Azure Monitoring agent.

Related Topics

Azure Logging and Monitoring Overview
Prerequisites for Azure Agent