observability-edot-dotnet-instrument

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

EDOT .NET Instrumentation

EDOT .NET 插桩实现

在进行修改前,请先阅读设置指南:

Guidelines

操作准则

  1. Add NuGet packages:
    Elastic.OpenTelemetry
    and
    OpenTelemetry.Instrumentation.AspNetCore
    (for ASP.NET Core apps)
  2. Register EDOT in startup: call
    builder.AddElasticOpenTelemetry()
    on the
    IHostApplicationBuilder
    (in
    Program.cs
    or equivalent). Without this, no telemetry is collected
  3. Set exactly three required environment variables:
    • OTEL_SERVICE_NAME
    • OTEL_EXPORTER_OTLP_ENDPOINT
      — must be the managed OTLP endpoint or EDOT Collector URL. Never use an APM Server URL (no
      apm-server
      , no
      :8200
      , no
      /intake/v2/events
      )
    • OTEL_EXPORTER_OTLP_HEADERS
      "Authorization=ApiKey <key>"
      or
      "Authorization=Bearer <token>"
  4. Do NOT set
    OTEL_TRACES_EXPORTER
    ,
    OTEL_METRICS_EXPORTER
    , or
    OTEL_LOGS_EXPORTER
    — the defaults are already correct
  5. Do NOT manually configure
    TracerProvider
    or
    MeterProvider
    AddElasticOpenTelemetry()
    handles everything
  6. Never run both classic Elastic APM agent (
    Elastic.Apm.*
    ) and EDOT on the same application
  1. 添加NuGet包:
    Elastic.OpenTelemetry
    OpenTelemetry.Instrumentation.AspNetCore
    (适用于ASP.NET Core应用)
  2. 在启动流程中注册EDOT:在
    IHostApplicationBuilder
    上调用
    builder.AddElasticOpenTelemetry()
    (位于
    Program.cs
    或等效文件中)。如果不执行此步骤,将不会收集任何遥测数据
  3. 必须设置以下三个必填环境变量:
    • OTEL_SERVICE_NAME
    • OTEL_EXPORTER_OTLP_ENDPOINT
      — 必须是托管OTLP端点EDOT Collector的URL。切勿使用APM Server的URL(不能包含
      apm-server
      :8200
      /intake/v2/events
    • OTEL_EXPORTER_OTLP_HEADERS
      — 格式为
      "Authorization=ApiKey <key>"
      "Authorization=Bearer <token>"
  4. 请勿设置
    OTEL_TRACES_EXPORTER
    OTEL_METRICS_EXPORTER
    OTEL_LOGS_EXPORTER
    — 默认配置已满足需求
  5. 请勿手动配置
    TracerProvider
    MeterProvider
    AddElasticOpenTelemetry()
    会处理所有相关配置
  6. 切勿在同一应用程序中同时运行传统Elastic APM代理(
    Elastic.Apm.*
    )和EDOT

Examples

示例

See the EDOT .NET setup guide for complete examples.
完整示例请查看EDOT .NET 设置指南