Bagikan melalui

add-telemetry perintah

Menambahkan atau memperbarui pengaturan OpenTelemetry dan Azure Application Insights dalam file konfigurasi penyusun API Data yang ada. Jika bagian runtime.telemetry tidak ada, bagian tersebut akan dibuat. Opsi yang tidak ditentukan membuat nilai yang ada tidak berubah.

Nota

Pengaturan telemetri tidak dapat dikonfigurasi dengan dab configure. Gunakan dab add-telemetry untuk semua runtime.telemetry perubahan.

Untuk panduan konseptual dan panduan end-to-end, lihat Menggunakan OpenTelemetry dan jejak aktivitas dan Menggunakan Azure Application Insights.

Sintaksis

dab add-telemetry [options]

Sekilas

Option RINGKASAN
-c, --config Jalur file konfigurasi. Bawaan dab-config.json.

Bagian OpenTelemetry

Option RINGKASAN
--otel-enabled Mengaktifkan atau menonaktifkan OpenTelemetry.
--otel-endpoint URL titik akhir pengumpul OpenTelemetry.
--otel-protocol Ekspor protokol. Nilai yang diizinkan: grpc, httpprotobuf.
--otel-service-name Tag nama layanan pada semua telemetri.
--otel-headers Header tambahan untuk dikirim ke pengumpul OpenTelemetry.

Bagian Azure Application Insights

Option RINGKASAN
--app-insights-enabled Mengaktifkan atau menonaktifkan Azure Application Insights.
--app-insights-conn-string String koneksi untuk Application Insights.

-c, --config

Jalur ke file konfigurasi. Default ke dab-config.json kecuali dab-config.<DAB_ENVIRONMENT>.json ada, di mana DAB_ENVIRONMENT adalah variabel lingkungan.

Example

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

--otel-enabled

Aktifkan atau nonaktifkan pengekspor OpenTelemetry. Nilai yang diterima: true, false.

Example

dab add-telemetry \
  --otel-enabled true

Konfigurasi yang dihasilkan

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

--otel-endpoint

URL kolektor OpenTelemetry atau back end Anda. Untuk gRPC, gunakan http://<host>:<port>. Untuk HTTP, sertakan jalur lengkap, misalnya http://<host>:<port>/v1/traces.

Example

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

Konfigurasi yang dihasilkan

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

--otel-protocol

Ekspor protokol untuk pengekspor OpenTelemetry. Nilai yang diizinkan: grpc, httpprotobuf. Secara default menjadi grpc.

Example

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

Konfigurasi yang dihasilkan

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

--otel-service-name

Tag nama layanan yang dilampirkan ke semua jejak dan metrik. Muncul sebagai pengidentifikasi layanan di back end telemetri Anda. Secara default menjadi dab.

Example

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

Konfigurasi yang dihasilkan

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

--otel-headers

Header HTTP tambahan untuk disertakan saat mengekspor telemetri ke pengumpul. Gunakan daftar yang dipisahkan key=value koma. Gunakan opsi ini untuk titik akhir pengumpul terautentikasi yang memerlukan kunci API atau header otorisasi.

Example

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

--app-insights-enabled

Mengaktifkan atau menonaktifkan telemetri Azure Application Insights. Nilai yang diterima: true, false.

Example

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

Konfigurasi yang dihasilkan

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

--app-insights-conn-string

String koneksi untuk sumber daya Azure Application Insights Anda. Gunakan referensi variabel lingkungan untuk menghindari penerapan rahasia ke kontrol sumber.

Peringatan

Jangan pernah mengkodekan string koneksi secara langsung dalam file konfigurasi Anda. Gunakan @env('<variable-name>') atau manajer rahasia.

Example

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

Konfigurasi yang dihasilkan

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

Contoh lengkap: OpenTelemetry dan Application Insights

Contoh berikut memungkinkan OpenTelemetry dan Application Insights dalam satu perintah.

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')"

Konfigurasi yang dihasilkan

{
  "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')"
      }
    }
  }
}

Konten terkait

  • Last updated on