Ringkasan Telemetry (OTLP) API

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

OpenTelemetry adalah project open source yang didukung Google Clouddengan Google Cloud teknisi yang ditugaskan untuk memastikan dukungan dalam menyerap dan memvisualisasikan telemetri Anda.

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

Praktik terbaik

Saat menginstrumentasi aplikasi untuk mengirim data pelacakan ke Google Cloud project Anda, sebaiknya gunakan eksportir yang menulis data berformat OTLP ke Collector, yang kemudian mengirimkan data pelacakan 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 otomatis menambahkan /v1/traces, /v1/metrics, atau /v1/logs sebagaimana mestinya. Untuk mengetahui informasi selengkapnya, lihat Permintaan OTLP/HTTP.

Untuk contoh yang mengekspor data pelacakan atau metrik 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 pelacakan secara langsung, lihat Eksportir Cloud Trace ke endpoint OTLP.

Autentikasi

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

Untuk contoh autentikasi saat menggunakan ekspor data pelacakan langsung, lihat Mengonfigurasi autentikasi. Contoh ini mengilustrasikan 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 Anda menggunakan Telemetry API, Anda juga harus melakukan hal berikut: Google Cloud

Dukungan Kontrol Layanan VPC

Layanan Telemetry API, yang nama layanannya adalah telemetry.googleapis.com, adalah layanan yang didukung Kontrol Layanan VPC. 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 pelacakan.

Untuk mengetahui 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, data akan dikirim ke layanan backend untuk penyimpanan.

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

    • Data log dan pelacakan disimpan. Layanan backend 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 daftar endpoint regional yang didukung, lihat halaman referensi API.

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