Skip to main content
Sumo Logic

Azure Event Hubs Source

The 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.

The Azure platform can be configured to export logs to one or more Event Hub destinations. Platform logs include:

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

Prerequisites

  1. Create an Event Hub using the Azure portal.
  2. Create a Shared Access Policy with the Listen claim.

States

An Azure Event Hubs Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.

An Azure Event Hubs Source goes through the following states when created:

  1. Pending: Once the Source is submitted it is validated, stored, and placed in a Pending state.
  2. Started: A collection task is created on the Hosted Collector.
  3. Initialized: The task configuration is complete in Sumo Logic.
  4. Authenticated: The Source successfully authenticated with Azure Event Hubs.
  5. Collecting: The Source is actively collecting data from Azure Event Hubs.

If the Source has any issues during any one of these states it is placed in an Error state.

When you delete the Source it is placed in a Stopping state, when it has successfully stopped it is deleted from your Hosted Collector.

On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection.

Azure Event Hubs error.png

Hover your mouse over the status icon to view a tooltip with details on the detected issue.

health error generic.png

Create an Azure Event Hubs Source

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 Sumo Logic web app, select Manage Data > Collection > Collection
  1. On the Collectors page, click Add Source next to a Hosted Collector.
  1. Select Azure Event Hubs.
    Azure Event Hubs Icon.png
  1. Enter a Name for the Source. The description is optional.
    Azure Event Hubs input pane.png
  1. (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.
  2. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise. When configured with the Forward to SIEM option the following metadata fields are set:
Field Name Value
_siemVendor Microsoft
_siemProduct Azure
_siemFormat JSON
_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.
  1. Fields. Click the +Add link to add custom log metadata Fields.
    • 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 and is enabled in the Fields table schema.
      • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable 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 or is disabled it is ignored, known as dropped. 
  2. Azure Event Hubs Namespace. Enter your Azure Event Hubs Namespace name.

  3. Event Hubs Instance Name. Enter the Azure Event Hubs Instance Name.

  4. Shared Access Policy. Enter your Shared Access Policy Name and Key. The Shared Access Policy requires the Listen claim.

  5. 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.

  6. 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.
  7. When you are finished configuring the Source click Submit.

Error types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.

Type Reason Retries Retry Behavior Health Event Name
ThirdPartyConfig Normally due to an invalid configuration. You'll need to review your Source configuration and make an update. No retries are attempted until the Source is updated. Not applicable ThirdPartyConfigError
ThirdPartyGeneric Normally due to an error communicating with the third party service APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. ThirdPartyGenericError
FirstPartyGeneric Normally due to an error communicating with the internal Sumo Logic APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. FirstPartyGenericError

JSON configuration

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. 

Parameter Type Required Description Access
config JSON Object Yes Contains the configuration parameters for the Source.  
schemaRef JSON Object Yes Use {"type":"Azure Event Hubs"} for an Azure Event Hubs Source. not modifiable
sourceType String Yes Use Universal for an Azure Event Hubs Source. not modifiable

The following table shows the config parameters are for an Azure Event Hubs Source.

Parameter Type Required Default Description Access
name String Yes   Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source. modifiable
description String No null Type a description of the Source. modifiable
category String No null Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details. modifiable
fields JSON
Object
No   JSON map of key-value fields (metadata) to apply to the Collector or Source.

Use the boolean field _siemForward to enable forwarding to SIEM.
modifiable
namespace String Yes   Your Azure Event Hubs Namespace name. modifiable
hub_name String Yes   The Azure Event Hubs Instance Name modifiable
access_policy_name String Yes   Your Shared Access Policy Name. The Shared Access Policy requires the Listen claim. modifiable
access_policy_key String Yes   Your Shared Access Policy Key. The Shared Access Policy requires the Listen claim. modifiable
consumer_group String Yes $Default If needed, specify a custom consumer group name. When using a custom Consumer Group make sure that it exists for the Event Hub instance. modifiable
receive_with_latest_offset Boolean Yes True Receive data with the latest offset or from the timestamp. modifiable
receive_from_timestamp Boolean No    Set to true when receive_with_latest_offset is false. modifiable

Azure Event Hubs Source 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
    },
    "sourceType":"Universal"
  }
}