Untuk menjaga kode aplikasi Anda tetap netral terhadap vendor saat mengumpulkan dan mengirim 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 mengirim data metrik dan trace data dalam format OpenTelemetry Protocol (OTLP) ke your Google Cloud project menggunakan Telemetry API, dan mengirim data log menggunakan a Google Cloud pengekspor.
Cara kerja contoh
Contoh untuk Go, Java, Node.js, dan Python menggunakan
protokol OpenTelemetry untuk mengumpulkan data metrik dan trace.
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 melakukan instrumentasi aplikasi dengan OpenTelemetry.
Anda dapat menjalankan contoh di Cloud Shell, di Google Cloud resource, atau di lingkungan pengembangan lokal.
Pembahasan mendalam
Contoh menggunakan OpenTelemetry Collector sebagai sidecar untuk menerima dan memperkaya telemetri aplikasi, yang kemudian dikirim oleh pengekspor ke your Google Cloud project. Aplikasi contoh mengirim data metrik dan trace ke project Anda menggunakan Telemetry API, yang mendukung format OTLP.
Contoh menunjukkan cara melakukan hal berikut:
Mengonfigurasi OpenTelemetry untuk mengumpulkan metrik dan trace menggunakan OpenTelemetry pengumpul.
Kompleksitas langkah ini bergantung pada bahasa. Misalnya, di Go, Anda memperbarui fungsi
mainuntuk menginisialisasi pengumpulan telemetri dan mengonfigurasi server dan klien HTTP.Mengonfigurasi 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 dapat mengindeks kolom tertentu dalam payload log.
Beberapa layanan, seperti Google Kubernetes Engine, memiliki agen bawaan yang meng-scrape log terstruktur dan mengirim log tersebut ke your Google Cloud project. Layanan lain, 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 contoh ini.
Mengonfigurasi file Docker. Semua contoh 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 lingkunganOTEL_EXPORTER_OTLP_ENDPOINT, yang ditentukan dalam layananapp.otel-collector-config.yaml: Mengonfigurasi pengumpul OpenTelemetry:Contoh menggunakan penerima
otlpuntuk data metrik dan trace, serta penerimafileloguntuk data log.Contoh menggunakan pengekspor
otlphttpuntuk data metrik dan trace, serta Google Cloud pengekspor untuk data log.Pengekspor
otlphttpmengirim data ke project Anda menggunakan Telemetry API, yang mendukung OTLP. The Google Cloud pengekspor mengonversi data log Anda ke dalam format yang kompatibel dengan Cloud Logging API, lalu mengirim data yang diubah ke Google Cloud project Anda.
docker-compose.creds.yaml: File ini secara opsional memasang file Google Cloud kredensial di containerotelcol. Anda memerlukan file ini saat menjalankan contoh di mesin lokal tempat Kredensial Default Aplikasi (ADC) hanya tersedia sebagai file.
Izin yang diperlukan
-
Untuk mendapatkan izin yang Anda perlukan agar aplikasi contoh dapat menulis data log, metrik, dan trace, minta administrator Anda 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 cukup jika Anda menjalankan contoh di Cloud Shell, di Google Cloud resource, 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 trace, minta administrator Anda untuk memberi Anda peran IAM berikut di project Anda:
- Logs Viewer (
roles/logging.viewer) - Monitoring Viewer (
roles/monitoring.viewer) - Cloud Trace User (
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:
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
Service Usage Admin (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 konfigurasi yang berbeda:
Bermigrasi dari pengekspor Trace ke endpoint OTLP menjelaskan cara menggunakan instrumentasi dalam proses untuk mengirim data trace langsung ke your Google Cloud project.
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 mengirim data langsung ke Google Cloud project Anda.
Mengorelasikan metrik dan trace menggunakan contoh menjelaskan cara mengonfigurasi aplikasi Go untuk membuat contoh. Contoh adalah titik data contoh yang dilampirkan ke titik data metrik. Anda dapat menggunakan contoh untuk mengorelasikan data trace dan metrik.
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 pengumpul lebih lanjut, lihat Pengumpul OpenTelemetry Buatan Google.
Pelajari contoh yang menggunakan ekspor berbasis pengumpul.