> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chronosphere.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Azure Event Hubs destination plugin

export const entity_0 = "Azure Event Hubs destination plugin"

export const plugin_0 = "Azure Event Hubs destination plugin"

The Azure Event Hubs [destination plugin](/ingest/pipeline/plugins/destination-plugins)
(name: `kafka`, alias: `Azure_Event_Hub`) lets you configure your telemetry
pipeline to stream your logs and metrics data directly to Azure Event Hubs.

## Supported telemetry types

The {plugin_0} for Chronosphere Telemetry Pipeline supports these telemetry types:

|                    Logs                    |             Metrics             |              Traces             |
| :----------------------------------------: | :-----------------------------: | :-----------------------------: |
| <Icon icon="circle-check" color="green" /> | <Icon icon="ban" color="red" /> | <Icon icon="ban" color="red" /> |

## Configuration parameters

Use the parameters in this section to configure the {entity_0}. The
Telemetry Pipeline web interface uses the items in the **Name** column to
describe these parameters. [Pipeline configuration files](/ingest/pipeline/v2/configure/config-files)
use the items in the **Key** column as YAML keys.

### General

| Name                      | Key                     | Description                                                                                             | Default |
| ------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------- | ------- |
| **Event Hub Namespace**   | `brokers`               | Required. The Event Hubs namespace that can be found within the configuration settings.                 | *none*  |
| **Event Hub Topic**       | `topics`                | Required. The Event Hubs topic to write information to.                                                 | *none*  |
| **Connection String Key** | `rdkafka.sasl.password` | Required. The Event Hubs connection string from within the Connection Access Policy set for the source. | *none*  |

### Advanced

| Name                   | Key                         | Description                                                                                                                                                                                                                                                                                                                                                                                                                         | Default             |
| ---------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| **Message Key**        | `message_key`               | Optional key to store the message.                                                                                                                                                                                                                                                                                                                                                                                                  | *none*              |
| **Message Key Field**  | `message_key_field`         | If set, this value indicates the message key. If not set or found in the record, `message_key` will be used (if set).                                                                                                                                                                                                                                                                                                               | *none*              |
| **Timestamp Key**      | `timestamp_key`             | Sets the key to store the record timestamp.                                                                                                                                                                                                                                                                                                                                                                                         | *none*              |
| **Timestamp Format**   | `timestamp_format`          | Sets the timestamp format. Accepted values: `double`, `iso8601`.                                                                                                                                                                                                                                                                                                                                                                    | `double`            |
| **Body Key**           | `body_key`                  | Specifies the key that contains the body.                                                                                                                                                                                                                                                                                                                                                                                           | *none*              |
| **Queue Full Retries** | `queue_full_retries`        | Telemetry Pipeline queues data into rdkafka library, if for some reason the underlying library can't flush the records the queue might fills up blocking new addition of records. The `queue_full_retries` option set the number of local retries to enqueue the data. The default value is 10 times, the interval between each retry is 1 second. Setting the `queue_full_retries` value to 0 sets an unlimited number of retries. | `10`                |
| **SASL Username**      | `rdkafka.sasl.username`     | SASL username.                                                                                                                                                                                                                                                                                                                                                                                                                      | `$ConnectionString` |
| **Security Protocol**  | `rdkafka.security.protocol` | This is the security protocol for Azure Event Hub. If you require OAuth 2.0 or OpenID authentication, open a support ticket prior to changing this setting.                                                                                                                                                                                                                                                                         | `SASL_SSL`          |
| **SASL Mechanism**     | `rdkafka.sasl.mechanism`    | This is the transport mechanism for the SASL connection.                                                                                                                                                                                                                                                                                                                                                                            | `PLAIN`             |

### Extended librdkafka parameters

This plugin uses the [librdkafka](https://github.com/confluentinc/librdkafka)
library. Certain configuration parameters available through the Telemetry
Pipeline UI are based on librdkafka settings. These parameters generally use the
`rdkafka.` prefix.

In addition to the parameters available through the Telemetry Pipeline UI, you can
customize any of the
[librdkafka configuration properties](https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md)
by adding them to a pipeline configuration file. To do so, append the `rdkafka.`
prefix to the name of that property.

For example, to customize the `socket.keepalive.enable` property, add the
`rdkafka.socket.keepalive.enable` key to your configuration file.
