Azure Notification Hubs monitoring data reference
This article contains all the monitoring reference information for this service.
See Monitor Notification Hubs for details on the data you can collect for Azure Notification Hubs and how to use it.
Metrics
This section lists all the automatically collected platform metrics for this service. These metrics are also part of the global list of all platform metrics supported in Azure Monitor.
For information on metric retention, see Azure Monitor Metrics overview.
Supported metrics for Microsoft.NotificationHubs/namespaces/notificationHubs
The following table lists the metrics available for the Microsoft.NotificationHubs/namespaces/notificationHubs resource type.
- All columns might not be present in every table.
- Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.
Table headings
- Category - The metrics group or classification.
- Metric - The metric display name as it appears in the Azure portal.
- Name in REST API - The metric name as referred to in the REST API.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
- Dimensions - Dimensions available for the metric.
- Time Grains - Intervals at which the metric is sampled. For example,
PT1Mindicates that the metric is sampled every minute,PT30Mevery 30 minutes,PT1Hevery hour, and so on. - DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| Incoming Messages The count of all successful send API calls. |
incoming |
Count | Total (Sum) | <none> | PT1M | Yes |
| All Incoming Failed Requests Total incoming failed requests for a notification hub |
incoming.all.failedrequests |
Count | Total (Sum) | <none> | PT1M | Yes |
| All Incoming Requests Total incoming requests for a notification hub |
incoming.all.requests |
Count | Total (Sum) | <none> | PT1M | Yes |
| Scheduled Push Notifications Sent Scheduled Push Notifications Sent |
incoming.scheduled |
Count | Total (Sum) | <none> | PT1M | Yes |
| Scheduled Push Notifications Cancelled Scheduled Push Notifications Cancelled |
incoming.scheduled.cancel |
Count | Total (Sum) | <none> | PT1M | Yes |
| Installation Management Operations Installation Management Operations |
installation.all |
Count | Total (Sum) | <none> | PT1M | Yes |
| Delete Installation Operations Delete Installation Operations |
installation.delete |
Count | Total (Sum) | <none> | PT1M | Yes |
| Get Installation Operations Get Installation Operations |
installation.get |
Count | Total (Sum) | <none> | PT1M | Yes |
| Patch Installation Operations Patch Installation Operations |
installation.patch |
Count | Total (Sum) | <none> | PT1M | Yes |
| Create or Update Installation Operations Create or Update Installation Operations |
installation.upsert |
Count | Total (Sum) | <none> | PT1M | Yes |
| All Outgoing Notifications All outgoing notifications of the notification hub |
notificationhub.pushes |
Count | Total (Sum) | <none> | PT1M | Yes |
| Bad or Expired Channel Errors The count of pushes that failed because the channel/token/registrationId in the registration was expired or invalid. |
outgoing.allpns.badorexpiredchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| Channel Errors The count of pushes that failed because the channel was invalid not associated with the correct app throttled or expired. |
outgoing.allpns.channelerror |
Count | Total (Sum) | <none> | PT1M | Yes |
| Payload Errors The count of pushes that failed because the PNS returned a bad payload error. |
outgoing.allpns.invalidpayload |
Count | Total (Sum) | <none> | PT1M | Yes |
| External Notification System Errors The count of pushes that failed because there was a problem communicating with the PNS (excludes authentication problems). |
outgoing.allpns.pnserror |
Count | Total (Sum) | <none> | PT1M | Yes |
| Successful notifications The count of all successful notifications. |
outgoing.allpns.success |
Count | Total (Sum) | <none> | PT1M | Yes |
| APNS Bad Channel Error The count of pushes that failed because the token is invalid (APNS status code: 8). |
outgoing.apns.badchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| APNS Expired Channel Error The count of token that were invalidated by the APNS feedback channel. |
outgoing.apns.expiredchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| APNS Authorization Errors The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked. |
outgoing.apns.invalidcredentials |
Count | Total (Sum) | <none> | PT1M | Yes |
| APNS Invalid Notification Size Error The count of pushes that failed because the payload was too large (APNS status code: 7). |
outgoing.apns.invalidnotificationsize |
Count | Total (Sum) | <none> | PT1M | Yes |
| APNS Errors The count of pushes that failed because of errors communicating with APNS. |
outgoing.apns.pnserror |
Count | Total (Sum) | <none> | PT1M | Yes |
| APNS Successful Notifications The count of all successful notifications. |
outgoing.apns.success |
Count | Total (Sum) | <none> | PT1M | Yes |
| FCMv1 Bad Channel Errors The count of pushes that failed because the registrationId in the registration was not recognized (FCMv1 result: Invalid registration, Missing Registration, Not registered, Not found, or Gone). |
outgoing.fcmv1.badchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| FCMv1 Authorization Errors (Invalid Credentials) The count of pushes that failed because the PNS did not accept the provided credentials (FCMv1 result: Sender Id Mismatch, Unauthorized, or Forbidden). |
outgoing.fcmv1.invalidcredentials |
Count | Total (Sum) | <none> | PT1M | Yes |
| FCMv1 Invalid Notification Format The count of pushes that failed because the payload was not formatted correctly (FCMv1 result: Invalid TTL, Invalid parameters, or Invalid data key). |
outgoing.fcmv1.invalidnotificationformat |
Count | Total (Sum) | <none> | PT1M | Yes |
| FCMv1 Invalid Notification Size Errors The count of pushes that failed because the payload was too large (FCMv1 result: Message too big). |
outgoing.fcmv1.invalidnotificationsize |
Count | Total (Sum) | <none> | PT1M | Yes |
| FCMv1 Errors The count of pushes that failed because of errors communicating with FCMv1. |
outgoing.fcmv1.pnserror |
Count | Total (Sum) | <none> | PT1M | Yes |
| FCMv1 Successful Notifications The count of all successful notifications. |
outgoing.fcmv1.success |
Count | Total (Sum) | <none> | PT1M | Yes |
| FCMv1 Throttled Notifications The count of pushes that failed because FCMv1 throttled this app (FCMv1 Result: Quota Exceeded or 429). |
outgoing.fcmv1.throttled |
Count | Total (Sum) | <none> | PT1M | Yes |
| FCMv1 Wrong Channel Errors The count of pushes that failed because the registrationId in the registration is not associated to the current app (FCMv1 result: Invalid package name). |
outgoing.fcmv1.wrongchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Authentication Errors The count of pushes that failed because the PNS did not accept the provided credentials the credentials are blocked or the SenderId is not correctly configured in the app (GCM result: MismatchedSenderId). |
outgoing.gcm.authenticationerror |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Bad Channel Error The count of pushes that failed because the registrationId in the registration was not recognized (GCM result: Invalid Registration). |
outgoing.gcm.badchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Expired Channel Error The count of pushes that failed because the registrationId in the registration was expired (GCM result: NotRegistered). |
outgoing.gcm.expiredchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Authorization Errors (Invalid Credentials) The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked. |
outgoing.gcm.invalidcredentials |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Invalid Notification Format The count of pushes that failed because the payload was not formatted correctly (GCM result: InvalidDataKey or InvalidTtl). |
outgoing.gcm.invalidnotificationformat |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Invalid Notification Size Error The count of pushes that failed because the payload was too large (GCM result: MessageTooBig). |
outgoing.gcm.invalidnotificationsize |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Errors The count of pushes that failed because of errors communicating with GCM. |
outgoing.gcm.pnserror |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Successful Notifications The count of all successful notifications. |
outgoing.gcm.success |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Throttled Notifications The count of pushes that failed because GCM throttled this app (GCM status code: 501-599 or result:Unavailable). |
outgoing.gcm.throttled |
Count | Total (Sum) | <none> | PT1M | Yes |
| GCM Wrong Channel Error The count of pushes that failed because the registrationId in the registration is not associated to the current app (GCM result: InvalidPackageName). |
outgoing.gcm.wrongchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| MPNS Authentication Errors The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked. |
outgoing.mpns.authenticationerror |
Count | Total (Sum) | <none> | PT1M | Yes |
| MPNS Bad Channel Error The count of pushes that failed because the ChannelURI in the registration was not recognized (MPNS status: 404 not found). |
outgoing.mpns.badchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| MPNS Channel Disconnected The count of pushes that failed because the ChannelURI in the registration was disconnected (MPNS status: 412 not found). |
outgoing.mpns.channeldisconnected |
Count | Total (Sum) | <none> | PT1M | Yes |
| MPNS Dropped Notifications The count of pushes that were dropped by MPNS (MPNS response header: X-NotificationStatus: QueueFull or Suppressed). |
outgoing.mpns.dropped |
Count | Total (Sum) | <none> | PT1M | Yes |
| MPNS Invalid Credentials The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked. |
outgoing.mpns.invalidcredentials |
Count | Total (Sum) | <none> | PT1M | Yes |
| MPNS Invalid Notification Format The count of pushes that failed because the payload of the notification was too large. |
outgoing.mpns.invalidnotificationformat |
Count | Total (Sum) | <none> | PT1M | Yes |
| MPNS Errors The count of pushes that failed because of errors communicating with MPNS. |
outgoing.mpns.pnserror |
Count | Total (Sum) | <none> | PT1M | Yes |
| MPNS Successful Notifications The count of all successful notifications. |
outgoing.mpns.success |
Count | Total (Sum) | <none> | PT1M | Yes |
| MPNS Throttled Notifications The count of pushes that failed because MPNS is throttling this app (WNS MPNS: 406 Not Acceptable). |
outgoing.mpns.throttled |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Authentication Errors Notification not delivered because of errors communicating with Windows Live invalid credentials or wrong token. |
outgoing.wns.authenticationerror |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Bad Channel Error The count of pushes that failed because the ChannelURI in the registration was not recognized (WNS status: 404 not found). |
outgoing.wns.badchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Channel Disconnected The notification was dropped because the ChannelURI in the registration is throttled (WNS response header: X-WNS-DeviceConnectionStatus: disconnected). |
outgoing.wns.channeldisconnected |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Channel Throttled The notification was dropped because the ChannelURI in the registration is throttled (WNS response header: X-WNS-NotificationStatus:channelThrottled). |
outgoing.wns.channelthrottled |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Dropped Notifications The notification was dropped because the ChannelURI in the registration is throttled (X-WNS-NotificationStatus: dropped but not X-WNS-DeviceConnectionStatus: disconnected). |
outgoing.wns.dropped |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Expired Channel Error The count of pushes that failed because the ChannelURI is expired (WNS status: 410 Gone). |
outgoing.wns.expiredchannel |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Authorization Errors (Invalid Credentials) The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked. (Windows Live does not recognize the credentials). |
outgoing.wns.invalidcredentials |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Invalid Notification Format The format of the notification is invalid (WNS status: 400). Note that WNS does not reject all invalid payloads. |
outgoing.wns.invalidnotificationformat |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Invalid Notification Size Error The notification payload is too large (WNS status: 413). |
outgoing.wns.invalidnotificationsize |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Authorization Errors (Invalid Token) The token provided to WNS is not valid (WNS status: 401 Unauthorized). |
outgoing.wns.invalidtoken |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Errors Notification not delivered because of errors communicating with WNS. |
outgoing.wns.pnserror |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Successful Notifications The count of all successful notifications. |
outgoing.wns.success |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Throttled Notifications The count of pushes that failed because WNS is throttling this app (WNS status: 406 Not Acceptable). |
outgoing.wns.throttled |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Authorization Errors (Unreachable) Windows Live is not reachable. |
outgoing.wns.tokenproviderunreachable |
Count | Total (Sum) | <none> | PT1M | Yes |
| WNS Authorization Errors (Wrong Token) The token provided to WNS is valid but for another application (WNS status: 403 Forbidden). This can happen if the ChannelURI in the registration is associated with another app. Check that the client app is associated with the same app whose credentials are in the notification hub. |
outgoing.wns.wrongtoken |
Count | Total (Sum) | <none> | PT1M | Yes |
| Registration Operations The count of all successful registration operations (creations updates queries and deletions). |
registration.all |
Count | Total (Sum) | <none> | PT1M | Yes |
| Registration Create Operations The count of all successful registration creations. |
registration.create |
Count | Total (Sum) | <none> | PT1M | Yes |
| Registration Delete Operations The count of all successful registration deletions. |
registration.delete |
Count | Total (Sum) | <none> | PT1M | Yes |
| Registration Read Operations The count of all successful registration queries. |
registration.get |
Count | Total (Sum) | <none> | PT1M | Yes |
| Registration Update Operations The count of all successful registration updates. |
registration.update |
Count | Total (Sum) | <none> | PT1M | Yes |
| Pending Scheduled Notifications Pending Scheduled Notifications |
scheduled.pending |
Count | Total (Sum) | <none> | PT1M | Yes |
Metric dimensions
For information about what metric dimensions are, see Multi-dimensional metrics.
This service doesn't have any metrics that contain dimensions.
Resource logs
This section lists the types of resource logs you can collect for this service. The section pulls from the list of all resource logs category types supported in Azure Monitor.
Supported resource logs for Microsoft.NotificationHubs/namespaces
| Category | Category display name | Log table | Supports basic log plan | Supports ingestion-time transformation | Example queries | Costs to export |
|---|---|---|---|---|---|---|
OperationalLogs |
Operational Logs | No | No | No |
Supported resource logs for Microsoft.NotificationHubs/namespaces/notificationHubs
| Category | Category display name | Log table | Supports basic log plan | Supports ingestion-time transformation | Example queries | Costs to export |
|---|---|---|---|---|---|---|
OperationalLogs |
Operational Logs | No | No | Yes |
Azure Monitor Logs tables
This section lists the Azure Monitor Logs tables relevant to this service, which are available for query by Log Analytics using Kusto queries. The tables contain resource log data and possibly more depending on what is collected and routed to them.
Azure Notification Hubs supports operational logs, which capture management operations that are performed on the Notification Hubs namespace. All logs are stored in JavaScript Object Notation (JSON) format in the following two locations:
- AzureActivity: Displays logs from operations and actions that are conducted against the namespace in the Azure portal or through Azure Resource Manager template deployments.
- AzureDiagnostics: Displays logs from operations and actions that are conducted against the namespace by using the API, or through management clients on the language SDK.
Diagnostic log JSON strings include the elements listed in the following table:
| Name | Description |
|---|---|
| time | UTC timestamp of the log |
| resourceId | Relative path to the Azure resource |
| operationName | Name of the management operation |
| category | Log category. Valid values: OperationalLogs |
| callerIdentity | Identity of the caller who initiated the management operation |
| resultType | Status of the management operation. Valid values: Succeeded or Failed |
| resultDescription | Description of the management operation |
| correlationId | Correlation ID of the management operation (if specified) |
| callerIpAddress | The caller IP address. Empty for calls that originated from the Azure portal |
Activity log
The linked table lists the operations that can be recorded in the activity log for this service. These operations are a subset of all the possible resource provider operations in the activity log.
For more information on the schema of activity log entries, see Activity Log schema.
Operational logs capture all management operations that are performed on the Azure Notification Hubs namespace. Data operations aren't captured, because of the high volume of data operations that are conducted on notification hubs.
Microsoft.NotificationHubs resource provider operations lists all the management operations that are captured in operational logs.
Related content
- See Monitor Notification Hubs for a description of monitoring Notification Hubs.
- See Monitor Azure resources with Azure Monitor for details on monitoring Azure resources.