Managed OpenTelemetry untuk GKE

Dokumen ini menjelaskan Managed OpenTelemetry untuk Google Kubernetes Engine (GKE), yang memungkinkan Anda mengirim trace, metrik, dan log OpenTelemetry Protocol (OTLP) ke Google Cloud Observability dari aplikasi yang berjalan di GKE. OpenTelemetry Terkelola menyediakan satu-satunya solusi terkelola dari Google Cloud untuk mengumpulkan data trace di GKE.

Untuk menggunakan OpenTelemetry Terkelola untuk Google Kubernetes Engine (GKE), aplikasi harus sudah diinstrumentasikan untuk menghasilkan sinyal menggunakan protokol OpenTelemetry. Untuk mengetahui detailnya, lihat Workload yang didukung.

OpenTelemetry Terkelola untuk GKE memiliki dua komponen:

  • Pengumpulan terkelola: Kolektor terkelola menyediakan endpoint OpenTelemetry Protocol dalam cluster sebagai tujuan bagi workload untuk mengirim trace, metrik, dan log dalam format OTLP, tanpa harus mengelola kolektor.
  • Konfigurasi otomatis: Resource kustom yang disebut Instrumentasi memungkinkan konfigurasi otomatis untuk workload GKE Anda guna membuat dan menyerap trace, metrik, dan log OpenTelemetry yang berkorelasi. Pendekatan ini mendukung Agent Development Kit (ADK) dan data perintah dan respons multimodal.

    Anda dapat menggunakan resource kustom Instrumentasi untuk workload yang menggunakan OpenTelemetry SDK dan dikonfigurasi dengan variabel lingkungan OpenTelemetry standar. Resource kustom Instrumentasi ini, instrumentations.telemetry.googleapis.com, adalah resource yang berbeda dari resource Instrumentasi untuk operator OpenTelemetry.

Untuk mengetahui langkah-langkah menggunakan OpenTelemetry Terkelola untuk GKE, lihat Men-deploy OpenTelemetry Terkelola untuk GKE.

OpenTelemetry Terkelola untuk GKE memungkinkan Anda mengumpulkan telemetri OTLP tanpa harus mengelola dan mengoperasikan kolektor OpenTelemetry. Menjalankan kolektor Anda sendiri dapat menimbulkan overhead, termasuk autentikasi, konfigurasi, upgrade, dan pemantauan. Namun, jika Anda memerlukan pemfilteran dan kontrol tingkat kolektor, Anda dapat menggunakan Kolektor OpenTelemetry Buatan Google, bukan layanan terkelola ini.

OpenTelemetry menyediakan API, library, dan SDK untuk menghasilkan trace, metrik, dan log terdistribusi untuk pemantauan aplikasi. Untuk mengetahui informasi selengkapnya tentang OpenTelemetry, lihat dokumentasi tentang OpenTelemetry dan OpenTelemetry Protocol (OTLP). Untuk mengetahui detail selengkapnya tentang cara membuat dan mengumpulkan data perilaku runtime aplikasi, lihat Kemampuan observasi untuk developer aplikasi.

Cara kerja OpenTelemetry Terkelola untuk GKE

Managed OpenTelemetry untuk GKE memiliki dua komponen: pengumpulan terkelola dan konfigurasi otomatis.

Koleksi terkelola

Pengumpulan terkelola menyediakan endpoint OTLP dalam cluster dengan men-deploy kolektor OpenTelemetry terkelola ke cluster Anda. Endpoint OTLP dalam cluster ini menerima trace, metrik, dan log dalam format OTLP. Untuk menerima data dari workload, workload harus dikonfigurasi untuk mengirim data ke kolektor.

Endpoint tempat workload Anda mengirim data bergantung pada protokol yang Anda gunakan, sebagai berikut:

  • URL http://opentelemetry-collector.gke-managed-otel.svc.cluster.local:4318 untuk endpoint HTTP.
  • URL http://opentelemetry-collector.gke-managed-otel.svc.cluster.local:4317 untuk endpoint gRPC.

Koleksi terkelola mengirimkan data yang dikumpulkan ke Google Cloud Observability. Data tersebut kemudian tersedia di layanan berikut:

Kolektor terkelola dapat diaktifkan untuk cluster GKE menggunakan konsol atau gcloud CLI. Untuk mengetahui petunjuknya, lihat Mengaktifkan OpenTelemetry Terkelola untuk GKE di cluster.

Konfigurasi otomatis

Konfigurasi otomatis memungkinkan GKE mengonfigurasi workload yang berjalan di GKE untuk mengirim sinyal ke endpoint kolektor terkelola.

Ada berbagai metode yang dapat digunakan untuk mengonfigurasi workload. Konfigurasi otomatis menggunakan variabel lingkungan yang dimasukkan ke dalam container workload agar workload mengirim sinyal ke kolektor terkelola. Jika Anda mengonfigurasi workload secara manual, Anda dapat menggunakan metode lain. Untuk mengetahui detailnya, lihat Konfigurasi manual.

Saat menggunakan konfigurasi otomatis, Anda menentukan konfigurasi menggunakan resource kustom Instrumentasi. Kemudian, GKE memasukkan variabel lingkungan, seperti endpoint pengekspor OTLP, ke dalam container workload. Jika container workload memiliki variabel lingkungan ini, maka saat workload berjalan, data OpenTelemetry akan dikirim ke kolektor terkelola.

Konfigurasi otomatis tersedia untuk workload yang mendukung OpenTelemetry secara native, yang berarti workload tersebut menggunakan OpenTelemetry SDK dan dikonfigurasi menggunakan variabel lingkungan OpenTelemetry standar. Untuk mengetahui detail selengkapnya, lihat Workload yang didukung.

Untuk mengetahui petunjuk cara mengonfigurasi aplikasi menggunakan konfigurasi otomatis, lihat Mengonfigurasi aplikasi untuk menggunakan Managed OpenTelemetry Collector.

Resource kustom Instrumentation

Anda menggunakan resource kustom Instrumentasi untuk melakukan hal berikut:

  • Tentukan apakah akan memasukkan variabel lingkungan ke dalam container Pod yang dipilih atau semua Pod dalam namespace.
  • Mengontrol jenis data yang dikumpulkan (log, metrik, dan trace).
  • Mengontrol frekuensi pengiriman data metrik ke kolektor terkelola.
  • Mengontrol frekuensi sampling data trace.
  • Kontrol protokol transport OTLP (HTTP atau gRPC) yang digunakan untuk mengekspor telemetri ke kolektor terkelola.

Untuk mengetahui detail tentang cara menggunakan resource kustom Instrumentasi, lihat Mengubah konfigurasi.

Memasukkan variabel lingkungan secara otomatis

Untuk memasukkan variabel lingkungan OpenTelemetry ke workload GKE Anda secara otomatis, Anda perlu mengonfigurasi objek Instrumentasi di cluster Anda. Kemudian, saat Anda men-deploy aplikasi di cluster dengan objek Instrumentation, variabel tersebut akan dimasukkan oleh GKE.

Objek Instrumentasi harus berada di cluster saat aplikasi di-deploy dan Pod dibuat. Jika Anda men-deploy aplikasi sebelum membuat objek Instrumentasi, Anda harus memulai ulang pod aplikasi untuk memicu injeksi otomatis variabel lingkungan.

Variabel lingkungan

Saat workload di-deploy ke namespace tempat konfigurasi otomatis diaktifkan, GKE akan memasukkan variabel lingkungan ke dalam container workload. Variabel lingkungan ini adalah variabel OpenTelemetry dari Konfigurasi SDK OpenTelemetry.

Daftar berikut berisi semua variabel lingkungan yang dapat diinjeksikan oleh OpenTelemetry Terkelola untuk GKE. Variabel lingkungan tertentu yang dimasukkan ke container bergantung pada konfigurasi di resource kustom Instrumentasi.

Variabel lingkungan yang dapat dimasukkan secara otomatis ke dalam container adalah sebagai berikut:

  • Endpoint dan protokol pengekspor OpenTelemetry.
    • OTEL_EXPORTER_OTLP_ENDPOINT: URL endpoint dasar untuk semua jenis sinyal. Bergantung pada pengekspor yang dikonfigurasi di resource kustom Instrumentasi, nilai variabel lingkungan ini adalah endpoint HTTP kolektor OpenTelemetry terkelola dalam cluster (http://opentelemetry-collector.gke-managed-otel.svc.cluster.local:4318, default) atau endpoint gRPC (http://opentelemetry-collector.gke-managed-otel.svc.cluster.local:4317).
    • OTEL_EXPORTER_OTLP_PROTOCOL: Menentukan protokol transport OTLP yang digunakan oleh pengekspor SDK. Nilai variabel lingkungan ini adalah salah satu dari berikut ini, bergantung pada protokol transportasi OTLP yang Anda gunakan:
      • grpc jika Anda menggunakan protokol transpor otlp_grpc.
      • http/protobuf jika Anda tidak menentukan protokol transpor atau jika Anda menggunakan protokol transpor otlp_http.
  • Konfigurasi rasio sampling trace.
    • OTEL_TRACES_SAMPLER: Menetapkan sampler yang digunakan untuk mengambil sampel trace oleh SDK ke salah satu dari berikut ini:
      • parentbased_traceidratio saat pengambilan sampel trace dikonfigurasi di resource kustom.
      • parentbased_always_on adalah nilai default variabel lingkungan ini. Variabel ini digunakan jika variabel lingkungan ini tidak dikonfigurasi atau bernilai null dalam resource kustom.
    • OTEL_TRACES_SAMPLER_ARG: Menentukan rasio sampling trace (antara 0,0 dan 1,0). Jika tidak dikonfigurasi di resource kustom, maka 1.0 akan digunakan.
  • Interval penundaan antara awal dua ekspor metrik berturut-turut.
    • OTEL_METRIC_EXPORT_INTERVAL: Interval waktu (dalam milidetik) antara awal dua upaya ekspor (min: 5.000, maks: 300.000, default: 30.000).
  • Penonaktifan ekspor telemetri OTLP menurut jenis sinyal. Pengekspor sinyal dinonaktifkan saat tracer_provider, meter_provider, atau logger_provider ditetapkan ke null di resource kustom Instrumentasi.
    • OTEL_TRACES_EXPORTER: Menonaktifkan ekspor trace jika ditetapkan ke none. Nilai default: otlp.
    • OTEL_METRICS_EXPORTER: Menonaktifkan ekspor metrik jika ditetapkan ke none. Nilai default: otlp.
    • OTEL_LOGS_EXPORTER: Menonaktifkan ekspor log jika ditetapkan ke none. Nilai default: otlp.
  • Identifikasi Pod hostNetwork untuk mengaitkan metadata oleh Kubernetes Attributes Processor dari OpenTelemetry Collector.
    • K8S_POD_UID: UID Pod dari Pod hostNetwork untuk mengisi setelan k8s.pod.uid dalam variabel lingkungan OTEL_RESOURCE_ATTRIBUTES.
    • OTEL_RESOURCE_ATTRIBUTES: Nilainya mencakup k8s.pod.uid=$(K8S_POD_UID) untuk memungkinkan Pemroses Atribut Kubernetes mengaitkan metadata, seperti k8s.namespace.name, k8s.deployment.name, dan k8s.node.name, ke Pod hostNetwork. Pengaitan metadata dan Pod hostNetwork memungkinkan penambahan metadata yang diekstrak ke span, metrik, dan log sebagai atribut resource.
  • Perintah dan respons.
    • OTEL_INSTRUMENTATION_GENAI_UPLOAD_FORMAT='jsonl': Menginstruksikan OpenTelemetry untuk memformat objek Cloud Storage sebagai JSON Lines. Variabel lingkungan ini memiliki nilai tetap: jsonl.
    • OTEL_INSTRUMENTATION_GENAI_COMPLETION_HOOK='upload': Menginstruksikan OpenTelemetry untuk mengupload data perintah dan respons, bukan menyematkan konten ini dalam span trace. Referensi ke objek yang diupload disertakan dalam entri log. Variabel lingkungan ini memiliki nilai tetap: upload.
    • OTEL_SEMCONV_STABILITY_OPT_IN='gen_ai_latest_experimental': Menginstruksikan OpenTelemetry untuk menggunakan konvensi semantik terbaru untuk AI generatif. Variabel lingkungan ini memiliki nilai tetap: gen_ai_latest_experimental.
    • OTEL_INSTRUMENTATION_GENAI_UPLOAD_BASE_PATH: Tentukan jalur untuk objek. Misalnya, gs://STORAGE_BUCKET_NAME/PATH

Konfigurasi manual

Ada berbagai metode yang dapat Anda gunakan untuk mengonfigurasi workload agar mengirim sinyal ke endpoint kolektor terkelola. Jika mengonfigurasi workload secara manual, Anda dapat menambahkan dan mengubah variabel lingkungan secara manual, atau menggunakan metode lain seperti flag command line.

Sebaiknya jangan gunakan konfigurasi manual dan konfigurasi otomatis secara bersamaan untuk workload yang sama, karena konfigurasi otomatis dapat mengganti perubahan manual. Kombinasi ini mungkin akan mempersulit pelacakan perubahan pada konfigurasi.

Untuk mengetahui detail tentang konfigurasi otomatis, lihat Konfigurasi otomatis.

Workload yang didukung

Workload yang didukung adalah workload yang menggunakan OpenTelemetry untuk mengumpulkan data tentang perilaku runtime aplikasi. Workload mendukung OpenTelemetry secara native jika menggunakan OpenTelemetry SDK dan dikonfigurasi menggunakan variabel lingkungan OpenTelemetry standar. Misalnya, Agent Development Kit (ADK) mendukung OpenTelemetry secara native.

Untuk mengetahui detail selengkapnya tentang cara data perilaku runtime aplikasi Anda dibuat dan dikumpulkan, lihat Kemampuan observasi untuk developer aplikasi.

Jika workload mendukung beberapa jenis data OTLP dan tidak mendukung jenis data lainnya, OpenTelemetry Terkelola untuk GKE akan mengumpulkan data OTLP. Misalnya, jika workload menggunakan OpenTelemetry SDK untuk mengimplementasikan trace, tetapi tidak menggunakannya untuk log atau metrik, data log dan metrik tidak akan dikumpulkan oleh Managed OpenTelemetry untuk GKE. Untuk mengetahui detail tentang cara mengontrol jenis data yang akan dikumpulkan, lihat Memilih jenis sinyal yang akan dikumpulkan.

Injeksi konfigurasi OpenTelemetry tidak didukung untuk workload dengan hak istimewa dari partner GKE Autopilot.

Penagihan

Saat Anda mengirim data telemetri ke Google Cloud, Anda akan ditagih berdasarkan volume penyerapan. Metrik ditagih menggunakan harga Google Cloud Managed Service for Prometheus, log ditagih menggunakan harga Cloud Logging, dan trace ditagih menggunakan harga Cloud Trace.

Untuk mengetahui informasi tentang biaya yang terkait dengan penyerapan trace, log, dan metrik Google Cloud Managed Service for Prometheus, lihat Harga Google Cloud Observability.

Kuota

Saat Anda menggunakan Managed OpenTelemetry untuk GKE, kuota untuk layanan Google Cloud Observability akan berlaku. Untuk mengetahui detailnya, lihat referensi berikut:

Langkah berikutnya