Untuk menjaga agar kode aplikasi Anda tetap netral terhadap vendor saat mengumpulkan dan mengirimkan telemetri ke Google Cloud, Anda dapat menggunakan contoh instrumentasi berbasis pengumpul OpenTelemetry untuk Go, Java, Node.js, dan Python.
Contoh ini menunjukkan cara mengonfigurasi OpenTelemetry SDK dalam proses untuk mengekspor metrik, log, dan trace ke pengumpul OpenTelemetry lokal yang merutekan telemetri Anda ke Google Cloud. Contoh mengirimkan data metrik dan trace dalam format OpenTelemetry Protocol (OTLP) ke project Google Cloud Anda menggunakan Telemetry API, dan mengirimkan data log menggunakan eksportir Google Cloud .
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 mengonfigurasi
pengumpul OpenTelemetry untuk membaca dari
aliran stdout aplikasi. Untuk rekomendasi framework, lihat
Memilih pendekatan instrumentasi.
Aplikasi dibangun dan di-deploy menggunakan Docker. Anda tidak harus 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:
Konfigurasi OpenTelemetry untuk mengumpulkan metrik dan trace menggunakan OpenTelemetry Collector.
Kompleksitas langkah ini bergantung pada bahasa. Misalnya, di Go, Anda memperbarui fungsi
mainuntuk menginisialisasi pengumpulan telemetri dan mengonfigurasi server dan klien HTTP.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 Google Cloud Anda. Layanan lainnya, seperti Compute Engine, mengharuskan Anda menginstal agen, yang meng-scrape dan mengirim log Anda. Untuk mempelajari agen yang Anda instal, lihat Ringkasan Agen Operasional.
Anda tidak perlu menginstal agen apa pun untuk menggunakan sampel ini.
Konfigurasi file Docker. Semua sampel berisi file YAML berikut:
docker-compose.yaml: Mengonfigurasi layanan untuk aplikasi, OpenTelemetry Collector, dan generator beban. Misalnya, layanan untuk pengumpul OpenTelemetry,otelcol, menentukan image, volume, dan variabel lingkungan. Endpoint untuk pengumpul OpenTelemetry ditetapkan oleh variabel lingkunganOTEL_EXPORTER_OTLP_ENDPOINT, yang ditentukan dalam layananapp.otel-collector-config.yaml: Mengonfigurasi OpenTelemetry Collector:Contoh menggunakan penerima
otlpuntuk data metrik dan rekaman aktivitas, serta penerimafileloguntuk data log.Contoh menggunakan eksportir
otlphttpuntuk data metrik dan rekaman aktivitas, serta eksportir Google Cloud untuk data log.Pengekspor
otlphttpmengirim data ke project Anda menggunakan Telemetry API, yang mendukung OTLP. Pengekspor Google Cloud mengonversi data log Anda ke dalam format yang kompatibel dengan Cloud Logging API, lalu mengirimkan data yang telah diubah ke projectGoogle Cloud Anda.
docker-compose.creds.yaml: File ini secara opsional memasang file kredensial Google Cloud di containerotelcol. 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 Google Cloud , atau di lingkungan pengembangan lokal. Untuk mempelajari cara mengonfigurasi project kuota, lihat Menetapkan project kuota.
- Logs Writer (
-
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.
- Logs Viewer (
API yang diperlukan
Aktifkan Cloud Logging, Cloud Monitoring, Cloud Trace, dan Telemetry API, jika ada yang belum diaktifkan:
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.commonitoring.googleapis.com cloudtrace.googleapis.com telemetry.googleapis.com
Pendekatan instrumentasi alternatif
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 Google Cloud project 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.
Langkah berikutnya
Untuk mempelajari lebih lanjut pengumpul, lihat Google-Built OpenTelemetry Collector.
Pelajari contoh yang menggunakan ekspor berbasis pengumpul.