Ringkasan API

Halaman ini memberikan ringkasan singkat tentang Observability API dan Telemetry (OTLP) API.

Tentang Observability API

Observability API memungkinkan Anda melakukan hal berikut:

  • Mengonfigurasi setelan default untuk bucket kemampuan pengamatan untuk project, folder, dan organisasi. Setelan ini membantu Anda memenuhi persyaratan kepatuhan dan peraturan. Anda dapat mengonfigurasi hal berikut:

    • Lokasi penyimpanan default untuk bucket kemampuan pengamatan baru.
    • Untuk setiap lokasi, kunci Cloud Key Management Service default. Kunci tersebut digunakan untuk mengenkripsi bucket observabilitas baru.

    Untuk mengetahui informasi selengkapnya, lihat Menetapkan default untuk bucket kemampuan observasi.

  • Konfigurasi cakupan kemampuan pengamatan untuk project Anda. Cakupan ini mengontrol resource mana yang ditelusuri oleh halaman penjelajah untuk data log, metrik, dan rekaman aktivitas. Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi cakupan kemampuan pengamatan.

  • Mencantumkan informasi tentang bucket kemampuan observasi di Google Cloud project Anda. Data rekaman aktivitas Anda disimpan dalam bucket observabilitas. Untuk mengetahui informasi tentang model data, lihat Ringkasan penyimpanan.

  • Buat link pada set data, yang memungkinkan BigQuery memiliki akses baca ke set data. Untuk mempelajari cara membuat set data tertaut, lihat Mengelola penyimpanan.

Endpoint Service

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

  • Endpoint global: observability.googleapis.com.

    Anda dapat menggunakan endpoint layanan global untuk melakukan operasi apa pun yang didukung oleh Observability API. Selain itu, untuk endpoint ini, perintah list observability buckets memungkinkan Anda mengganti kolom lokasi dalam parameter jalur dengan karakter pengganti (-).

  • Endpoint regional: observability.REGION.rep.googleapis.com, dengan REGION adalah region yang didukung. Untuk daftar endpoint, lihat Endpoint layanan regional.

    Anda hanya dapat menggunakan endpoint layanan regional jika lokasi yang diberikan dalam parameter jalur cocok dengan region endpoint. Perintah yang dikirim ke endpoint layanan ini akan gagal jika menyertakan karakter pengganti atau jika lokasi berbeda dengan region endpoint.

Referensi API

Tentang Telemetry API

Telemetry (OTLP) API adalah implementasi OpenTelemetry OTLP Protocol. Telemetry API menyediakan kompatibilitas dan dukungan untuk ekosistem OpenTelemetry open source:

  • Log: Telemetry API memungkinkan Anda menyerap rekaman log berformat OTLP ke project Anda. Untuk mengetahui informasi selengkapnya, lihat artikel Menulis log OTLP ke Telemetry API.

  • Metrik: Telemetry API memungkinkan Anda menyerap metrik berformat OTLP ke Cloud Monitoring menggunakan pengekspor otlphttp dan OpenTelemetry Collector atau OpenTelemetry SDK. Untuk mengetahui informasi selengkapnya, lihat Ringkasan penyerapan metrik OTLP.

  • Trace: Telemetry API memungkinkan Anda mengirim data rekaman aktivitas berformat OTLP ke project Anda. Selain itu, batas rekaman aktivitas untuk Telemetry API sering kali lebih besar daripada batas untuk Cloud Trace API.

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 region 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 pemantauan menggunakan setelan default, kebijakan organisasi, dan kumpulan lokasi bucket yang didukung.

Referensi API

Untuk mengetahui informasi selengkapnya tentang Telemetry API, lihat dokumen berikut: