Documentation forServer & Application Monitor

Microsoft Azure Event Hub Namespace API poller template

Use this SAM API poller template to monitor Microsoft Azure Event Hub performance and statistics counters, including requests, messages, errors, connections and traffic.

Links and screenshots herein are attributed to © 2021 Microsoft Corp., available at docs.microsoft.com, obtained on October 8, 2021.

Prerequisites

  • Use the following parameters to specify the API endpoint in the request URL:
    • ${SUBSCRIPTION_ID}
    • ${USERGROUP_ID}
    • ${EVENT_HUB_ID}

    Use the following example to help locate values in Azure:

  • Configure OAuth 2.0 Azure credentials with the following values:
    • Scope: https://management.azure.com/.default
    • Access Token URL: https://login.microsoftonline.com/{TENANTID}/oauth2/v2.0/token

      Although "(optional)" appears next to the Scope field in the UI, this value is required for API pollers based on this template.

  • The Event Hub Namespace has access control to the Application with at least the Reader role.

Notes

  • Default thresholds are not set for this template.
  • Here is a request example: https://management.azure.com/subscriptions/${SUBSCRIPTION_ID}/resourceGroups/${USERGROUP_ID}/providers/Microsoft.EventHub/namespaces/${EVENT_HUB_ID}/providers/microsoft.insights/metrics?interval=PT1H&metricnames=SuccessfulRequests,ServerErrors,UserErrors,QuotaExceededErrors,ThrottledRequests,IncomingRequests,IncomingMessages,OutgoingMessages,IncomingBytes,OutgoingBytes,ActiveConnections,ConnectionsOpened,ConnectionsClosed,CaptureBacklog,CapturedMessages,CapturedBytes,Size&aggregation=Average,Total&api-version=2018-01-01

Available metrics

Archive backlog messages

The total number of archived messages in the backlog for the given namespace via PowerShell cmd-let.

Unit: Count

Archive message throughput

The total size (in bytes) of Event Hub archived message throughput for the given namespace via PowerShell cmd-let.

Unit: Bytes

Archive messages

The total number of Event Hub archived messages for the given namespace via PowerShell cmd-let.

Unit: Count

Incoming Bytes

The number of bytes sent to the Azure Event Hubs service over a specified period.

Unit: Bytes

Outgoing bytes

The number of bytes retrieved from the Azure Event Hubs service over a specified period.

Unit: Bytes

Incoming Messages

The number of events or messages sent to Event Hubs over a specified period.

Unit: Count

Incoming Requests

The number of incoming send requests for the given namespace via PowerShell cmd-let.

Unit: Count

Internal Server Errors

The number of internal server errors for the given namespace via PowerShell cmd-let.

Unit: Count

Other Errors

The number of requests for the given namespace via PowerShell cmd-let.

Unit: Count

Outgoing Messages

The number of outgoing messages for the given namespace via PowerShell cmd-let.

Unit: Count

Successful Requests

The number of successful requests for the given namespace via PowerShell cmd-let.

Unit: Count

Server Busy Errors

The number of Server Busy errors for the given namespace via PowerShell cmd-let.

Unit: Count