Memilih pendekatan instrumentasi

Halaman ini berisi rekomendasi untuk melakukan instrumentasi aplikasi Anda di berbagai platform Google Cloud, seperti Google Kubernetes Engine (GKE) dan Cloud Run. Jika aplikasi Anda belum dilengkapi dengan instrumen, gunakan rekomendasi ini sebagai panduan tentang cara melengkapi aplikasi Anda dengan instrumen untuk mengirim data telemetri ke Google Cloud. Rekomendasi di halaman ini bukan satu-satunya solusi, dan pendekatan lainnya dapat berhasil. Untuk panduan tambahan, hubungi Dukungan Google Cloud.

Ada rekomendasi untuk hal berikut:

Untuk informasi tentang contoh instrumentasi, lihat dokumen yang tercantum di bagian Contoh kode.

GKE

Untuk informasi umum tentang GKE, lihat Ringkasan GKE.

Jenis Rekomendasi
Metrik

Sebaiknya gunakan Google Cloud Managed Service for Prometheus.

Untuk instrumentasi, lakukan salah satu hal berikut:
Trace

Lakukan tindakan berikut:

  1. Gunakan OpenTelemetry SDK dan eksportir OTLP untuk bahasa Anda.
  2. Konfigurasi kolektor OpenTelemetry untuk mengirim trace OTLP ke Google Cloud.
Log

Konfigurasikan aplikasi Anda untuk menghasilkan log terstruktur JSON ke stdout dan stderr. Untuk mengetahui daftar framework, lihat Framework logging yang direkomendasikan.

GKE mengumpulkan log yang ditulis ke stdout dan stderr secara otomatis. Untuk mengetahui informasi selengkapnya, lihat Tentang log GKE.

Compute Engine

Untuk informasi umum tentang Compute Engine, lihat Instance virtual machine.

Jenis Rekomendasi
Metrik dan Rekaman Aktivitas

Lakukan tindakan berikut:

  1. Gunakan OpenTelemetry SDK dan eksportir OTLP untuk bahasa Anda.
  2. Gunakan Agen Operasional untuk mengumpulkan metrik dan rekaman aktivitas. Sebagai contoh, lihat Mengumpulkan metrik dan trace OpenTelemetry Protocol (OTLP).

Atau, jika hanya ingin mengonfigurasi pengumpulan untuk metrik berformat Prometheus, Anda dapat menggunakan Ops Agent Prometheus Receiver untuk mengumpulkan metrik yang diinstrumentasi menggunakan library klien Prometheus atau OpenTelemetry SDK.
Log

Lakukan tindakan berikut:

  1. Konfigurasikan aplikasi Anda untuk menghasilkan log berstruktur JSON ke file. Untuk mengetahui daftar framework, lihat Framework logging yang direkomendasikan.
  2. Instal Agen Operasional dan konfigurasikan penerima. Untuk contoh, lihat Penerima logging.

Cloud Run

Untuk informasi umum tentang Cloud Run, lihat Apa itu Cloud Run.

Jenis Rekomendasi
Metrik dan Rekaman Aktivitas

Lakukan tindakan berikut:

  1. Gunakan OpenTelemetry SDK dan eksportir OTLP untuk bahasa Anda.
  2. Konfigurasikan file bantuan OpenTelemetry untuk mengumpulkan metrik dan trace. Untuk contoh, lihat Menulis metrik OTLP menggunakan file bantuan OpenTelemetry.
  3. Tetapkan CPU agar selalu dialokasikan di Cloud Run. Karena instrumentasi OpenTelemetry melakukan pemrosesan latar belakang, sebaiknya layanan Cloud Run berinstrumen menggunakan CPU yang selalu dialokasikan; untuk informasi selengkapnya, lihat Alokasi CPU (layanan).

Atau, jika Anda hanya ingin mengonfigurasi pengumpulan untuk metrik berformat Prometheus, Anda dapat menggunakan sidecar Prometheus untuk Cloud Run guna mengumpulkan metrik yang diinstrumentasi menggunakan library klien Prometheus atau OpenTelemetry SDK.
Log

Konfigurasikan aplikasi Anda untuk menghasilkan log terstruktur JSON ke stdout dan stderr. Untuk mengetahui daftar framework, lihat Framework logging yang direkomendasikan.

Cloud Run mengumpulkan log yang ditulis ke stdout dan stderr secara otomatis. Untuk mengetahui informasi selengkapnya, lihat Menulis log penampung.

Fungsi Cloud Run

Untuk informasi umum tentang fungsi Cloud Run, lihat Ringkasan fungsi Cloud Run.

Jenis Rekomendasi
Metrik Penulisan langsung metrik tidak didukung di fungsi Cloud Run. Untuk membuat metrik, sebaiknya gunakan metrik berbasis log.
Trace Gunakan SDK dan pengekspor Cloud Trace untuk bahasa Anda.
Log

Konfigurasikan aplikasi Anda untuk menghasilkan log terstruktur JSON ke stdout dan stderr. Untuk mengetahui daftar framework, lihat Framework logging yang direkomendasikan.

Fungsi Cloud Run mengumpulkan log yang ditulis ke stdout dan stderr secara otomatis. Untuk informasi selengkapnya, lihat Melihat dan menulis log fungsi Cloud Run.

App Engine

Untuk informasi umum tentang App Engine, lihat Ringkasan App Engine.

Jenis Rekomendasi
Metrik Gunakan SDK dan pengekspor Cloud Monitoring untuk bahasa Anda.
Trace Gunakan SDK dan pengekspor Cloud Trace untuk bahasa Anda.
Log

Konfigurasikan aplikasi Anda untuk menghasilkan log terstruktur JSON ke stdout dan stderr. Untuk mengetahui daftar framework, lihat Framework logging yang direkomendasikan.

App Engine mengumpulkan log yang ditulis ke stdout dan stderr secara otomatis. Untuk informasi selengkapnya, lihat Menulis dan melihat log.

Framework logging yang direkomendasikan

Untuk mengumpulkan log, sebaiknya gunakan framework yang dapat dikonfigurasi untuk menghasilkan objek JSON serial ke stdout, stderr, atau ke file. Agen logging, baik yang terintegrasi maupun diinstal, akan mengambil file dan menulis log terstruktur untuk Cloud Logging. Untuk menulis data log, sebaiknya lakukan hal berikut:

Contoh kode

Untuk contoh kode yang menggambarkan cara melengkapi aplikasi Anda untuk mengirim telemetri ke Google Cloud, lihat hal berikut:

Referensi ke OpenTelemetry

Bagian ini menyediakan link ke OpenTelemetry SDK, dan eksportir untuk OTLP, Cloud Trace, dan Cloud Monitoring.

Referensi umum:

Go

Java

JavaScript

Python