Azure Service Bus

Azure Service Bus is a fully managed enterprise message broker with message queues and publish-subscribe topics (in a namespace) used for decoupling applications and services from each other. This integration helps in monitoring incoming/outgoing messages, connections, throttled requests, and resource usage of your Service Bus namespace.

Log and metric types

For Azure Service Bus, you can collect the following logs and metrics:

• Operational Logs. To learn more about the resource log schema for Azure Service Bus, refer to the Azure documentation.
• VNet And IP Filtering Logs. To learn more about the resource log schema for Azure Service Bus, refer to the Azure documentation.
• Runtime Audit Logs. To learn more about the resource log schema for Azure Service Bus, refer to the Azure documentation.
• Diagnostic Error Logs. To learn more about the resource log schema for Azure Service Bus, refer to the Azure documentation.
• Platform Metrics for Azure Service Bus. These metrics are available in Microsoft.ServiceBus/namespaces namespace. For more information on supported metrics and dimensions, refer to the Azure documentation.

Setup

Azure service sends monitoring data to Azure Monitor, which can then stream data to Eventhub. Sumo Logic supports:

• Logs collection from Azure Monitor using our Azure Event Hubs source.
• Metrics collection using our HTTP Logs and Metrics source via Azure Functions deployed using the ARM template.

You must explicitly enable diagnostic settings for each Azure Service Bus namespace you want to monitor. You can forward logs to the same Event Hub provided they satisfy the limitations and permissions as described here.

When you configure the Event Hubs source or HTTP source, plan your source category to ease the querying process. A hierarchical approach allows you to make use of wildcards. For example: Azure/ServiceBus/Logs, Azure/ServiceBus/Metrics.

Configure field in field schema

1. Classic UI. In the main Sumo Logic menu, select Manage Data > Logs > Fields.
   New UI. In the top menu select Configuration, and then under Logs select Fields. You can also click the Go To... menu at the top of the screen and select Fields.
2. Search for the following fields:
   • tenant_name. This field is tagged at the collector level. You can get the tenant name using the instructions here.
   • location. The region to which the resource name belongs to.
   • subscription_id. ID associated with a subscription where the resource is present.
   • resource_group. The resource group name where the Azure resource is present.
   • provider_name. Azure resource provider name (for example, Microsoft.Network).
   • resource_type. Azure resource type (for example, storage accounts).
   • resource_name. The name of the resource (for example, storage account name).
   • service_type. Type of the service that can be accessed with a Azure resource.
   • service_name. Services that can be accessed with an Azure resource (for example, in Azure Service Bus service is Subscriptions).
3. Create the fields if they are not present. Refer to Manage fields.

Configure field extraction rules

Create the following Field Extraction Rule(s) (FER) for Azure Storage by following the instructions in Create a Field Extraction Rule.

Azure location extraction FER

Rule Name: AzureLocationExtractionFER
Applied at: Ingest Time
Scope (Specific Data): tenant_name=*

Parse Expression

json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
| if (!isBlank(resourceLocation), resourceLocation, location) as location
| if (!isBlank(service_region), service_region, location) as location 
| if (isBlank(location), "global", location) as location
| fields location

Resource ID extraction FER

Rule Name: AzureResourceIdExtractionFER
Applied at: Ingest Time
Scope (Specific Data): tenant_name=*

Parse Expression

json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
| toUpperCase(resourceId) as resourceId
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name

Configure metric rules

Create the following metrics rules by following the instructions in Create a metrics rule.

Azure observability metadata extraction service level

If this rule already exists, there is no need to create it again.

Rule Name: AzureObservabilityMetadataExtractionServiceLevel    

Metric match expression

resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/*/*/*/* tenant_name=*

Fields extracted	Metric rule
subscription_id	$resourceId._1
resource_group	$resourceId._2
provider_name	$resourceId._3
resource_type	$resourceId._4
resource_name	$resourceId._5
service_type	$resourceId._6
service_name	$resourceId._7

Azure observability metadata extraction service bus level

Rule Name: AzureObservabilityMetadataExtractionAzureServiceBusLevel

Metric match expression

resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/* tenant_name=*

Fields extracted	Metric rule
subscription_id	$resourceId._1
resource_group	$resourceId._2
provider_name	MICROSOFT.SERVICEBUS
resource_type	NAMESPACES
resource_name	$resourceId._3

Configure metrics collection

In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, on to an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.

1. Configure an HTTP Source.
2. Configure and deploy the ARM Template.
3. Export metrics to Event Hub. Perform below steps for each Azure Service Bus namespace that you want to monitor.
   • Choose Stream to an event hub as destination.
   • Select AllMetrics.
   • Use the Event Hub namespace created by the ARM template in Step 2 above. You can create a new Event Hub or use the one created by ARM template. You can use the default policy RootManageSharedAccessKey as the policy name.
     
   • Tag the location and entityname fields in the source with right values.
     

Configure logs collection

In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.

Diagnostic logs

1. To set up the Azure Event Hubs source in Sumo Logic, refer to Azure Event Hubs Source for Logs.
2. To create the Diagnostic settings in Azure portal, refer to the Azure documentation. Perform below steps for each Azure Service Bus namespace that you want to monitor.
   1. Choose Stream to an event hub as the destination.
   2. Select allLogs.
   3. Use the Event Hub namespace and Event Hub name configured in previous step in destination details section. You can use the default policy RootManageSharedAccessKey as the policy name.
   4. Use the Event Hub namespace and Event Hub name configured in the previous step in the destination details section. You can use the default policy RootManageSharedAccessKey as the policy name.
      
3. Tag the location field in the source with right location value.
   

Activity Logs

To collect activity logs, follow the instructions here. Do not perform this step in case you are already collecting activity logs for a subscription.

note

Since this source contains logs from multiple regions, make sure that you do not tag this source with the location tag.

Viewing the Azure Service Bus dashboards

All dashboards have a set of filters that you can apply to the entire dashboard. Use these filters to drill down and examine the data to a granular level.

• You can change the time range for a dashboard or panel by selecting a predefined interval from a drop-down list, choosing a recently used time range, or specifying custom dates and times. Learn more.
• You can use template variables to drill down and examine the data on a granular level. For more information, see Filtering Dashboards with Template Variables.
• Most Next-Gen apps allow you to provide the scope at the installation time and are comprised of a key (_sourceCategory by default) and a default value for this key. Based on your input, the app dashboards will be parameterized with a dashboard variable, allowing you to change the dataset queried by all panels. This eliminates the need to create multiple copies of the same dashboard with different queries.

Overview

The Azure Service Bus - Overview provides details on the overall performance and usage of your Azure Service Bus namespaces.

Use this dashboard to:

• Monitor namespace resource utilization like CPU and memory usage across different locations.
• Track message processing trends by analyzing incoming vs outgoing message differences, total errors and Average Server Send Latency over time.

Administrative Operations

The Azure Service Bus - Administrative Operations provides an overview of management activities performed on your Azure Service Bus namespaces.

Use this dashboard to:

• Monitor the distribution of read, write, and delete operations across your service bus namespaces.
• Identify and investigate errors occurring during administrative operations to maintain optimal service bus configuration.

Errors

The Azure Service Bus - Errors provides details on various error types, failed operations, and error messages related to Azure Service Bus.

Use this dashboard to:

• Identify and troubleshoot common error patterns by analyzing the trend of user errors and server errors.
• Monitor message processing issues by tracking dead-lettered and abandoned messages over time.

Messages

The Azure Service Bus - Messages provides a detailed view of message flow and status within your Azure Service Bus namespaces.

Use this dashboard to:

• Monitor the volume and status of messages across different categories like active, completed, and abandoned messages.
• Identify potential bottlenecks by comparing incoming and outgoing message rates.

Policy and Recommendation

The Azure Service Bus - Policy and Recommendation provides information on policy enforcement and recommendations for your Azure Service Bus namespaces.

Use this dashboard to:

• Review policy success and failure events to ensure proper policy enforcement and security.
• Identify recommendations to improve the performance and security of your Service Bus instances.

Traffic

The Azure Service Bus - Traffic provides insights into the network traffic and connections of your Azure Service Bus namespaces.

Use this dashboard to:

• Track active connections and analyze connection patterns over time.
• Monitor server send latency and identify any performance issues affecting message delivery.

Upgrade/Downgrade the Azure Service Bus app (optional)

To update the app, do the following:

1. Select App Catalog.
2. In the Search Apps field, search for and then select your app.
   Optionally, you can identify apps that can be upgraded in the Upgrade available section.
3. To upgrade the app, select Upgrade from the Manage dropdown.
   1. If the upgrade does not have any configuration or property changes, you will be redirected to the Preview & Done section.
   2. If the upgrade has any configuration or property changes, you will be redirected to Setup Data page.
      1. In the Configure section of your respective app, complete the following fields.
         • Key. Select either of these options for the data source.
           • Choose Source Category and select a source category from the list for Default Value.
           • Choose Custom and enter a custom metadata field. Insert its value in Default Value.
      2. Click Next. You will be redirected to the Preview & Done section.

Post-update

Your upgraded app will be installed in the Installed Apps folder, and dashboard panels will start to fill automatically.

note

See our Release Notes changelog for new updates in the app.

To revert the app to a previous version, do the following:

1. Select App Catalog.
2. In the Search Apps field, search for and then select your app.
3. To version down the app, select Revert to < previous version of your app > from the Manage dropdown.

Uninstalling the Azure Service Bus app (optional)

To uninstall the app, do the following:

1. Select App Catalog.
2. In the 🔎 Search Apps field, run a search for your desired app, then select it.
3. Click Uninstall.

Troubleshooting

HTTP Logs and Metrics Source used by Azure Functions

To troubleshoot metrics collection, follow the instructions in Collect Metrics from Azure Monitor > Troubleshooting metrics collection.