Muokkaa

Jaa


Azure Service Bus monitoring data reference

This article contains all the monitoring reference information for this service.

See Monitor Azure Service Bus for details on the data you can collect for Service Bus 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.ServiceBus/Namespaces

The following table lists the metrics available for the Microsoft.ServiceBus/Namespaces 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, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every 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
Abandoned Messages

Count of messages abandoned on a Queue/Topic.
AbandonMessage Count Total (Sum) EntityName PT1M Yes
ActiveConnections

Total Active Connections for Microsoft.ServiceBus.
ActiveConnections Count Total (Sum) <none> PT1M No
Count of active messages in a Queue/Topic.

Count of active messages in a Queue/Topic.
ActiveMessages Count Average, Minimum, Maximum EntityName PT1M No
Completed Messages

Count of messages completed on a Queue/Topic.
CompleteMessage Count Total (Sum) EntityName PT1M Yes
Connections Closed.

Connections Closed for Microsoft.ServiceBus.
ConnectionsClosed Count Average EntityName PT1M No
Connections Opened.

Connections Opened for Microsoft.ServiceBus.
ConnectionsOpened Count Average EntityName PT1M No
CPU (Deprecated)

Service bus premium namespace CPU usage metric. This metric is depricated. Please use the CPU metric (NamespaceCpuUsage) instead.
CPUXNS Percent Maximum Replica PT1M No
Count of dead-lettered messages in a Queue/Topic.

Count of dead-lettered messages in a Queue/Topic.
DeadletteredMessages Count Average, Minimum, Maximum EntityName PT1M No
Incoming Bytes.

Incoming Bytes for Microsoft.ServiceBus.
IncomingBytes Bytes Total (Sum) EntityName PT1M Yes
Incoming Messages

Incoming Messages for Microsoft.ServiceBus.
IncomingMessages Count Total (Sum) EntityName PT1M Yes
Incoming Requests

Incoming Requests for Microsoft.ServiceBus.
IncomingRequests Count Total (Sum) EntityName PT1M Yes
Count of messages in a Queue/Topic.

Count of messages in a Queue/Topic.
Messages Count Average, Minimum, Maximum EntityName PT1M No
CPU

Service bus premium namespace CPU usage metric.
NamespaceCpuUsage Percent Maximum Replica PT1M No
Memory Usage

Service bus premium namespace memory usage metric.
NamespaceMemoryUsage Percent Maximum Replica PT1M No
Outgoing Bytes.

Outgoing Bytes for Microsoft.ServiceBus.
OutgoingBytes Bytes Total (Sum) EntityName PT1M Yes
Outgoing Messages

Outgoing Messages for Microsoft.ServiceBus.
OutgoingMessages Count Total (Sum) EntityName PT1M Yes
Pending Checkpoint Operations Count.

Pending Checkpoint Operations Count.
PendingCheckpointOperationCount Count Total (Sum) <none> PT1M No
ReplicationLagCount

Replication lag by message count
ReplicationLagCount Count Maximum, Minimum, Average EntityName PT1M No
ReplicationLagDuration

Replication lag by time duration
ReplicationLagDuration Seconds Maximum, Minimum, Average EntityName PT1M Yes
Count of scheduled messages in a Queue/Topic.

Count of scheduled messages in a Queue/Topic.
ScheduledMessages Count Average, Minimum, Maximum EntityName PT1M No
Server Errors.

Server Errors for Microsoft.ServiceBus.
ServerErrors Count Total (Sum) EntityName, OperationResult PT1M No
Server Send Latency.

Latency of Send Message operations for Service Bus resources.
ServerSendLatency MilliSeconds Average EntityName PT1M Yes
Size

Size of an Queue/Topic in Bytes.
Size Bytes Average, Minimum, Maximum EntityName PT1M No
Successful Requests

Total successful requests for a namespace
SuccessfulRequests Count Total (Sum) EntityName, OperationResult PT1M No
Throttled Requests.

Throttled Requests for Microsoft.ServiceBus.
ThrottledRequests Count Total (Sum) EntityName, OperationResult, MessagingErrorSubCode PT1M No
User Errors.

User Errors for Microsoft.ServiceBus.
UserErrors Count Total (Sum) EntityName, OperationResult PT1M No
Memory Usage (Deprecated)

Service bus premium namespace memory usage metric. This metric is deprecated. Please use the Memory Usage (NamespaceMemoryUsage) metric instead.
WSXNS Percent Maximum Replica PT1M No

The following sections provide more detailed descriptions for metrics presented in the previous section.

Request metrics

Request metrics count the number of data and management operations requests.

Metric Description
Incoming Requests The number of requests made to the Service Bus service over a specified period.
Successful Requests The number of successful requests made to the Service Bus service over a specified period.
Server Errors The number of requests not processed because of an error in the Service Bus service over a specified period.
User Errors The number of requests not processed because of user errors over a specified period.
Throttled Requests The number of requests that were throttled because the usage was exceeded.

MessagingErrorSubCode dimension has the following possible values:

  • CPU: CPU throttling
  • Storage:It indicates throttle because of pending checkpoint operations
  • Namespace:Namespace operations throttling.
  • Unknown: Other resource throttling.
Pending Checkpoint Operations Count The number of pending checkpoint operations on the namespace. Service starts to throttle when the pending checkpoint count exceeds limit of (500,000 + (500,000 * messaging units)) operations. This metric applies only to namespaces using the premium tier.
Server Send Latency The time taken by the Service Bus service to complete the request.

The following two types of errors are classified as user errors:

  • Client-side errors (In HTTP that would be 400 errors).
  • Errors that occur while processing messages, such as MessageLockLostException.

Message metrics

The following metrics are message metrics.

Metric Description
Incoming Messages The number of events or messages sent to Service Bus over a specified period. For basic and standard tiers, incoming autoforwarded messages are included in this metric. And, for the premium tier, they aren't included.
Outgoing Messages The number of events or messages received from Service Bus over a specified period. The outgoing autoforwarded messages aren't included in this metric.
Messages Count of messages in a queue/topic. This metric includes messages in all the different states like active, dead-lettered, scheduled, etc.
Active Messages Count of active messages in a queue/topic. Active messages are the messages in the queue or subscription that are in the active state and ready for delivery. The messages are available to be received.
Dead-lettered messages Count of dead-lettered messages in a queue/topic.
Scheduled messages Count of scheduled messages in a queue/topic.
Completed Messages The number of messages completed over a specified period.
Abandoned Messages The number of messages abandoned over a specified period.
Size Size of an entity (queue or topic) in bytes.

Important

Values for messages, active, dead-lettered, scheduled, completed, and abandoned messages are point-in-time values. Incoming messages that were consumed immediately after that point-in-time might not be reflected in these metrics.

Note

When a client tries to get the info about a queue or topic, the Service Bus service returns some static information such as name, last updated time, created time, and requires session or not. Some dynamic information like message counts. If the request gets throttled, the service returns the static information and empty dynamic information. That's why message counts are shown as 0 when the namespace is being throttled. This behavior is by design.

Connection metrics

The following metrics are connection metrics.

Metric Description
Active Connections The number of active connections on a namespace and on an entity in the namespace. Value for this metric is a point-in-time value. Connections that were active immediately after that point-in-time may not be reflected in the metric.
Connections Opened The number of connections opened. Value for this metric is an aggregation, and includes all connections that were opened in the aggregation time window.
Connections Closed The number of connections closed. Value for this metric is an aggregation, and includes all connections that were opened in the aggregation time window.

Resource usage metrics

The following resource metrics are available only with the premium tier.

Metric Description
CPU usage per namespace The percentage CPU usage of the namespace.
Memory size usage per namespace The percentage memory usage of the namespace.

The important metrics to monitor for any outages for a premium tier namespace are: CPU usage per namespace and memory size per namespace. Set up alerts for these metrics using Azure Monitor.

The other metric you could monitor is: throttled requests. It shouldn't be an issue though as long as the namespace stays within its memory, CPU, and brokered connections limits. For more information, see Throttling in Azure Service Bus Premium tier

Error metrics

The following metrics are error metrics.

Metric Description
Server Errors The number of requests not processed because of an error in the Service Bus service over a specified period.
User Errors The number of requests not processed because of user errors over a specified period.

Geo-Replication metrics

The following metrics are geo-replication metrics:

Metric Description
Replication Lag Duration The offset in seconds between the latest action on the primary and the secondary regions.
Replication Lag Count The offset in number of operations between the latest action on the primary and the secondary regions.

Metric dimensions

For information about what metric dimensions are, see Multi-dimensional metrics.

This service has the following dimensions associated with its metrics.

  • EntityName Service Bus supports messaging entities under the namespace. With the Incoming Requests metric, the Entity Name dimension has a value of -NamespaceOnlyMetric- in addition to all your queues and topics. This value represents the request, which was made at the namespace level. Examples include a request to list all queues/topics under the namespace or requests to entities that failed authentication or authorization.
  • MessagingErrorSubCode
  • OperationResult
  • Replica

Note

Azure Monitor doesn't include dimensions in the exported metrics data sent to a destination like Azure Storage, Azure Event Hubs, or Azure Monitor Logs.

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.ServiceBus/Namespaces

Category Category display name Log table Supports basic log plan Supports ingestion-time transformation Example queries Costs to export
ApplicationMetricsLogs Application Metrics Logs(Unused) AzureDiagnostics

Logs from multiple Azure resources.

No No Queries Yes
DiagnosticErrorLogs Diagnostic Error Logs AzureDiagnostics

Logs from multiple Azure resources.

No No Queries Yes
OperationalLogs Operational Logs AzureDiagnostics

Logs from multiple Azure resources.

No No Queries No
RuntimeAuditLogs Runtime Audit Logs AzureDiagnostics

Logs from multiple Azure resources.

No No Queries Yes
VNetAndIPFilteringLogs VNet/IP Filtering Connection Logs AzureDiagnostics

Logs from multiple Azure resources.

No No Queries No

This section lists the types of resource logs you can collect for Azure Service Bus.

  • Operational logs
  • Virtual network and IP filtering logs
  • Runtime Audit logs

Azure Service Bus now has the capability to dispatch logs to either of two destination tables - Azure Diagnostic or Resource specific tables in Log Analytics. You could use the toggle available on Azure portal to choose destination tables.

Screenshot of dialog box to set destination table.

Operational logs

Operational log entries include elements listed in the following table:

Name Description Supported in AzureDiagnostics Supported in AZMSOperationalLogs (Resource Specific table)
ActivityId Internal ID, used to identify the specified activity Yes Yes
EventName Operation name Yes Yes
ResourceId Azure Resource Manager resource ID Yes Yes
SubscriptionId Subscription ID Yes Yes
EventtimeString Operation Time Yes No
TimeGenerated [UTC] Time of executed operation (in UTC) No Yes
EventProperties Operation properties Yes Yes
Status Operation status Yes Yes
Caller Caller of operation (the Azure portal or management client) Yes Yes
Provider Name of Service emitting the logs, such as ServiceBus No Yes
Type Type of logs emitted No Yes
Category Log Category Yes No

Here's an example of an operational log JSON string:

AzureDiagnostics:


{
  "ActivityId": "0000000000-0000-0000-0000-00000000000000",
  "EventName": "Create Queue",
  "resourceId": "/SUBSCRIPTIONS/<AZURE SUBSCRIPTION ID>/RESOURCEGROUPS/<RESOURCE GROUP NAME>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<SERVICE BUS NAMESPACE NAME>",
  "SubscriptionId": "0000000000-0000-0000-0000-00000000000000",
  "EventTimeString": "9/28/2016 8:40:06 PM +00:00",
  "EventProperties": "{\"SubscriptionId\":\"0000000000-0000-0000-0000-00000000000000\",\"Namespace\":\"mynamespace\",\"Via\":\"https://mynamespace.servicebus.windows.net/f8096791adb448579ee83d30e006a13e/?api-version=2016-07\",\"TrackingId\":\"5ee74c9e-72b5-4e98-97c4-08a62e56e221_G1\"}",
  "Status": "Succeeded",
  "Caller": "ServiceBus Client",
  "category": "OperationalLogs"
}

Resource specific table entry:


{
  "ActivityId": "0000000000-0000-0000-0000-00000000000000",
  "EventName": "Retrieve Queue",
  "resourceId": "/SUBSCRIPTIONS/<AZURE SUBSCRIPTION ID>/RESOURCEGROUPS/<RESOURCE GROUP NAME>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<SERVICE BUS NAMESPACE NAME>",
  "SubscriptionId": "0000000000-0000-0000-0000-00000000000000",
  "TimeGenerated(UTC)": "9/28/2023 8:40:06 PM +00:00",
  "EventProperties": "{\"SubscriptionId\":\"0000000000-0000-0000-0000-00000000000000\",\"Namespace\":\"mynamespace\",\"Via\":\"https://mynamespace.servicebus.windows.net/f8096791adb448579ee83d30e006a13e/?api-version=2016-07\",\"TrackingId\":\"5ee74c9e-72b5-4e98-97c4-08a62e56e221_G1\"}",
  "Status": "Succeeded",
  "Caller": "ServiceBus Client",
  "type": "AZMSOperationalLogs",
  "Provider" : "SERVICEBUS"
}

Events and operations captured in operational logs

Operational logs capture all management operations that are performed on the Azure Service Bus namespace. Data operations aren't captured, because of the high volume of data operations that are conducted on Azure Service Bus.

Note

To help you better track data operations, we recommend using client-side tracing.

The following management operations are captured in operational logs:

Scope Operation
Namespace - Create Namespace
- Update Namespace
- Delete Namespace
- Update Namespace
- Retrieve Namespace
- SharedAccess Policy
Queue - Create Queue
- Update Queue
- Delete Queue
- AutoDelete Delete Queue
- Retrieve Queue
Topic - Create Topic
- Update Topic
- Delete Topic
- AutoDelete Delete Topic
- Retrieve Topic
Subscription - Create Subscription
- Update Subscription
- Delete Subscription
- AutoDelete Delete Subscription
- Retrieve Subscription

Note

Currently, Read operations aren't tracked in the operational logs.

Virtual network and IP filtering logs

Service Bus virtual network connection event JSON includes elements listed in the following table:

Name Description Supported in Azure Diagnostics Supported in AZMSVnetConnectionEvents (Resource specific table)
SubscriptionId Azure subscription ID Yes Yes
NamespaceName Namespace name Yes Yes
IPAddress IP address of a client connecting to the Service Bus service Yes Yes
AddressIP IP address of client connecting to service bus Yes Yes
TimeGenerated [UTC] Time of executed operation (in UTC) Yes Yes
Action Action done by the Service Bus service when evaluating connection requests. Supported actions are Accept Connection and Deny Connection. Yes Yes
Reason Provides a reason why the action was done Yes Yes
Count Number of occurrences for the given action Yes Yes
ResourceId Azure Resource Manager resource ID. Yes Yes
Category Log Category Yes No
Provider Name of Service emitting the logs such as ServiceBus No Yes
Type Type of Logs Emitted No Yes

Note

Virtual network logs are generated only if the namespace allows access from selected networks or from specific IP addresses (IP filter rules).

Here's an example of a virtual network log JSON string:

AzureDiagnostics:

{
    "SubscriptionId": "0000000-0000-0000-0000-000000000000",
    "NamespaceName": "namespace-name",
    "IPAddress": "1.2.3.4",
    "Action": "Accept Connection",
    "Reason": "IP is accepted by IPAddress filter.",
    "Count": 1,
    "ResourceId": "/SUBSCRIPTIONS/<AZURE SUBSCRIPTION ID>/RESOURCEGROUPS/<RESOURCE GROUP NAME>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<SERVICE BUS NAMESPACE NAME>",
    "Category": "ServiceBusVNetConnectionEvent"
}

Resource specific table entry:

{
  "SubscriptionId": "0000000-0000-0000-0000-000000000000",
  "NamespaceName": "namespace-name",
  "AddressIp": "1.2.3.4",
  "Action": "Accept Connection",
  "Message": "IP is accepted by IPAddress filter.",
  "Count": 1,
  "ResourceId": "/SUBSCRIPTIONS/<AZURE SUBSCRIPTION ID>/RESOURCEGROUPS/<RESOURCE GROUP NAME>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<SERVICE BUS NAMESPACE NAME>",
  "Provider" : "SERVICEBUS",
  "Type": "AZMSVNetConnectionEvents"
}

Runtime audit logs

Runtime audit logs capture aggregated diagnostic information for various data plane access operations (such as send or receive messages) in Service Bus.

Note

Runtime audit logs are currently available only in the premium tier.

Runtime audit logs include the elements listed in the following table:

Name Description Supported in Azure Diagnostics Supported in AZMSRuntimeAuditLogs (Resource specific table)
ActivityId A randomly generated UUID that ensures uniqueness for the audit activity. Yes Yes
ActivityName Runtime operation name. Yes Yes
ResourceId Resource associated with the activity. Yes Yes
Timestamp Aggregation time. Yes No
time Generated (UTC) Aggregated time No Yes
Status Status of the activity (success or failure). Yes Yes
Protocol Type of the protocol associated with the operation. Yes Yes
AuthType Type of authentication (Microsoft Entra ID or SAS Policy). Yes Yes
AuthKey Microsoft Entra application ID or SAS policy name that's used to authenticate to a resource. Yes Yes
NetworkType Type of the network access: Public orPrivate. yes Yes
ClientIP IP address of the client application. Yes Yes
Count Total number of operations performed during the aggregated period of 1 minute. Yes Yes
Properties Metadata that is specific to the data plane operation. yes Yes
Category Log category Yes No
Provider Name of Service emitting the logs, such as ServiceBus No Yes
Type Type of Logs emitted No Yes

Here's an example of a runtime audit log entry:

AzureDiagnostics:

{
  "ActivityId": "<activity id>",
  "ActivityName": "ConnectionOpen | Authorization | SendMessage | ReceiveMessage | PeekLockMessage",
  "ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<Service Bus namespace>/servicebus/<service bus name>",
  "Time": "1/1/2021 8:40:06 PM +00:00",
  "Status": "Success | Failure",
  "Protocol": "AMQP | HTTP | SBMP", 
  "AuthType": "SAS | AAD", 
  "AuthKey": "<AAD Application Name| SAS policy name>",
  "NetworkType": "Public | Private", 
  "ClientIp": "x.x.x.x",
  "Count": 1, 
  "Category": "RuntimeAuditLogs"
}

Resource specific table entry:

{
  "ActivityId": "<activity id>",
  "ActivityName": "ConnectionOpen | Authorization | SendMessage | ReceiveMessage | PeekLockMessage",
  "ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<Service Bus namespace>/servicebus/<service bus name>",
  "TimeGenerated (UTC)": "1/1/2021 8:40:06 PM +00:00",
  "Status": "Success | Failure",
  "Protocol": "AMQP | HTTP | SBMP", 
  "AuthType": "SAS | AAD", 
  "AuthKey": "<AAD Application Name| SAS policy name>",
  "NetworkType": "Public | Private", 
  "ClientIp": "x.x.x.x",
  "Count": 1, 
  "Provider": "SERVICEBUS",
  "Type"   : "AZMSRuntimeAuditLogs"
}

Diagnostic Error Logs

Diagnostic error logs capture error messages for any client side, throttling, and Quota exceeded errors. They provide detailed diagnostics for error identification.

Diagnostic Error Logs include elements listed in this table:

Name Description Supported in Azure Diagnostics Supported in AZMSDiagnosticErrorLogs (Resource specific table)
ActivityId A randomly generated UUID that ensures uniqueness for the audit activity. Yes Yes
ActivityName Operation name Yes Yes
NamespaceName Name of Namespace Yes yes
EntityType Type of Entity Yes Yes
EntityName Name of Entity Yes Yes
OperationResult Type of error in Operation (Clienterror or Serverbusy or quotaexceeded) Yes Yes
ErrorCount Count of identical errors during the aggregation period of 1 minute. Yes Yes
ErrorMessage Detailed Error Message Yes Yes
Provider Name of Service emitting the logs. Possible values: eventhub, relay, and servicebus Yes Yes
Time Generated (UTC) Operation time No Yes
EventTimestamp Operation Time Yes No
Category Log category Yes No
Type Type of Logs emitted No Yes

Here's an example of Diagnostic error log entry:

{
  "ActivityId": "0000000000-0000-0000-0000-00000000000000",
  "SubscriptionId": "<Azure Subscription Id",
  "NamespaceName": "Name of Service Bus Namespace",
  "EntityType": "Queue",
  "EntityName": "Name of Service Bus Queue",
  "ActivityName": "SendMessage",
  "ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<service bus namespace name>",,
  "OperationResult": "ClientError",
  "ErrorCount": 1,
  "EventTimestamp": "3/27/2024 1:02:29.126 PM +00:00",
  "ErrorMessage": "the sessionid was not set on a message, and it cannot be sent to the entity. entities that have session support enabled can only receive messages that have the sessionid set to a valid value.",
  "category": "DiagnosticErrorLogs"
}

Resource specific table entry:

{
  "ActivityId": "0000000000-0000-0000-0000-00000000000000",
  "NamespaceName": "Name of Service Bus Namespace",
  "EntityType": "Queue",
  "EntityName": "Name of Service Bus Queue",
  "ActivityName": "SendMessage",
  "ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<service bus namespace name>",,
  "OperationResult": "ClientError",
  "ErrorCount": 1,
  "TimeGenerated [UTC]": "1/27/2024 4:02:29.126 PM +00:00",
  "ErrorMessage": "the sessionid was not set on a message, and it cannot be sent to the entity. entities that have session support enabled can only receive messages that have the sessionid set to a valid value.",
  "Type": "AZMSDiagnosticErrorLogs"
}

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.

On 30 September 2026, we'll retire support of the SBMP protocol for Azure Service Bus, so you'll no longer be able to use this protocol after 30 September 2026. Migrate to the latest Azure Service Bus SDK libraries using the AMQP protocol, which offer critical security updates and improved capabilities, before that date.

For more information, see the support retirement announcement.

Azure Service Bus uses Kusto tables from Azure Monitor Logs. You can query these tables with Log Analytics.

Service Bus Microsoft.ServiceBus/namespaces

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.