Compartilhar via

add-telemetry comando

Adicione ou atualize as configurações do OpenTelemetry e do Azure Application Insights em um arquivo de configuração existente do Construtor de API de Dados. Se a runtime.telemetry seção não existir, ela será criada. As opções não especificadas deixam os valores existentes inalterados.

Observação

As configurações de telemetria não são configuráveis com dab configure. Use dab add-telemetry para todas as runtime.telemetry alterações.

Para obter diretrizes conceituais e instruções passo a passo de ponta a ponta, consulte Usar o OpenTelemetry e rastreamentos de atividades e usar o Azure Application Insights.

Sintaxe

dab add-telemetry [options]

Olhar rápido

Opção Resumo
-c, --config Caminho do arquivo de configuração. Padrão dab-config.json.

Seção OpenTelemetry

Opção Resumo
--otel-enabled Habilitar ou desabilitar o OpenTelemetry.
--otel-endpoint URL do ponto de extremidade do coletor OpenTelemetry.
--otel-protocol Protocolo de exportação. Valores permitidos: grpc, httpprotobuf.
--otel-service-name Marca de nome de serviço em toda a telemetria.
--otel-headers Cabeçalhos extras a serem enviados para o coletor OpenTelemetry.

Seção Do Azure Application Insights

Opção Resumo
--app-insights-enabled Habilitar ou desabilitar o Azure Application Insights.
--app-insights-conn-string Cadeia de conexão do Application Insights.

-c, --config

Caminho para o arquivo de configuração. O padrão é, a dab-config.json menos que dab-config.<DAB_ENVIRONMENT>.json exista, onde DAB_ENVIRONMENT está uma variável de ambiente.

Exemplo

dab add-telemetry \
  --config ./my-config.json \
  --otel-enabled true

--otel-enabled

Habilitar ou desabilitar o exportador OpenTelemetry. Valores aceitos: true, false.

Exemplo

dab add-telemetry \
  --otel-enabled true

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true
      }
    }
  }
}

--otel-endpoint

URL do coletor OpenTelemetry ou back-end. Para gRPC, use http://<host>:<port>. Para HTTP, inclua o caminho completo, por exemplo http://<host>:<port>/v1/traces.

Exemplo

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "http://localhost:4317"

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "endpoint": "http://localhost:4317"
      }
    }
  }
}

--otel-protocol

Exportar o protocolo para o exportador OpenTelemetry. Valores permitidos: grpc, httpprotobuf. Usa grpc como padrão.

Exemplo

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "http://localhost:4318" \
  --otel-protocol "httpprotobuf"

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "endpoint": "http://localhost:4318",
        "exporter-protocol": "httpprotobuf"
      }
    }
  }
}

--otel-service-name

Marca de nome de serviço anexada a todos os rastreamentos e métricas. Aparece como o identificador de serviço no back-end de telemetria. Usa dab como padrão.

Exemplo

dab add-telemetry \
  --otel-enabled true \
  --otel-service-name "my-dab-api"

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "service-name": "my-dab-api"
      }
    }
  }
}

--otel-headers

Cabeçalhos HTTP extras a serem incluídos ao exportar telemetria para o coletor. Use uma lista separada por vírgulas key=value . Use essa opção para pontos de extremidade de coletor autenticados que exigem uma chave de API ou cabeçalho de autorização.

Exemplo

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "https://collector.example.com:4317" \
  --otel-headers "api-key=my-secret-key"

--app-insights-enabled

Habilitar ou desabilitar a telemetria do Azure Application Insights. Valores aceitos: true, false.

Exemplo

dab add-telemetry \
  --app-insights-enabled true

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": true
      }
    }
  }
}

--app-insights-conn-string

Cadeia de conexão para o recurso do Azure Application Insights. Use uma referência de variável de ambiente para evitar a confirmação de segredos no controle do código-fonte.

Aviso

Nunca desembuta a cadeia de conexão diretamente no arquivo de configuração. Use @env('<variable-name>') ou um gerente de segredo.

Exemplo

dab add-telemetry \
  --app-insights-enabled true \
  --app-insights-conn-string "@env('APP_INSIGHTS_CONN_STRING')"

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": true,
        "connection-string": "@env('APP_INSIGHTS_CONN_STRING')"
      }
    }
  }
}

Exemplo completo: OpenTelemetry e Application Insights

O exemplo a seguir habilita o OpenTelemetry e o Application Insights em um único comando.

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "http://localhost:4317" \
  --otel-protocol "grpc" \
  --otel-service-name "my-dab-api" \
  --app-insights-enabled true \
  --app-insights-conn-string "@env('APP_INSIGHTS_CONN_STRING')"

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "endpoint": "http://localhost:4317",
        "service-name": "my-dab-api",
        "exporter-protocol": "grpc"
      },
      "application-insights": {
        "enabled": true,
        "connection-string": "@env('APP_INSIGHTS_CONN_STRING')"
      }
    }
  }
}

Conteúdo relacionado

  • Last updated on