$ telemetry
Envoyez les traces Boost vers votre plateforme d'observabilité
EXTERNAL_OTEL_ENDPOINT et EXTERNAL_OTEL_HEADERS ou EXTERNAL_OTEL_TOKEN.Comment Boost choisit la destination externe
EXTERNAL_OTEL_ENDPOINTactive la destination OTLP supplémentaire du client.EXTERNAL_OTEL_HEADERSenvoie des en-têteskey=valueséparés par des virgules et prime sur le raccourci token.EXTERNAL_OTEL_TOKENest un raccourci pourAuthorization=Bearer <token>.- Utilisez
host:portpour OTLP/gRPC ouhttp://host/https://hostpour OTLP/HTTP.
Configuration rapide
Choisissez votre plateforme, remplacez les placeholders et exportez les variables dans le shell, le job CI ou l'environnement agent qui exécute Boost.
# generic OTLP/gRPC collector
export EXTERNAL_OTEL_ENDPOINT=otel-collector.example.com:4317
export EXTERNAL_OTEL_HEADERS='Authorization=Bearer <collector-token>'
# local OTLP/HTTP collector
export EXTERNAL_OTEL_ENDPOINT=http://localhost:4318
Exemples par plateforme
Coralogix
Envoyez vers l'ingress OTLP gRPC Coralogix avec une clé API Send-Your-Data.
- Type de jeton
- Coralogix Send-Your-Data API key
- Point de terminaison
- ingress.
:443
export EXTERNAL_OTEL_ENDPOINT=ingress.<coralogix-domain>:443
export EXTERNAL_OTEL_HEADERS='Authorization=Bearer <CORALOGIX_SEND_YOUR_DATA_API_KEY>'Remplacez
Datadog
Utilisez un Datadog Agent local pour l'OTLP le plus courant, ou l'ingest OTLP direct si votre compte l'autorise.
- Type de jeton
- Datadog API key for direct ingest; no app header for local Agent
- Point de terminaison
- http://localhost:4318
# local Datadog Agent
export EXTERNAL_OTEL_ENDPOINT=http://localhost:4318
# direct OTLP traces ingest
export EXTERNAL_OTEL_ENDPOINT=<DATADOG_PROVIDED_OTLP_TRACES_HTTPS_ENDPOINT>
export EXTERNAL_OTEL_HEADERS='dd-api-key=<DD_API_KEY>,dd-otlp-source=<DATADOG_ASSIGNED_SOURCE>'L'ingest OTLP direct est activé par compte et basé sur HTTP/protobuf. La plupart des équipes pointent Boost vers un Agent local.
Elastic Cloud / Elastic APM
Envoyez des traces OTLP vers Elastic Cloud managé ou un Elastic APM Server.
- Type de jeton
- Elastic encoded API key, Elastic APM API key, or Elastic APM secret token
- Point de terminaison
- https://
export EXTERNAL_OTEL_ENDPOINT=https://<elastic-otlp-or-apm-endpoint>
export EXTERNAL_OTEL_HEADERS='Authorization=ApiKey <ELASTIC_ENCODED_API_KEY>'Pour les secret tokens APM Server, utilisez Authorization=Bearer
Grafana Cloud
Utilisez le endpoint OTLP et le jeton Basic auth de la tuile OpenTelemetry Grafana Cloud.
- Type de jeton
- Grafana Cloud instance ID plus API token encoded as Basic auth
- Point de terminaison
- otlp-gateway-
.grafana.net:443
export EXTERNAL_OTEL_ENDPOINT=otlp-gateway-<region>.grafana.net:443
export EXTERNAL_OTEL_HEADERS='Authorization=Basic <BASE64_INSTANCE_ID_COLON_TOKEN>'Grafana Cloud affiche aussi des endpoints OTLP/HTTP. Pour Boost, le format gRPC host:443 est l'exemple le plus portable.
Honeycomb
Envoyez des traces OTLP directement à Honeycomb avec votre clé API.
- Type de jeton
- Honeycomb API key
- Point de terminaison
- api.honeycomb.io:443
export EXTERNAL_OTEL_ENDPOINT=api.honeycomb.io:443
export EXTERNAL_OTEL_HEADERS='x-honeycomb-team=<HONEYCOMB_API_KEY>'Pour l'UE, utilisez api.eu1.honeycomb.io:443. Les utilisateurs Honeycomb Classic peuvent ajouter x-honeycomb-dataset=
New Relic
Envoyez des traces OTLP directement à New Relic avec votre license key.
- Type de jeton
- New Relic license key
- Point de terminaison
- otlp.nr-data.net:443
export EXTERNAL_OTEL_ENDPOINT=otlp.nr-data.net:443
export EXTERNAL_OTEL_HEADERS='api-key=<NEW_RELIC_LICENSE_KEY>'Pour l'UE, utilisez otlp.eu01.nr-data.net:443. Pour FedRAMP, gov-otlp.nr-data.net:443.
Où définir les variables
Agents locaux
Exportez les variables dans le shell hérité par votre éditeur ou agent. Redémarrez l'éditeur après modification des fichiers de démarrage shell.
GitHub Actions
Stockez les jetons dans les secrets GitHub Actions et mappez-les dans l'environnement du job qui exécute Boost. N'engagez pas de vrais jetons dans les workflows.
env:
EXTERNAL_OTEL_ENDPOINT: otlp.nr-data.net:443
EXTERNAL_OTEL_HEADERS: api-key=${{ secrets.NEW_RELIC_LICENSE_KEY }}
Notes de sécurité
- Utilisez un jeton fournisseur avec les permissions d'ingest les plus étroites possibles.
- Préférez
EXTERNAL_OTEL_HEADERSquand le fournisseur exige un autre nom d'en-tête queAuthorization. - Boost assainit les spans avant export, puis les distribue vers le endpoint Boost et votre endpoint externe.
- Ne définissez pas
EXTERNAL_OTEL_ENDPOINTsauf si vous voulez dupliquer les spans hors de la télémétrie Boost par défaut.