$ telemetry
שלחו traces של Boost לפלטפורמת observability
EXTERNAL_OTEL_ENDPOINT ו-EXTERNAL_OTEL_HEADERS או EXTERNAL_OTEL_TOKEN.איך Boost בוחר יעד חיצוני
EXTERNAL_OTEL_ENDPOINTמפעיל יעד OTLP נוסף בבעלות הלקוח.EXTERNAL_OTEL_HEADERSשולח כותרותkey=valueמופרדות בפסיקים וגובר על קיצור ה-token.EXTERNAL_OTEL_TOKENהוא קיצור ל-Authorization=Bearer <token>.- השתמשו ב-
host:portל-OTLP/gRPC אוhttp://host/https://hostל-OTLP/HTTP.
הגדרה מהירה
בחרו פלטפורמה, החליפו placeholders והגדירו את המשתנים ב-shell, ב-job של CI או בסביבת הסוכן שמריצה את 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
דוגמאות לפי פלטפורמה
Coralogix
שלחו ל-ingress OTLP gRPC של Coralogix עם מפתח Send-Your-Data API.
- סוג token
- Coralogix Send-Your-Data API key
- Endpoint
- ingress.
:443
export EXTERNAL_OTEL_ENDPOINT=ingress.<coralogix-domain>:443
export EXTERNAL_OTEL_HEADERS='Authorization=Bearer <CORALOGIX_SEND_YOUR_DATA_API_KEY>'החליפו
Datadog
השתמשו ב-Datadog Agent מקומי ל-OTLP הנפוץ, או ingest OTLP ישיר אם החשבון מאפשר.
- סוג token
- Datadog API key for direct ingest; no app header for local Agent
- Endpoint
- 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>'ingest OTLP ישיר מופעל לפי חשבון ומבוסס HTTP/protobuf. רוב הצוותים מכוונים Boost ל-Agent מקומי.
Elastic Cloud / Elastic APM
שלחו traces OTLP ל-Elastic Cloud מנוהל או Elastic APM Server.
- סוג token
- Elastic encoded API key, Elastic APM API key, or Elastic APM secret token
- Endpoint
- https://
export EXTERNAL_OTEL_ENDPOINT=https://<elastic-otlp-or-apm-endpoint>
export EXTERNAL_OTEL_HEADERS='Authorization=ApiKey <ELASTIC_ENCODED_API_KEY>'ל-secret tokens של APM Server: Authorization=Bearer
Grafana Cloud
השתמשו ב-endpoint OTLP וב-token Basic auth מאריח OpenTelemetry של Grafana Cloud.
- סוג token
- Grafana Cloud instance ID plus API token encoded as Basic auth
- Endpoint
- 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 מציגה גם endpoints של OTLP/HTTP. ל-Boost, gRPC host:443 הוא הדוגמה הניידת ביותר.
Honeycomb
שלחו traces OTLP ישירות ל-Honeycomb עם מפתח API.
- סוג token
- Honeycomb API key
- Endpoint
- api.honeycomb.io:443
export EXTERNAL_OTEL_ENDPOINT=api.honeycomb.io:443
export EXTERNAL_OTEL_HEADERS='x-honeycomb-team=<HONEYCOMB_API_KEY>'ב-EU השתמשו ב-api.eu1.honeycomb.io:443. משתמשי Honeycomb Classic יכולים להוסיף x-honeycomb-dataset=
New Relic
שלחו traces OTLP ישירות ל-New Relic עם license key.
- סוג token
- New Relic license key
- Endpoint
- otlp.nr-data.net:443
export EXTERNAL_OTEL_ENDPOINT=otlp.nr-data.net:443
export EXTERNAL_OTEL_HEADERS='api-key=<NEW_RELIC_LICENSE_KEY>'ב-EU: otlp.eu01.nr-data.net:443. ב-FedRAMP: gov-otlp.nr-data.net:443.
איפה להגדיר משתנים
סוכנים מקומיים
ייצאו משתנים בסביבת ה-shell שהעורך או הסוכן יורשים. הפעילו מחדש את העורך אחרי שינוי קבצי הפעלה של shell.
GitHub Actions
אחסנו tokens ב-secrets של GitHub Actions ומפו אותם לסביבת ה-job שמריצה את Boost. אל תעלו tokens אמיתיים ל-workflows.
env:
EXTERNAL_OTEL_ENDPOINT: otlp.nr-data.net:443
EXTERNAL_OTEL_HEADERS: api-key=${{ secrets.NEW_RELIC_LICENSE_KEY }}
הערות אבטחה
- השתמשו ב-token של ספק עם הרשאות ingest הצרות ביותר האפשריות.
- העדיפו
EXTERNAL_OTEL_HEADERSכשהספק דורש שם כותרת שונה מ-Authorization. - Boost מסנן spans לפני export ואז מפיץ אותם ל-endpoint של Boost ול-endpoint החיצוני.
- אל תגדירו
EXTERNAL_OTEL_ENDPOINTאלא אם רוצים לשקף spans מחוץ ליעד telemetry ברירת המחדל של Boost.