Menggunakan Telemetry API

Dokumen ini menjelaskan cara mengonfigurasi Agen Operasional untuk menggunakan Telemetry (OTLP) API, telemetry.googleapis.com. Telemetry API adalah implementasi OpenTelemetry Line Protocol open source. Saat Anda mengaktifkan fitur ini, Agen Operasional akan mengirim log dan metrik ke project Anda menggunakan Telemetry API, bukan Cloud Monitoring API dan Cloud Logging API eksklusif. Google Cloud

Jika Anda menggunakan Telemetry API di Agen Operasional dan memiliki diagram atau kebijakan pemberitahuan yang memantau penggunaan API Anda, Anda harus memperbarui artefak ini untuk memantau endpoint telemetry.googleapis.com, bukan endpoint monitoring.googleapis.com atau logging.googleapis.com.

Sebelum memulai

Untuk menggunakan Telemetry API, lakukan hal berikut:

  1. Aktifkan Telemetry API di Google Cloud project Anda, jika belum diaktifkan. Anda dapat mengaktifkan API dengan menjalankan perintah berikut:

    gcloud services enable telemetry.googleapis.com

  2. Sesuaikan kuota Telemetry API, jika nilai default tidak mencukupi. Telemetry API memiliki kuota yang terpisah dari Cloud Monitoring API dan Cloud Logging API. Untuk mengetahui informasi tentang kuota dan batas Telemetry API, lihat hal berikut:

    Anda mungkin perlu menyesuaikan kuota ini untuk mengakomodasi volume data telemetri yang Anda serap.

Mengonfigurasi Agen Operasional untuk menggunakan Telemetry API

Selama periode Pratinjau, penggunaan Telemetry API oleh Agen Operasional dikontrol oleh variabel lingkungan, EXPERIMENTAL_FEATURES. Untuk mengumpulkan telemetri menggunakan Agen Operasional dan Telemetry API, Anda harus melakukan hal berikut, seperti yang dijelaskan di bagian berikut:

  1. Instal versi Agen Operasional yang mendukung Telemetry API.
  2. Tetapkan variabel lingkungan EXPERIMENTAL_FEATURES.
  3. Mulai ulang Agen Operasional untuk menerapkan perubahan.

Menggunakan Agen Operasional versi 2.66.0 atau yang lebih baru

Untuk menggunakan Telemetry API dengan Agen Operasional, Anda harus menginstal Agen Operasional versi 2.66.0 atau yang lebih baru. Untuk mengetahui informasi tentang cara menginstal Agen Operasional, lihat Menginstal Agen Operasional VM individual.

Menetapkan variabel lingkungan

Berikan akses Agen Operasional ke Telemetry API dengan menetapkan variabel lingkungan EXPERIMENTAL_FEATURES ke nilai otlp_exporter, seperti yang ditunjukkan pada tab berikut:

Linux

Untuk mengubah lingkungan Agen Operasional, jalankan perintah berikut di instance Anda:

for service in \
        google-cloud-ops-agent \
        google-cloud-ops-agent-fluent-bit \
        google-cloud-ops-agent-opentelemetry-collector \
        ; do
        sudo mkdir -p "/etc/systemd/system/${service}.service.d"
        echo -e '[Service]\nEnvironment="EXPERIMENTAL_FEATURES=otlp_exporter"' | sudo tee "/etc/systemd/system/${service}.service.d/otlp_exporter.conf"
done
sudo systemctl daemon-reload

Windows

Untuk mengubah lingkungan Agen Operasional, lakukan langkah-langkah berikut:

  1. Hubungkan ke instance Anda menggunakan RDP atau alat serupa dan login ke Windows.
  2. Buka terminal PowerShell dengan hak istimewa administrator dengan mengklik kanan ikon PowerShell dan memilih Run as Administrator
  3. Tetapkan variabel lingkungan EXPERIMENTAL_FEATURES dengan menjalankan perintah PowerShell berikut: 
    setx EXPERIMENTAL_FEATURES "otlp_exporter" /M

Memulai ulang Agen Operasional

Linux

  1. Untuk memulai ulang agen, jalankan perintah berikut di instance Anda: 
    sudo systemctl restart google-cloud-ops-agent
  2. Untuk mengonfirmasi bahwa agen telah dimulai ulang, jalankan perintah berikut dan pastikan komponen "Metrics Agent" dan "Logging Agent" telah dimulai: 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. Hubungkan ke instance Anda menggunakan RDP atau alat serupa dan login ke Windows.
  2. Buka terminal PowerShell dengan hak istimewa administrator dengan mengklik kanan ikon PowerShell dan memilih Run as Administrator
  3. Untuk memulai ulang agen, jalankan perintah PowerShell berikut: 
    Restart-Service google-cloud-ops-agent -Force
  4. Untuk mengonfirmasi bahwa agen telah dimulai ulang, jalankan perintah berikut dan pastikan komponen "Metrics Agent" dan "Logging Agent" telah dimulai: 
    Get-Service google-cloud-ops-agent*

Mengonfigurasi Agen Operasional agar tidak menggunakan Telemetry API

Untuk menghentikan Agen Operasional mengumpulkan telemetri menggunakan Telemetry API dan melanjutkan pengumpulan telemetri menggunakan Cloud Monitoring API dan Cloud Logging API, Anda harus melakukan hal berikut:

  1. Batalkan setelan variabel lingkungan EXPERIMENTAL_FEATURES.

    Linux

    Untuk mengubah lingkungan Agen Operasional, jalankan perintah berikut di instance Anda:

    sudo find /etc/systemd/system -name otlp_exporter.conf | sudo xargs rm
sudo systemctl daemon-reload

    Windows

    Untuk mengubah lingkungan Agen Operasional, lakukan langkah-langkah berikut:

    1. Hubungkan ke instance Anda menggunakan RDP atau alat serupa dan login ke Windows.
    2. Buka terminal PowerShell dengan hak istimewa administrator dengan mengklik kanan ikon PowerShell dan memilih Run as Administrator
    3. Hapus variabel lingkungan EXPERIMENTAL_FEATURES dengan menjalankan perintah PowerShell berikut: 
      REG delete "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /F /V EXPERIMENTAL_FEATURES

  2. Mulai ulang Agen Operasional untuk menerapkan perubahan.

Langkah berikutnya