Ringkasan Telemetry (OTLP) API

Dokumen ini menjelaskan Telemetry (OTLP) API, yang mengimplementasikan OpenTelemetry Protocol. API ini dirancang untuk digunakan dengan aplikasi yang diinstrumentasi menggunakan salah satu SDK OpenTelemetry atau yang menggunakan OpenTelemetry Collector.

OpenTelemetry adalah project open source yang didukung Google Cloud-dengan Google Cloud staf teknisi untuk memastikan dukungan penyerapan dan visualisasi telemetri Anda.

Untuk mempelajari API ini lebih lanjut, lihat dokumen referensi berikut:

Untuk mengetahui informasi tentang kuota yang terkait dengan API, lihat Batas Telemetry API.

Praktik terbaik

Saat menginstrumentasi aplikasi untuk mengirim data rekaman aktivitas ke projectGoogle Cloud , sebaiknya gunakan eksportir yang menulis data berformat OTLP ke Pengumpul, yang kemudian mengirimkan data rekaman aktivitas Anda ke Telemetry API. Di pengumpul Anda, tentukan hanya URL root:

exporters:
  otlphttp:
    encoding: proto
    endpoint: https://telemetry.googleapis.com

OpenTelemetry mendeteksi jenis data dan secara otomatis menambahkan /v1/traces, /v1/metrics, atau /v1/logs sebagaimana mestinya. Untuk mengetahui informasi selengkapnya, lihat Permintaan OTLP/HTTP.

Untuk contoh yang mengekspor data metrik atau rekaman aktivitas ke Telemetry API, lihat dokumen berikut:

Jika tidak dapat menggunakan pengumpul, Anda dapat menggunakan library OpenTelemetry yang berisi eksportir OTLP dalam proses untuk mengirim telemetri ke Telemetry API. Untuk mempelajari cara mengekspor data rekaman aktivitas secara langsung, lihat Pengekspor Cloud Trace ke endpoint OTLP.

Autentikasi

Anda harus mengonfigurasi pengekspor dengan kredensial yang diperlukan untuk mengirim data ke project Google Cloud Anda. Misalnya, saat menggunakan pengumpul, biasanya Anda menggunakan ekstensi googleclientauth untuk mengautentikasi dengan kredensial Google.

Untuk melihat contoh autentikasi saat menggunakan ekspor langsung data rekaman aktivitas, lihat Mengonfigurasi autentikasi. Contoh ini menggambarkan cara mengonfigurasi eksportir dengan Google Cloud Kredensial Default Aplikasi (ADC) dan menambahkan Google Auth Library khusus bahasa ke aplikasi Anda.

Untuk mengirim data telemetri ke project Google Cloud menggunakan Telemetry API, Anda juga harus melakukan hal berikut:

  • Konfigurasi project kuota. Untuk mempelajari lebih lanjut, lihat Menetapkan project kuota.

  • Berikan peran Identity and Access Management (IAM) berikut kepada pengguna atau akun layanan yang digunakan aplikasi:

    • Peran Service Usage Consumer (roles/serviceusage.serviceUsageConsumer) di project kuota.
    • Peran Cloud Telemetry Writer (roles/telemetry.writer) di project. Peran ini memungkinkan aplikasi Anda menulis data log, metrik, dan rekaman aktivitas.

Dukungan Kontrol Layanan VPC

Layanan Telemetry API, yang nama layanannya adalah telemetry.googleapis.com, merupakan layanan yang didukung Kontrol Layanan VPC. Setiap batasan Kontrol Layanan VPC yang Anda buat untuk layanan Telemetry API hanya berlaku untuk layanan tersebut. Batasan tersebut tidak berlaku untuk layanan lain, termasuk layanan seperti cloudtrace.googleapis.com, yang juga dapat menyerap data rekaman aktivitas.

Untuk informasi selengkapnya, lihat referensi berikut:

Endpoint Service

Endpoint layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Telemetry API mendukung endpoint global dan endpoint regional:

  • Endpoint global: telemetry.googleapis.com. Untuk endpoint ini, setelah Google Cloud Observability berhasil menyelesaikan semua langkah validasi, endpoint akan mengirimkan data ke layanan backend untuk penyimpanan.

  • Endpoint regional: telemetry.REGION.rep.googleapis.com, dengan REGION adalah wilayah yang didukung. Untuk endpoint ini, setelah Google Cloud Observability berhasil menyelesaikan semua langkah validasi, Google Cloud Observability akan mengirimkan data ke layanan backend. Layanan ini menyimpan atau menghapus data:

    • Data log dan rekaman aktivitas disimpan. Layanan backend secara otomatis memindahkan data antar-region jika diperlukan.
    • Data metrik hanya disimpan jika label lokasi yang dilampirkan ke data cocok dengan region endpoint atau zona dalam region tersebut.

    Untuk mengetahui daftar endpoint regional yang didukung, lihat halaman referensi API.

Penyerapan data rekaman aktivitas dapat memicu pembuatan bucket observabilitas. Namun, penggunaan endpoint regional tidak memengaruhi tempat sistem membuat bucket kemampuan pengamatan. Sistem menentukan lokasi bucket kemampuan pengamatan menggunakan setelan default, kebijakan organisasi, dan kumpulan lokasi bucket yang didukung.