Ringkasan contoh instrumentasi berbasis pengumpul

Dokumen ini menjelaskan struktur contoh instrumentasi yang disediakan untuk bahasa Go, Java, Node.js, dan Python. Contoh ini memberikan panduan tentang cara menginstrumentasi aplikasi untuk menggunakan SDK OpenTelemetry dan pengumpul OpenTelemetry.

Pengukuran dalam contoh ini, yang mencakup penggunaan OpenTelemetry SDK dan pengekspor OTLP dalam proses SDK, bersifat netral terhadap vendor. Pengekspor dalam proses mengirimkan telemetri ke pengumpul OpenTelemetry, yang menerima data tersebut, lalu mengirimkannya ke project Google Cloud Anda. Pengumpul berisi binding ke Google Cloud. Contoh ini menggunakan pengekspor Google Cloud untuk mengirim data log dan metrik ke project Anda. Namun, mereka mengirim data rekaman aktivitas ke project Anda menggunakan Telemetry API.

Anda mungkin tertarik dengan contoh lain yang menggambarkan berbagai konfigurasi:

• Bermigrasi dari eksportir Trace ke endpoint OTLP menjelaskan cara menggunakan instrumentasi dalam proses untuk mengirim data trace langsung ke project Google Cloud Anda.

  Sebaiknya gunakan pengumpul OpenTelemetry untuk mengekspor data telemetri Anda jika lingkungan Anda mendukung penggunaan pengumpul. Jika Anda tidak dapat menggunakan pengumpul, Anda harus menggunakan pengekspor dalam proses yang mengirimkan data secara langsung ke project Google Cloud Anda.

• Mengorelasikan metrik dan rekaman aktivitas menggunakan contoh menjelaskan cara mengonfigurasi aplikasi Go untuk membuat contoh. Contoh adalah contoh titik data yang dilampirkan ke titik data metrik. Anda dapat menggunakan contoh untuk mengorelasikan data metrik dan rekaman aktivitas.

• Menggunakan Agen Operasional dan OpenTelemetry Protocol (OTLP) menjelaskan cara mengonfigurasi Agen Operasional dan penerima OTLP untuk mengumpulkan metrik dan trace dari aplikasi.

Catatan: Contoh hanya menampilkan bagian aplikasi yang berfungsi yang dipilih. Misalnya, contoh tidak menampilkan daftar paket yang diimpor. Namun, aplikasi lengkapnya tersedia di GitHub. Dari cuplikan kode, Anda dapat membuka GitHub menggunakan opsi Lainnya.

Cara kerja sampel

Contoh untuk Go, Java, Node.js, dan Python menggunakan protokol OpenTelemetry untuk mengumpulkan data trace dan metrik. Contoh mengonfigurasi framework logging untuk menulis log terstruktur dan pengumpul OpenTelemetry dikonfigurasi untuk membaca dari aliran stdout aplikasi. Untuk rekomendasi framework, lihat Memilih pendekatan instrumentasi.

Aplikasi dibangun dan di-deploy menggunakan Docker. Anda tidak perlu menggunakan Docker saat menginstrumentasi aplikasi dengan OpenTelemetry.

Anda dapat menjalankan contoh di Cloud Shell, di resource Google Cloud, atau di lingkungan pengembangan lokal.

Pembahasan mendalam

Contoh ini menggunakan OpenTelemetry Collector sebagai file bantuan untuk menerima dan memperkaya telemetri aplikasi, yang kemudian dikirim oleh eksportir ke project Google Cloud Anda. Aplikasi contoh mengirimkan data metrik dan trace ke project Anda menggunakan Telemetry API, yang mendukung format OTLP.

Contoh menunjukkan cara melakukan hal berikut:

1. Konfigurasi OpenTelemetry untuk mengumpulkan metrik dan trace menggunakan OpenTelemetry Collector.

   Kompleksitas langkah ini bergantung pada bahasa. Misalnya, untuk Go, langkah ini mengonfigurasi fungsi main untuk memanggil fungsi yang mengonfigurasi pengumpulan metrik dan trace. Untuk Go, server dan klien HTTP juga diperbarui.

2. Konfigurasi framework logging untuk menulis log terstruktur.

   Sebaiknya aplikasi Anda menulis log terstruktur, yang memformat payload log sebagai objek JSON. Untuk log ini, Anda dapat membuat kueri yang menelusuri jalur JSON tertentu dan mengindeks kolom tertentu dalam payload log.

   Beberapa layanan, seperti Google Kubernetes Engine, memiliki agen bawaan yang meng-scrape log terstruktur dan mengirimkan log tersebut ke project Anda. Google Cloud Layanan lainnya, seperti Compute Engine, mengharuskan Anda menginstal agen, yang meng-scrape dan mengirimkan log Anda. Untuk mempelajari agen yang Anda instal, lihat Ringkasan Agen Operasional.

   Anda tidak perlu menginstal agen apa pun untuk menggunakan contoh ini.

3. Konfigurasi file Docker. Semua sampel berisi file YAML berikut:

   • docker-compose.yaml: Mengonfigurasi layanan untuk aplikasi, pengumpul OpenTelemetry, dan generator beban. Misalnya, layanan untuk pengumpul OpenTelemetry, otelcol, menentukan image, volume, dan variabel lingkungan. Endpoint untuk pengumpul OpenTelemetry ditetapkan oleh variabel lingkungan OTEL_EXPORTER_OTLP_ENDPOINT, yang ditentukan dalam layanan app.

   • otel-collector-config.yaml: Mengonfigurasi OpenTelemetry:

     • Contoh menggunakan penerima otlp untuk data metrik dan rekaman aktivitas, dan penerima filelog untuk data log.

     • Contoh menggunakan eksportir otlphttp untuk data metrik dan rekaman aktivitas, serta eksportir Google Cloud untuk data log.

       Pengekspor otlphttp mengirim data ke project Anda menggunakan Telemetry API, yang mendukung OTLP. Exporter Google Cloud mengonversi data log Anda ke dalam format yang kompatibel dengan Cloud Logging API, lalu mengirimkan data yang telah diubah ke project Google Cloud Anda dengan mengeluarkan perintah API.

   • docker-compose.creds.yaml: File ini secara opsional memasang file kredensial Google Cloud di penampung otelcol. Anda memerlukan file ini saat menjalankan contoh di komputer lokal tempat Kredensial Default Aplikasi (ADC) hanya tersedia sebagai file.

Izin yang diperlukan

• Untuk mendapatkan izin yang diperlukan agar aplikasi contoh dapat menulis data log, metrik, dan aktivitas, minta administrator untuk memberi Anda peran IAM berikut:

  • Logs Writer (roles/logging.logWriter) di project Anda
  • Monitoring Metric Writer (roles/monitoring.metricWriter) di project Anda
  • Cloud Telemetry Traces Writer (roles/telemetry.tracesWriter) di project Anda
  • Service Usage Consumer (roles/serviceusage.serviceUsageConsumer) di project kuota Anda

  Izin ini sudah cukup jika Anda menjalankan contoh di Cloud Shell, di resource, atau di lingkungan pengembangan lokal. Google Cloud Untuk mempelajari cara mengonfigurasi project kuota, lihat Menetapkan project kuota.

  Catatan: Aplikasi produksi biasanya mengandalkan akun layanan untuk memberikan kredensial yang diperlukan untuk menulis data log, metrik, dan rekaman aktivitas. Dalam skenario tersebut, berikan peran sebelumnya ke akun layanan.

• Untuk mendapatkan izin yang Anda perlukan untuk melihat data log, metrik, dan rekaman aktivitas, minta administrator untuk memberi Anda peran IAM berikut di project Anda:

  • Logs Viewer (roles/logging.viewer)
  • Monitoring Viewer (roles/monitoring.viewer)
  • Pengguna Cloud Trace (roles/cloudtrace.user)

  Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

  Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

API yang diperlukan

Aktifkan Cloud Logging, Cloud Monitoring, Cloud Trace, dan Telemetry API:

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan izin serviceusage.services.enable. Jika Anda membuat project, kemungkinan Anda sudah memiliki izin ini melalui peran Pemilik (roles/owner). Jika tidak, Anda bisa mendapatkan izin ini melalui peran Admin Penggunaan Layanan (roles/serviceusage.serviceUsageAdmin). Pelajari cara memberikan peran.

gcloud services enable logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com telemetry.googleapis.com

Langkah berikutnya

Untuk mempelajari lebih lanjut pengumpul, lihat Pengumpul OpenTelemetry Buatan Google.

Pelajari contoh yang menggunakan ekspor berbasis pengumpul.

• Contoh Go.
• Contoh Java.
• Contoh Node.js.
• Contoh Python.