Dokumen ini menjelaskan Telemetry (OTLP) API, yang mengimplementasikan OpenTelemetry OTLP Protocol. API ini dirancang untuk digunakan dengan aplikasi yang diinstrumentasi menggunakan salah satu SDK OpenTelemetry.
Alasan Anda harus menggunakan Telemetry API
OpenTelemetry adalah project open source yang didukung Google Clouddengan Google Cloud engineer yang ditugaskan untuk memastikan dukungan penyerapan dan visualisasi data trace Anda.
Saat Anda menggunakan Telemetry API, data Anda disimpan dalam format yang umumnya konsisten dengan file proto yang ditentukan oleh OpenTelemetry OTLP Protocol. Namun, kolom dapat dikonversi dari jenis data khusus OpenTelemetry menjadi jenis data JSON sebelum penyimpanan. Selain itu, batas untuk Telemetry API berlaku. Batas ini sering kali lebih besar daripada batas untuk Cloud Trace API. Terakhir, instrumentasi Anda tidak bergantung pada eksportir khusus Google Cloud.
Untuk mempelajari format penyimpanan lebih lanjut, lihat Skema untuk data rekaman aktivitas.
Kapan harus menggunakan Telemetry API
Sebaiknya kirim data rekaman aktivitas ke Google Cloud project Anda dengan menggunakan Telemetry API. API ini memberikan kompatibilitas dengan ekosistem OpenTelemetry open source dan batasnya sering kali lebih besar daripada batas Cloud Trace API, yang merupakan APIGoogle Cloud berpemilik. Beberapa fitur, seperti Pemantauan Aplikasi, mengandalkan informasi yang hanya tersedia saat data rekaman aktivitas dikirim ke Telemetry API.
Saat menginstrumentasi aplikasi untuk mengirim data rekaman aktivitas ke Google Cloud project, sebaiknya lakukan salah satu hal berikut:
- Gunakan eksportir yang menulis OTLP ke Collector, yang kemudian mengirim data rekaman aktivitas Anda ke Telemetry API.
- Gunakan eksportir OTLP dalam proses yang didukung oleh library OpenTelemetry yang mengirim telemetri ke Telemetry API. Tidak ada pengumpul dengan konfigurasi ini.
Untuk mengetahui informasi tentang cara menggunakan Telemetry API, lihat artikel Bermigrasi dari eksportir Cloud Trace ke endpoint OTLP.
Tempat melihat data yang diserap
Data rekaman aktivitas yang dimasukkan melalui Telemetry API dapat dilihat menggunakan halaman Trace Explorer. Untuk mengetahui informasi tentang cara melihat data trace, lihat Menemukan dan menjelajahi trace.
Autentikasi
Pengekspor harus diberi otorisasi untuk mengirim data ke project Google Cloud Anda. Misalnya, Anda dapat mengonfigurasi eksportir dengan Google Cloud Kredensial Default Aplikasi (ADC) dengan menambahkan Google Auth Library khusus bahasa ke aplikasi Anda. Untuk mengetahui informasi dan contoh kode selengkapnya, lihat Mengonfigurasi autentikasi.
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:
Cloud Trace dan residensi data
Jika Anda menggunakan Assured Workloads karena Anda memiliki persyaratan residensi data atau Tingkat Dampak 4 (IL4), maka jangan gunakan Telemetry API untuk mengirim rentang aktivitas.