Send Azure Event Hubs Logs to Observability Pipelines

This product is not supported for your selected Datadog site. ().
이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우 언제든지 연락주시기 바랍니다.

Overview

This document walks through how to send Azure Event Hubs logs to Observability Pipelines using the Kafka source. The setup steps include setting up Azure Event Hubs for the Kafka source:

After Azure Event Hubs has been set up, you set up a pipeline with the Kafka source to send Azure Event Hubs logs to Observability Pipelines.

Set up Azure Event Hubs for the Kafka source

Create an Azure Event Hubs namespace

  1. In the Azure Portal, navigate to Event Hubs.
  2. Click Create.
  3. Fill in the Project Details (subscription, resource group) and Instance Details (namespace name, region, select Standard, Premium, or Dedicated tier).
  4. Ensure the region matches your Azure resources (for example, westus).
  5. Click Review + create.

Note: The Kafka endpoint is automatically enabled for standard and higher tiers.

Create an event hub (Kafka topic)

  1. In the namespace you created, select Event Hubs and click + Event Hub.
  2. Enter a name (for example, datadog-topic) and configure the settings (for example, 4 partitions and a 7-day retention time).
  3. Click Review + create. This Event Hub acts as a Kafka topic.

Configure shared access policy

  1. In the Event Hub you created, navigate to Settings > Shared access policies.
  2. Click + Add.
  3. Enter a policy name (for example, DatadogKafkaPolicy).
  4. Select the Manage checkbox, which should automatically select the Send and Listen checkboxes.
  5. Click Create.
  6. The Primary Key and Primary connection string is needed for Kafka authentication when you set up the Observability Pipeline’s Kafka source.

Set up diagnostic settings

  1. Configure Azure resources (for example, VMs, App Services) or subscription-level activity logs to stream logs to the Event Hub.
  2. For resources:
    1. Navigate to the resource and then to Monitoring > Diagnostic settings.
    2. Click + Add diagnostic setting.
    3. Select log categories you want (for example, AuditLogs, SignInLogs for Microsoft Entra ID).
    4. In Destination details:
      1. Check the Stream to an event hub box.
      2. Select the namespace and Event Hub (datadog-topic).
    5. Click Save.
  3. For activity logs:
    1. Navigate to Microsoft Entra ID > Monitoring > Audit logs > Export Data Settings.
    2. Check the Stream to the Event Hub box.
  4. Repeat for each region. Logs must stream to Event Hubs in the same region.

Configure Kafka-compatible connection for the Event Hub

Azure Event Hubs exposes a Kafka endpoint at NAMESPACE.servicebus.windows.net:9093, which Observability Pipelines uses as the Kafka source.

Get the Kafka endpoint

  1. In the Azure Portal, navigate to your Event Hubs Namespace (for example, myeventhubns).
  2. On the Overview page, under the Essentials section, locate the Host name or Fully Qualified Domain Name (FQDN). It is in the format: <NAMESPACE>.servicebus.windows.net (for example, myeventhubns.servicebus.windows.net).
  3. Append the Kafka port :9093 to form the Bootstrap Servers value: <NAMESPACE>.servicebus.windows.net:9093.
    • For example, if your namespace is myeventhubns, the Bootstrap Servers is myeventhubns.servicebus.windows.net:9093.
    • You need this information when you set up the Observability Pipelines Kafka source.

Set up authentication

  1. Azure Event Hubs uses SASL_SSL with the PLAIN mechanism for Kafka authentication.
  2. The connection string is formatted for Observability Pipelines:
    Username: $$ConnectionString
Password: Endpoint=sb://<NAMESPACE>.servicebus.windows.net/;SharedAccessKeyName=<PolicyName>;SharedAccessKey=<Key>

Set up a pipeline with the Kafka source

Select your platform.

    1. Navigate to Observability Pipelines.

    2. Select the Kafka source.

      1. In the Group ID field, specify or create a unique consumer group (for example, datadog-consumer-group).
      2. In the Topics field, enter datadog-topic or the topic you configured for your Event Hub earlier.
      3. Toggle the switch to enable SASL authentication.
      4. In the Mechanism dropdown menu, select PLAIN.
      5. Enable TLS.
        1. Configure your values.yaml file to use the certificate that works as part of the container image:
          initContainers:
- name: copy-config
image: gcr.io/datadoghq/observability-pipelines-worker:latest
imagePullPolicy: IfNotPresent
command: ['/bin/sh', '-c', 'mkdir -p /config-volume/observability-pipelines-worker/config/ && cp /etc/ssl/certs/ca-certificates.crt /config-volume/observability-pipelines-worker/config/ca-certificates.crt']
volumeMounts:
- name: config-volume
    mountPath: /config-volume
extraVolumes:
- name: config-volume
emptyDir: {}
extraVolumeMounts:
- name: config-volume
mountPath: /config-volume
          Note: When install the Worker with the install command you need to add:
          --set env[0].name=DD_OP_DATA_DIR,env[0].value='/config-volume/observability-pipelines-worker/'
        2. In the Certificate path field, enter /ca-certificates.crt if you used the example above. Otherwise, enter the name of your certificate.
      The Kafka source settings with example values

    3. Click Next: Select Destination.

    4. After you set up your destinations and processors, click Next: Install.

    5. Select your platform in the Choose your installation platform dropdown menu.

    6. Enter the environment variables for your Kafka source:

      1. For Kafka Bootstrap Servers, enter <NAMESPACE>.servicebus.windows.net:9093 (for example, myeventhubns.servicebus.windows.net:9093).
      2. For Kafka SASL Username, enter $$$$ConnectionString. Note: You must have $$$$ in front of ConnectionString because $$$$ ends up being $$ when transposed into the environment.
      3. For Kafka SASL Password, enter the full connection string. For example, Endpoint=sb://<NAMESPACE>.servicebus.windows.net/;SharedAccessKeyName=<PolicyName>;SharedAccessKey=<Key>.
      4. Enter your Kafka TLS passphrase.
      The install page with example values for the kafka environment variables

    7. Enter the environment variables for your destinations, if applicable.

    8. Follow the rest of the instructions on the page to install the Worker based on your platform.

    1. Navigate to Observability Pipelines.

    2. Select the Kafka source.

      1. In the Group ID field, specify or create a unique consumer group (for example, datadog-consumer-group).
      2. Enter datadog-topic in the Topics field.
      3. Toggle the switch to enable SASL authentication.
      4. In the Mechanism dropdown menu, select PLAIN.
      5. Enable TLS. For the certificate, copy the certificate from its original location to the default Observability Pipelines data configuration directory:
        1. Since the Observability Pipelines Worker hasn’t been installed yet, run this command to create the directory for the certificate:
          sudo mkdir -p /var/lib/observability-pipelines-worker/config
        2. Run this command to copy the certificate to the directory you created:
          sudo cp /etc/ssl/certs/ca-certificates.crt /var/lib/observability-pipelines-worker/config/
        3. In the Certificate path field, enter /ca-certificates.crt.
      The Kafka source settings with example values

    3. Click Next: Select Destination.

    4. After you set up your destinations and processors, click Next: Install.

    5. Select your platform in the Choose your installation platform dropdown menu.

    6. Enter the environment variables for your Kafka source:

      1. For Kafka Bootstrap Servers, enter <NAMESPACE>.servicebus.windows.net:9093 (for example, myeventhubns.servicebus.windows.net:9093).
      2. For Kafka SASL Username, enter \$\$ConnectionString. Note: You must escape the $ in front of ConnectionString, otherwise the environment variable won’t be loaded.
      3. For Kafka SASL Password, enter the full connection string wrapped in quotes ("). For example, "Endpoint=sb://<NAMESPACE>.servicebus.windows.net/;SharedAccessKeyName=<PolicyName>;SharedAccessKey=<Key>".
      4. Enter your Kafka TLS passphrase.
      The install page with example values for the kafka environment variables

    Troubleshooting

    If you run into issues after installing the Worker, check your Observability Pipelines environment file (/etc/default/observability-pipelines-worker) to make sure the environment variables are correctly set:

    • DD_OP_SOURCE_KAFKA_SASL_USERNAME="$$ConnectionString"
    • DD_OP_SOURCE_KAFKA_BOOTSTRAP_SERVERS=<NAMESPACE>.servicebus.windows.net:9093
    • DD_OP_SOURCE_KAFKA_SASL_PASSWORD=<Endpoint=sb://<NAMESPACE>.servicebus.windows.net/;SharedAccessKeyName=<PolicyName>;SharedAccessKey=<Key>>
    • DD_OP_SOURCE_KAFKA_KEY_PASS=password

    Missing environment variable

    If you see the error Missing environment variable DD_OP_SOURCE_KAFKA_SASL_PASSWORD and you are running the Worker in a VM, make sure that the variable is in quotes (") when you run the Worker install script. For example:

    DD_OP_SOURCE_KAFKA_SASL_PASSWORD=`"Endpoint=sb://<NAMESPACE>.servicebus.windows.net/;SharedAccessKeyName=<PolicyName>;SharedAccessKey=<Key>"`