Skip to main content

Azure Event Hubs Source


Collecting data from Azure Event Hubs using this Cloud-to-Cloud collection method has a supported throughput limit of 1MB/S (86GB/day) for a named Event Hub egress rate. We recommend using the Azure Event Hubs Source for Logs if you require higher throughput.


This cloud-to-cloud Azure Event Hubs Source provides a secure endpoint to receive data from Azure Event Hubs. It securely stores the required authentication, scheduling, and state tracking information.


This source is available in all deployments, including the Fed deployment.

Data collected

Polling IntervalData
5 minResource Logs
5 minActivity Logs

Third party apps or services can be configured to send event data to Event Hubs as well, including Auth0.


Vendor configuration

The Event Hub doesn't have to be in the same subscription as the resource sending logs if the user who configures the setting has appropriate Azure role-based access control access to both subscriptions. By using Azure Lighthouse, it's also possible to have diagnostic settings sent to a event hub in another Azure Active Directory tenant. The event hub namespace needs to be in the same region as the resource being monitored if the resource is regional so you may have to configure multiple Azure Event Hubs Sources. More details about destination limitations and permissions are described here.

  1. Create an Event Hub using the Azure portal by navigating to Event Hubs in the Azure Portal.
  2. Create an Event Hubs namespace. In this example, Namespace is set to cnctest:
  3. Create an Event Hub Instance.
    • Shared Access Policies can be set up for the entire namespace. These policies can be used to access/manage all hubs in the namespace. A policy for the namespace is created by default: RootManageSharedAccessKey
      In this example, Event Hub Instance is set to my-hub.
  4. Create a Shared Access Policy with the Listen claim to the newly created Event Hub Instance:
    In this example, Event Hub Instance is set to SumoCollectionPolicy.
  5. Copy the Shared Access Policy Key.
    AzureEventHubstep9.png Copy the Primary/Secondary key associated with this policy.
  6. When configuring the Azure Event Hubs Source in Sumo Logic, our input fields might be:
Azure Event Hubs
Event Hubs Instance Namemy-hub
Shared Access Policy NameSumoCollectionPolicy
Shared Access Policy Key
(use primary key)


Source configuration

When you create an Azure Event Hubs Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure an Azure Event Hubs Source:

  1. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
  2. On the Collectors page, click Add Source next to a HostedCollector.
  3. Search for and select Azure Event Hubs.
  4. Enter a Name for the Source. The description is optional.
  5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  6. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM.
  7. (Optional) Fields. Click the +Add Field link to define the fields you want to associate, each field needs a name (key) and value.
    • green check circle.png A green circle with a check mark is shown when the field exists in the Fields table schema.
    • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema it is ignored, known as dropped.
  8. Azure Event Hubs Namespace. Enter your Azure Event Hubs Namespace name. 
  9. Event Hubs Instance Name. Enter the Azure Event Hubs Instance Name.
  10. Shared Access Policy. Enter your Shared Access Policy Name and Key. The Shared Access Policy requires the Listen claim.
  11. Consumer Group Name. If needed, specify a custom consumer group name. When using a custom Consumer Group make sure that it exists for the Event Hub instance.
  12. Receive data with latest offset or from timestamp. Choose one of the following options:
    • Latest offset (default) - this will start the receiver with the latest offset and collect any new logs received to the Event Hub moving forward.
    • Timestamp - use this option to start receiving logs from a specific point in time in the event stream. Timestamp can be used to ingest historical data. Once all historical data has been ingested it is recommended to switch to Latest offset. This will ensure the Collector continues from the latest recorded checkpoint when restarted and not use the Timestamp specified as a starting point, which could result in logs being received and processed more than once.  
  13. Processing Rules for Logs. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
  14. Advanced Options for Logs.
    • Timestamp Parsing. This option is selected by default. If it's deselected, no timestamp information is parsed at all.
    • Time Zone. There are two options for Time Zone. You can use the time zone present in your log files, and then choose an option in case time zone information is missing from a log message. Or, you can have Sumo Logic completely disregard any time zone information present in logs by forcing a time zone. It's very important to have the proper time zone set, no matter which option you choose. If the time zone of logs cannot be determined, Sumo Logic assigns logs UTC; if the rest of your logs are from another time zone your search results will be affected.
    • Timestamp Format. By default, Sumo Logic will automatically detect the timestamp format of your logs. However, you can manually specify a timestamp format for a Source. See Timestamps, Time Zones, Time Ranges, and Date Formats for more information.  
  15. When you are finished configuring the Source, click Submit.

Metadata fields

_siemDataTypeInventorySet when Forward To SIEM is checked.
_siemProductAzureSet when Forward To SIEM is checked.
_siemVendorMicrosoftSet when Forward To SIEM is checked.
_siemFormatJSONSet when Forward To SIEM is checked.
_siemEventID<metadata.eventType>Where metadata.eventType is populated from the field in the event JSON, such as Administrative or Resource Health. See more information about the available event types for the Azure platform in Activity Log Categories and Resource Log Categories. Logs that do not contain a category field are assigned category UNKNOWN.

JSON schema

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

schemaRefJSON Object{"type":"Azure Event Hubs"}YesDefine the specific schema type.
sourceTypeString"Universal"YesType of source.
configJSON ObjectConfiguration objectYesSource type specific values.

Configuration Object

nameStringYesnullType a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source."mySource"
descriptionStringNonullType a description of the source."Testing source"
categoryStringNonullType a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details."mySource/test"
fieldsJSON ObjectNonullJSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.{"_siemForward": false, "fieldA": "valueA"}
namespaceStringYesnullYour Azure Event Hubs Namespace name.
hub_nameStringYesnullThe Azure Event Hubs Instance Name.
access_policy_nameStringYesnullYour Shared Access Policy Name. The Shared Access Policy requires the Listen claim.
access_policy_keyStringYesnullYour Shared Access Policy Key. The Shared Access Policy requires the Listen claim.
consumer_groupStringYes$DefaultIf needed, specify a custom consumer group name. When using a custom Consumer Group make sure that it exists for the Event Hub instance.
receive_with_latest_offsetBooleanYesTrueReceive data with the latest offset or from the timestamp.
receive_from_timestampBooleanNonullSet to true when receive_with_latest_offset is false.
timeZoneStringNonullType the time zone you'd like the source to use in TZ database format."America/Los_Angeles". See time zone format for details.
forceTimeZoneBooleanNofalseType true to force the Source to use a specific time zone, otherwise type false to use the time zone found in the logs. The default setting is false.
automaticDateParsingBooleanNotrueDetermines if timestamp information is parsed or not. Type true to enable automatic parsing of dates (the default setting); type false to disable. If disabled, no timestamp information is parsed at all.
autoParseTimeFormatBooleanNotrueSets if the timestamp format is automatically detected by Sumo Logic. If autoParseTimeFormat is set to false, then defaultDateFormats must be specified.
defaultDateFormatsarrayNonullDefine formats for the dates present in your log messages. You can specify a locator regex to identify where timestamps appear in log lines.
The defaultDateFormats object has two elements:
format (required)—Specify the date format.
locator (optional)—A regular expression that specifies the location of the timestamp in your log lines.
For example, INFO(.*)
For an example, see Timestamp example.
For more information about timestamp options, see Timestamps, Time Zones, Time Ranges, and Date Formats.

JSON example

"api.version": "v1",
"source": {
"schemaRef": {
"type": "Azure Event Hubs"
"config": {
"name": "Azure Event Hubs",
"description": "East field",
"namespace": "namespace",
"hub_name": "hub name",
"access_policy_name": "policyName",
"access_policy_key": "********",
"consumer_group": "groupName",
"fields": {
"_siemForward": false
"category": "eastTeamF",
"receive_with_latest_offset": true,
"automaticDateParsing": true,
"autoParseTimeFormat": false,
"defaultDateFormats": [{
"format": "dd-MM-yyyy",
"locator": "INFO(.*)"
"sourceType": "Universal"

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "azure_event_hubs_source" {
collector_id =
schema_ref = {
type = "Azure Event Hubs"
config = jsonencode({
"name": "Azure Event Hubs",
"description": "East field",
"namespace": "namespace",
"hub_name": "hub name",
"access_policy_name": "policyName",
"access_policy_key": "********",
"consumer_group": "groupName",
"fields": {
"_siemForward": false
"category": "eastTeamF",
"receive_with_latest_offset": true,
"automaticDateParsing": true,
"autoParseTimeFormat": false,
"defaultDateFormats": [{
"format": "dd-MM-yyyy",
"locator": "INFO(.*)"
resource "sumologic_collector" "collector" {
name = "my-collector"
description = "Just testing this"

Download example



Click here for more information about Cloud-to-Cloud sources.

Privacy Statement
Terms of Use

Copyright © 2024 by Sumo Logic, Inc.