Azure Event Hubs

Azure Event Hubs is a modern big data streaming platform and event ingestion service that can seamlessly integrate with other Azure and Microsoft services, such as Stream Analytics, Power BI, and Event Grid, along with outside services like Apache Spark. This integration helps in monitoring data plane access operations (such as send or receive events), and tracking performance metrics like consumer lag, consumer and publisher throughput, and active connections in your Event Hub.

Log and metric types

For Azure Event Hubs, you can collect the following logs and metrics:

• Resource logs. To learn more about the different resource log category types and schemas collected for Azure Event Hubs, refer to Azure documentation.

info

Some log types are only available in premium and dedicated tiers.

• Platform Metrics for Azure Event Hubs. These metrics are available in the namespaces below:
  • Microsoft.EventHub/clusters
  • Microsoft.EventHub/namespaces

For more information on supported metrics, refer to 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 Azure Metrics Source.

You must explicitly enable diagnostic settings for each Event Hub 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/EventHub/Logs, Azure/EventHub/Metrics.

Configure metrics collection

To set up the Azure Metrics source in Sumo Logic, refer to Azure Metrics Source.

note

The Sumo Logic Metrics source is currently in beta. To participate, contact your Sumo Logic account executive.

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 the Azure Event Hubs Source for Logs.
2. To create the diagnostic settings in Azure portal, refer to the Azure documentation. Perform the steps below for each Azure Event Hubs 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 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 the right location value.
   

Activity Logs

To collect activity logs, refer to the Collecting Logs for the Azure Audit App from Event Hub section in the Azure Audit documentation. 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.

Installing the Azure Event Hubs app

To install the app, do the following:

note

Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, and Manage Collectors capabilities depending upon the different content types part of the app.

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

   Sometimes this button says Add Integration.

4. Click Next in the Setup Data section.
5. In the Configure App section of your respective app, complete the following field.
   1. Index. Specify value for _index if the collection is configured with custom partition. Learn more. Default value is set to sumologic_default (default partition)
6. Click Next. You will be redirected to the Preview & Done section.

Post-installation

Once your app is installed, it will appear in your Installed Apps folder, and dashboard panels will start to fill automatically.

Each panel slowly fills with data matching the time range query received since the panel was created. Results will not immediately be available but will be updated with full graphs and charts over time.

As part of the app installation process, the following fields will be created by default:

• tenant_name. This field is tagged at the collector level. You can get the tenant name using the instructions here.
• location. The region 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 an Azure resource.
• service_name. Services that can be accessed with an Azure resource. (For example, in Azure Container Instances the service is Subscriptions.)

Viewing the Azure Event Hubs 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.
• Many of the Next-Gen apps allow you to provide the Index at the installation time and a default value for this key (sumologic_default). Based on your input, the app dashboards will be parameterized with a dashboard variable, allowing you to change the data partition queried by all panels. This restricts the query scope of all the dashboard queries to a specific data partition.

Overview

The Azure Event Hubs - Overview dashboard provides comprehensive details on Eventhubs and details such as overall number of requests, namespaces and instances, size by eventhubs, operation types, ingress and egress of data

Operations

The Azure Event Hubs - Operations dashboard provides details over the recent create, read, delete or update operations done by the event hubs.

Performance

The Azure Event Hubs - Performance dashboard provides insights into the performance of your Azure Event Hubs. This includes metrics on Replication lag and count, cluster CPU usage and memory usage.

Network

The Azure Event Hubs - Network dashboard provides details on network traffic and connectivity related to your Azure Event Hubs. This includes data on inbound and outbound traffic in bytes and message, connections and requests.

Kafka Overview

The Azure Event Hubs - Kafka Overview dashboard provides details on Kafka Coordinator events based on different operations count, Kafka Coordinator operations based on namespaces and clients, last 10 log messages and heartbeat events.

Kafka Errors

The Azure Event Hubs - Kafka Errors dashboard provides information about Kafka related errors in Event Hubs including error count, errors by object and error messages, error by namespaces and last 10 Kafka error messages

Errors

The Azure Event Hubs - Errors dashboard provides information about errors in Event Hubs including user errors, diagnostic errors, operation errors, top 10 error numbers and error messages, error trend and comparison analyses by types of activity, operation result and entity.

Audit

The Azure Event Hubs - Audit dashboard provides audit information on namespace level events, and cluster level events such as audit failures, auth failures, auth protocols, status and connections.

Administrative Operations

The Azure Event Hubs - Administrative Operations dashboard provides details on the operational activities and status of your Azure Event Hubs resources.

Use this dashboard to:

• Monitor the distribution of operation types and their success rates to ensure proper functioning of your Event Hubs.
• Identify potential issues by analyzing the top operations causing errors and correlating them with specific users or applications.
• Track recent write and delete operations to maintain an audit trail of changes made to your Event Hubs.

Policy and Recommendations

The Azure Event Hubs - Policy and Recommendations dashboard provides details on policy events and recommendations for your Azure Event Hubs resources.

Use this dashboard to:

• Monitor the success and failure rates of policy events to ensure proper configuration and compliance.
• Track and analyse recent recommendations to improve the performance and security of your Event Hubs setup.
• Identify trends in policy events and recommendations over time to proactively address potential issues.

Create monitors for Azure Event Hubs

From your App Catalog:

1. From the Sumo Logic navigation, select App Catalog.
2. In the Search Apps field, search for and then select your app.
3. Make sure the app is installed.
4. Navigate to What's Included tab and scroll down to the Monitors section.
5. Click Create next to the pre-configured monitors. In the create monitors window, adjust the trigger conditions and notifications settings based on your requirements.
6. Scroll down to Monitor Details.
7. Under Location click on New Folder.
   note

   By default, monitor will be saved in the root folder. So to make the maintenance easier, create a new folder in the location of your choice.

8. Enter Folder Name. Folder Description is optional.
   tip

   Using app version in the folder name will be helpful to determine the versioning for future updates.

9. Click Create. Once the folder is created, click on Save.

Azure Event Hubs alerts

These alerts are metric based and will work for all Azure Storage.

Alert Name	Alert Description and Conditions	Alert Condition	Recover Condition
Azure Event Hubs - Available Memory (Cluster Only)	This alert is triggered when Average Available Memory Percentage is less than 10% and a warning alert is triggered at 20% available memory.	Count < 10	Count > = 10
Azure Event Hubs - CPU Usage (Cluster Only)	This alert is triggered when Average CPU Usage is greater than 80% and a warning alert is triggered at 70% CPU usage.	Count > 80	Count < = 80
Azure Event Hubs - Incoming Messages	This alert is triggered when Total Incoming Messages Count is greater than 1000.	Count > 1000	Count < = 1000
Azure Event Hubs - Server Errors	This alert is triggered when Total Server Errors Count is greater than 1.	Count > 1	Count < = 1
Azure Event Hubs - Throttled Requests	This alert is triggered when Total Throttled Requests Count is greater than 1.	Count > 1	Count < = 1
Azure Event Hubs - User Errors	This alert is triggered when Total User Errors Count is greater than 1.	Count > 1	Count < = 1

Upgrade/Downgrade the Azure Event Hubs app (optional)

To update the app, do the following:

note

Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, and Manage Collectors capabilities depending upon the different content types part of the app.

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 the Setup Data page.
   3. In the Configure section of your respective app, complete the following fields.
      1. Field Name. If you already have collectors and sources set up, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata Field Value.
   4. 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 Event Hubs 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.