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.
- To learn how to create an Azure AD token, review this document from Microsoft.
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"
Review Parameters
Review the following parameters that you can configure in the Edge Delta App.
name
Required
Enter a descriptive name for the output or integration.
For outputs, this name will be used to map this destination to a workflow.
Review the following example:
name: eventhub-stream
integration_name
Optional
This parameter refers to the organization-level integration created in the Integrations page.
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 parameter. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.
Review the following example:
integration_name: orgs-azureeventhubs
type
Required
Enter eventhubstream.
Review the following example:
type: eventhubstream
endpoint
Required
Enter the Event Hubs endpoint.
Review the following example:
endpoint: "https://namespace.servicebus.windows.net/hub/messages"
token
Required
Enter the Azure AD token.
Review the following example:
token: "azure-ad-token"
features
Optional
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.
Review the following example:
features: metric
buffer_ttl
Optional
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.
Review the following example:
buffer_ttl: 2h
buffer_path
Optional
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.
Review the following example:
buffer_path: /var/log/edgedelta/pushbuffer/
buffer_max_bytesize
Optional
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.
Review the following example:
buffer_max_bytesize: 100MB