Azure Event Hub Streaming Output and Integration

George Alpizar
George Alpizar
  • Updated

Overview

The Azure Event Hub output will stream analytics and insights to an Azure Event Hubs endpoint.

Before you begin

To enable this integration, you must have an Azure AD token.


Review Parameters

Review the following parameters that you can configure in the Edge Delta App:

YAML Description
name

Enter a descriptive name for the output or integration.

For outputs, this name will be used to map this destination to a workflow.

This parameter is required. 

Review the following example: 

name: eventhub-stream
integration_name

This parameter only appears when you create an individual output.

This parameter refers to the organization-level integration created in the Integrations page. If you enter this name, then the rest of the fields will be automatically populated.

If you need to add multiple instances of the same integration into the config, then you can add a custom name to each instance via the name field. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.

This parameter is optional. 

Review the following example: 

integration_name: orgs-azureeventhubs
type

Enter eventhubstream.

This parameter is required. 

Review the following example: 

type: eventhubstream
endpoint

Enter the Event Hubs endpoint.

This parameter is required. 

Review the following example: 

endpoint: "https://namespace.servicebus.windows.net/hub/messages"
token

Enter the Azure AD token.

This parameter is required. 

Review the following example: 

token: "azure-ad-token"
features

This parameter defines which data types to stream to the destination.

If you do not provide a value, then all will be set.

To learn more, review the Review Feature Types section in Stream Outputs and Integrations Overview.

This parameter is optional. 

Review the following example: 

features: metric
buffer_ttl

Enter a length of time to retry failed streaming data.

After this length of time is reached, the failed streaming data will no longer be tried.

This parameter is optional. 

Review the following example: 

buffer_ttl: 2h
buffer_path

Enter a folder path to temporarily store failed streaming data.

The failed streaming data will be retried until the data reaches its destinations or until the Buffer TTL value is reached.

If you enter a path that does not exist, then the agent will create directories, as needed.

This parameter is optional.

Review the following example:

buffer_path: /var/log/edgedelta/pushbuffer/
buffer_max_bytesize

Enter the maximum size of failed streaming data that you want to retry.

If the failed streaming data is larger than this size, then the failed streaming data will not be retried.

This parameter is optional.

Review the following example:

buffer_max_bytesize: 100MB

Review Sample Configuration

The following sample configuration displays an output without the name of the organization-level integration:

    - name: eventhub-stream
      type: eventhubstream
      endpoint: "https://namespace.servicebus.windows.net/hub/messages"
      token: "azure-ad-token"

 

 

Share this document