Coletar e ler dados do OpenTelemetry em Aplicativos de Contêiner do Azure (versão prévia)

Usando um agente de dados do OpenTelemetry com o ambiente de Aplicativos de Contêiner do Azure, você pode optar por enviar dados de observabilidade em um formato OpenTelemetry:

• Como canalizar dados de um agente para um ponto de extremidade desejado. As opções de destino incluem o Application Insights do Azure Monitor, o Datadog e qualquer ponto de extremidade compatível com o protocolo OTLP.

• Alterar facilmente os pontos de extremidade de destino sem precisar reconfigurar como eles emitem dados e sem precisar executar manualmente um agente do OpenTelemetry.

Esse artigo mostra como instalar e configurar um agente do OpenTelemetry para seu aplicativo de contêiner.

Configurar um agente do OpenTelemetry

Os agentes do OpenTelemetry residem em seu ambiente de aplicativo de contêiner. Você define as configurações do agente usando um modelo ARM ou chamadas Bicep para o ambiente ou por meio da CLI.

Cada tipo de ponto de extremidade (Azure Monitor Application Insights, DataDog e OTLP) tem requisitos de configuração específicos.

Pré-requisitos

Habilitar o agente gerenciado do OpenTelemetry para seu ambiente não significa automaticamente que o agente coleta dados. Os agentes só enviam dados com base nas configurações e instrumentando o código corretamente.

Configurar código-fonte

Prepare seu aplicativo para coletar dados instalando o SDK do OpenTelemetry e siga as diretrizes do OpenTelemetry para instrumentar métricas, logsou rastreamentos.

Inicializar pontos de extremidade

Para enviar dados para um destino de coleção, primeiro você precisa criar uma instância do serviço de destino. Por exemplo, para enviar dados para o Azure Monitor Application Insights, precisará criar uma instância do Application Insights antecipadamente.

O agente gerenciado do OpenTelemetry aceita os seguintes destinos:

• Azure Monitor Application Insights
• Datadog
• Qualquer ponto de extremidade OTLP (por exemplo: New Relic ou Honeycomb).

A tabela a seguir mostra os tipos de dados você pode enviar para cada destino:

O Application Insights do Azure Monitor

O único detalhe de configuração necessário do Application Insights é a cadeia de conexão. Com a cadeia de conexão, você pode configurar o agente usando o modelo ARM do aplicativo de contêiner ou com comandos da CLI do Azure.

{
  ...
  "properties": {
    "appInsightsConfiguration ": {  
      "connectionString": "<YOUR_APP_INSIGHTS_CONNECTION_STRING>"
    }
    "openTelemetryConfiguration": {
      ...
      "tracesConfiguration":{
        "destinations": ["appInsights"]
      },
      "logsConfiguration": {
        "destinations": ["appInsights"]
      }
    }
  }
}

az containerapp env telemetry app-insights set \
  --connection-string <YOUR_APP_INSIGHTS_CONNECTION_STRING> \
  --enable-open-telemetry-traces true \
  --enable-open-telemetry-logs true

Datadog

A configuração do agente Datadog requer um valor para site e key da sua instância do Datadog. Colete esses valores da sua instância do Datadog de acordo com esta tabela:

Com os detalhes da configuração, você pode definir o agente usando o modelo ARM do aplicativo de contêiner ou com comandos da CLI do Azure.

{
  ...
  "properties": {
    ...
    "openTelemetryConfiguration": {
      ...
      "destinationsConfiguration":{
        ...
        "dataDogConfiguration":{
          "site": "<YOUR_DATADOG_SUBDOMAIN>.datadoghq.com",
          "key": "<YOUR_DATADOG_KEY>"
        }
      },
      "tracesConfiguration":{
        "destinations": ["dataDog"]
      },
      "metricsConfiguration": {
        "destinations": ["dataDog"]
      }
    }
  }
}

az containerapp env telemetry data-dog set \
  --site  "<YOUR_DATADOG_SUBDOMAIN>.datadoghq.com" \
  --key <YOUR_DATADOG_KEY> \
  --enable-open-telemetry-traces true \
  --enable-open-telemetry-metrics true

Ponto de extremidade OTLP

Um ponto de extremidade OTLP (protocolo OpenTelemetry) é um destino de dados de telemetria que consome dados do OpenTelemetry. Na configuração do aplicativo, você pode adicionar vários pontos de extremidade OTLP. O exemplo a seguir adiciona dois pontos de extremidade e envia os dados a seguir a esses pontos de extremidade.

Embora você possa configurar quantos pontos de extremidade configurados por OTLP desejar, cada ponto de extremidade deve ter um nome distinto.

{
  "properties": {
    "appInsightsConfiguration": {},
    "openTelemetryConfiguration": {
      "destinationsConfiguration":{
        "otlpConfigurations": [
          {
            "name": "otlp1",
            "endpoint": "ENDPOINT_URL_1",
            "insecure": false,
            "headers": "api-key-1=key"
          },
          {
            "name": "otlp2",
            "endpoint": "ENDPOINT_URL_2",
            "insecure": true
          }
        ]
      },
      "logsConfiguration": { 
        "destinations": ["otlp2"]
      },
      "tracesConfiguration":{
        "destinations": ["otlp1", "otlp2"]
      },
      "metricsConfiguration": {
        "destinations": ["otlp1"]
      }
    }
  }
}

az containerapp env telemetry otlp add \
  --name "otlp1" \
  --endpoint "ENDPOINT_URL_1" \
  --insecure false \
  --headers "api-key-1=key" \
  --enable-open-telemetry-traces true \
  --enable-open-telemetry-metrics true
az containerapp env telemetry otlp add \
  --name "otlp2" \
  --endpoint "ENDPOINT_URL_2" \
  --insecure true \
  --enable-open-telemetry-traces true \
  --enable-open-telemetry-logs true

Configurar destinos dos dados

Para configurar um agente, use a matriz destinations para definir para quais agentes seu aplicativo envia dados. As chaves válidas são appInsights,dataDog ou o nome do ponto de extremidade OTLP personalizado. Você pode controlar como um agente se comporta com base no tipo de dados e nas opções relacionadas ao ponto de extremidade.

Por tipo de dados

Por ponto de extremidade

• Você só pode configurar um ponto de extremidade do Application Insights e do Datadog de cada vez.
• Embora você possa definir mais de um ponto de extremidade configurado por OTLP, cada um deve ter um nome distinto.

O exemplo a seguir mostra como usar um ponto de extremidade OTLP chamado customDashboard. Ele envia:

• rastreamentos para insights do aplicativo e customDashboard;
• logs para insights do aplicativo e customDashboard;
• métricas para DataDog e customDashboard.

{
  ...
  "properties": {
    ...
    "openTelemetryConfiguration": {
      ...
      "tracesConfiguration": {
        "destinations": [
          "appInsights",
          "customDashboard"
        ]
      },
      "logsConfiguration": {
        "destinations": [
          "appInsights",
          "customDashboard"
        ]
      },
      "metricsConfiguration": {
        "destinations": [
          "dataDog",
          "customDashboard"
        ]
      }
    }
  }
}

## Example OpenTelemetry configuration

The following example ARM template shows how you might configure your container app to collect telemetry data using Azure Monitor Application Insights, Datadog, and with a custom OTLP agent named `customDashboard`.

Before you deploy this template, replace placeholders surrounded by `<>` with your values.

```json
{
  "location": "eastus",
  "properties": {
    "appInsightsConfiguration": {
      "connectionString": "<APP_INSIGHTS_CONNECTION_STRING>"
    },
    "openTelemetryConfiguration": {
      "destinationsConfiguration": {
        "dataDogConfiguration": {
          "site": "datadoghq.com",
          "key": "<YOUR_DATADOG_KEY>"
        },
        "otlpConfigurations": [
          {
            "name": "customDashboard",
            "endpoint": "<OTLP_ENDPOINT_URL>",
            "insecure": true
          }
        ]
      },
      "tracesConfiguration": {
        "destinations": [
          "appInsights",
          "customDashboard"
        ]
      },
      "logsConfiguration": {
        "destinations": [
          "appInsights",
          "customDashboard"
        ]
      },
      "metricsConfiguration": {
        "destinations": [
          "dataDog",
          "customDashboard"
        ]
      }
    }
  }
}

Variáveis de ambiente

O agente do OpenTelemetry injeta automaticamente um conjunto de variáveis de ambiente em seu aplicativo em runtime.

As duas primeiras variáveis de ambiente seguem a configuração padrão do exportador do OpenTelemetry e são usadas em kits de desenvolvimento de software padrão OTLP. Se você definir explicitamente a variável de ambiente na especificação do aplicativo de contêiner, seu valor substituirá o valor injetado automaticamente.

Saiba mais sobre a configuração do exportador do OTLP, confira Configuração do exportador do OTLP.

As outras três variáveis de ambiente são específicas para Aplicativos de Contêiner do Azure e são sempre injetadas. Essas variáveis contêm URLs de ponto de extremidade do agente de cada tipo de dados específico (logs, métricas e rastreamentos).

Essas variáveis só serão necessárias se você estiver usando o agente gerenciado do OpenTelemetry e outro agente do OpenTelemetry. Usar essas variáveis fornece controle sobre o roteamento dos dados entre os diferentes agentes do OpenTelemetry.

Custos do agente do OpenTelemetry

Sua cobrança é feita conforme a computação subjacente do agente.

Consulte o serviço de destino para obter a estrutura de cobrança e os termos. Por exemplo, se você enviar dados para o Azure Monitor Application Insights e o Datadog, será responsável pelos encargos aplicados por ambos os serviços.

Limitações conhecidas

• Os agentes do OpenTelemetry estão na versão prévia.
• Os dados do sistema, como logs do sistema ou métricas padrão de Aplicativos de Contêiner, não estão disponíveis para serem enviados ao agente do OpenTelemetry.
• O ponto de extremidade do Application Insights não aceita métricas.
• O ponto de extremidade do Datadog não aceita logs.

Próximas etapas