Dokumen ini menjelaskan cara menjalankan OpenTelemetry Collector Buatan Google di Container-Optimized OS untuk mengumpulkan log, metrik, dan trace OTLP dari aplikasi berinstrumen, lalu mengekspor data tersebut ke Google Cloud.
Sebelum memulai
Untuk menjalankan OpenTelemetry Collector, Anda memerlukan resource berikut:
Project Google Cloud dengan Cloud Monitoring API, Cloud Trace API, dan Cloud Logging API diaktifkan.
Jika Anda tidak memiliki project Google Cloud, lakukan hal berikut:
Di konsol Google Cloud, buka New Project:
Di kolom Project Name, masukkan nama project Anda, lalu klik Create.
Buka Penagihan:
Pilih project yang baru saja Anda buat jika belum dipilih di bagian atas halaman.
Anda akan diminta untuk memilih profil pembayaran yang sudah ada atau membuat yang baru.
Monitoring API, Trace API, dan Logging API diaktifkan secara default untuk project baru.
Jika Anda sudah memiliki project Google Cloud, pastikan Monitoring API, Trace API, dan Logging API diaktifkan:
Virtual machine (VM) Container-Optimized OS. Jika Anda tidak memiliki VM OS yang Dioptimalkan untuk Container, ikuti petunjuk di Membuat dan mengonfigurasi instance.
Penginstalan
gcloud
. Untuk mengetahui informasi tentang cara menginstalgcloud
, lihat Menginstal Google Cloud CLI.
Mengonfigurasi izin untuk Kolektor
Secara default, VM Container-Optimized OS menggunakan
akun layanan default Compute Engine,
PROJECT_NUMBER-compute@
.
Akun layanan ini biasanya memiliki peran Identity and Access Management (IAM) yang diperlukan untuk menulis metrik dan log yang dijelaskan dalam dokumen ini:
- Monitoring Metric Writer (
roles/monitoring.metricWriter
) - Logging Log Writer (
roles/logging.logWriter
)
Jika Anda mengonfigurasi akun layanan kustom untuk instance, lihat Mengelola akses ke akun layanan.
Men-deploy Kolektor
Untuk menjalankan OpenTelemetry Collector Buatan Google, Anda harus menyediakan file konfigurasi untuk VM OS yang Dioptimalkan Penampung. Anda dapat menggunakan alat cloud-init
untuk menulis file konfigurasi. Berikut adalah file cloud-init
yang direkomendasikan untuk menggunakan Pengumpul buatan Google:
Sebaiknya buat jaringan bridge
Docker untuk memfasilitasi
komunikasi antara penampung Collector dan penampung lainnya di
sistem yang akan mengirim telemetri. Untuk membuat jaringan, jalankan perintah berikut:
docker network create -d bridge otel otel
Jalankan penampung Collector dengan perintah berikut:
Perintah sebelumnya melakukan hal berikut:
- Menjalankan penampung Collector di latar belakang.
- Melampirkan penampung Collector ke jaringan jembatan otel yang dibuat sebelumnya. Penampung lain dapat dihubungkan ke bridge untuk mengirim telemetri.
- Memasang file konfigurasi Anda di penampung sehingga file dapat diakses untuk mengonfigurasi Collector.
Mengonfigurasi Kolektor
Kami menyediakan konfigurasi OpenTelemetry Collector untuk Anda gunakan dengan Collector buatan Google. Konfigurasi ini dirancang untuk mengirimkan metrik, log, dan trace OTLP dalam volume tinggi. Konfigurasi ini juga dirancang untuk mencegah masalah penyerapan umum. Anda dapat menambahkan ke konfigurasi, tetapi sebaiknya jangan menghapus elemen.
Bagian ini menjelaskan konfigurasi yang disediakan, komponen utama seperti eksportir, pemroses, penerima, dan komponen lain yang tersedia.
Konfigurasi Kolektor yang disediakan
Anda dapat menemukan konfigurasi Pengumpul di direktorigoogle-built-opentelemetry-collector
di repositori opentelemetry-operations-collector
:
Pengekspor
Konfigurasi Pengumpul mencakup eksportir berikut:
Pengekspor
googlecloud
, untuk log dan trace. Eksporter ini dikonfigurasi dengan nama log default.Ekspor
googlemanagedprometheus
, untuk metrik. Eksporter ini tidak memerlukan konfigurasi apa pun, tetapi ada opsi konfigurasi. Untuk informasi tentang opsi konfigurasi untuk eksportirgooglemanagedprometheus
, lihat Memulai OpenTelemetry Collector dalam dokumentasi Google Cloud Managed Service for Prometheus.
Prosesor
Konfigurasi Pengumpul mencakup pemroses berikut:
batch
: Dikonfigurasi untuk mengelompokkan permintaan telemetri pada Google Cloud jumlah maksimum entri per permintaan, atau pada Google Cloud interval minimum setiap 5 detik (mana saja yang tercapai lebih dahulu).memory_limiter
: Memasang batas penggunaan memori Pengumpul untuk mencegah error kehabisan memori dengan menghapus titik data saat batas terlampaui.resourcedetection
: Mendeteksi label resource Google Cloud sepertiproject_id
secara otomatis.
Penerima
Konfigurasi Pengumpul hanya menyertakan
penerima otlp
.
Untuk informasi tentang cara melengkapi aplikasi Anda dengan instrumentasi untuk mengirim pelacakan dan metrik OTLP ke endpoint OTLP Pengumpul, lihat Memilih pendekatan instrumentasi.
Komponen yang tersedia
OpenTelemetry Collector Buatan Google berisi komponen yang diperlukan sebagian besar pengguna untuk
memungkinkan pengalaman yang kaya dalam Google Cloud Observability. Untuk mengetahui daftar lengkap
komponen yang tersedia, lihat
Components
di repositori opentelemetry-operations-collector
.
Untuk meminta perubahan atau penambahan pada komponen yang tersedia,
buka permintaan fitur.
di repositori opentelemetry-operations-collector
.
Membuat telemetri
Anda dapat menguji konfigurasi menggunakan
alat telemetrygen
open source.
Project OpenTelemetry menyediakan penampung di registry Container GitHub.
Sebelum menjalankan perintah berikut, ganti placeholder berikut, jika Anda mengubah default yang digunakan dalam perintah Docker di Men-deploy Pengumpul:
- otel: Nama yang Anda tentukan saat membuat jaringan
bridge
Docker. - opentelemetry-collector: Nama yang Anda tentukan saat menjalankan penampung.
Membuat log
Untuk membuat log menggunakan alat telemetrygen
, jalankan perintah berikut:
docker run \ --net=otel \ ghcr.io/open-telemetry/opentelemetry-collector-contrib/telemetrygen:v0.105.0 \ logs --otlp-insecure --rate=3 --duration=5m \ --otlp-endpoint=opentelemetry-collector:4317
Membuat metrik
Untuk membuat metrik menggunakan alat telemetrygen
, jalankan perintah
berikut:
docker run \ --net=otel \ ghcr.io/open-telemetry/opentelemetry-collector-contrib/telemetrygen:v0.105.0 \ metrics --otlp-insecure --rate=0.1 --duration=5m \ --otlp-endpoint=opentelemetry-collector:4317
Membuat metrik
Untuk membuat rekaman aktivitas menggunakan alat telemetrygen
, jalankan perintah
berikut:
docker run \ --net=otel \ ghcr.io/open-telemetry/opentelemetry-collector-contrib/telemetrygen:v0.105.0 \ traces --otlp-insecure --rate=3 --duration=5m \ --otlp-endpoint=opentelemetry-collector:4317
Setelah beberapa menit, telemetri yang dihasilkan oleh aplikasi mulai mengalir melalui Collector ke konsol Google Cloud untuk setiap sinyal.
Melihat telemetri
OpenTelemetry Collector Buatan Google mengirimkan metrik, log, dan trace dari aplikasi yang diinstrumentasikan ke Google Cloud Observability. Kolektor juga mengirimkan metrik pengamatan mandiri. Bagian berikut menjelaskan cara melihat telemetri ini.
Melihat metrik
Kolektor OpenTelemetry Buatan Google mengumpulkan metrik Prometheus yang dapat Anda lihat menggunakan Metrics Explorer. Metrik yang dikumpulkan bergantung pada instrumentasi aplikasi, meskipun Pengumpul buatan Google juga menulis beberapa metrik mandiri.
Untuk melihat metrik yang dikumpulkan oleh OpenTelemetry Collector Buatan Google, lakukan tindakan berikut:-
Di konsol Google Cloud, buka halaman leaderboard Metrics explorer:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
- Di toolbar konsol Google Cloud, pilih project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mengaktifkan aplikasi.
- Pada elemen Metric, luaskan menu Select a metric,
masukkan
Prometheus Target
di panel filter, lalu gunakan submenu untuk memilih jenis dan metrik resource tertentu:- Di menu Active resources, pilih Prometheus Target.
- Untuk memilih metrik, gunakan menu Kategori metrik aktif dan Metrik aktif.
Metrik yang dikumpulkan oleh OpenTelemetry Collector Buatan Google memiliki
awalan
prometheus.googleapis.com
. - Klik Terapkan.
- Konfigurasi cara data dilihat.
Jika pengukuran untuk metrik bersifat kumulatif, Metrics Explorer akan otomatis menormalisasi data yang diukur menurut periode penyelarasan, sehingga diagram akan menampilkan rasio. Untuk mengetahui informasi selengkapnya, lihat Jenis, tipe, dan konversi.
Saat nilai bilangan bulat atau ganda diukur, seperti dengan metrik
counter
, Metrics Explorer akan otomatis menjumlahkan semua deret waktu. Untuk mengubah perilaku ini, tetapkan menu pertama entri Aggregation ke None.Untuk informasi selengkapnya tentang cara mengonfigurasi diagram, lihat Memilih metrik saat menggunakan Metrics Explorer.
Melihat trace Anda
Untuk melihat data rekaman aktivitas, lakukan hal berikut:
-
Di konsol Google Cloud, buka halaman Trace Explorer:
Anda juga dapat menemukan halaman ini menggunakan kotak penelusuran.
- Di toolbar konsol Google Cloud, pilih project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mengaktifkan aplikasi.
- Di bagian tabel halaman, pilih baris.
Pada diagram Gantt di panel Trace details, pilih rentang.
Panel akan terbuka dan menampilkan informasi tentang permintaan yang dilacak. Detail ini mencakup metode, kode status, jumlah byte, dan agen pengguna pemanggil.
Untuk melihat log yang terkait dengan rekaman aktivitas ini, pilih tab Logs & Events.
Tab ini menampilkan setiap log. Untuk melihat detail entri log, luaskan entri log. Anda juga dapat mengklik View Logs dan melihat log menggunakan Logs Explorer.
Untuk informasi selengkapnya tentang cara menggunakan Cloud Trace Explorer, lihat Menemukan dan menjelajahi trace.
Melihat log
Dari Logs Explorer, Anda dapat memeriksa log, dan juga dapat melihat rekaman aktivitas terkait, jika ada.
-
Di konsol Google Cloud, buka halaman Logs Explorer:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.
Temukan entri log dari aplikasi berinstrumen Anda. Untuk melihat detailnya, luaskan entri log.
Klik
Traces pada entri log dengan pesan trace, lalu pilih View trace details.
Panel Trace details akan terbuka dan menampilkan rekaman aktivitas yang dipilih.
Untuk mengetahui informasi selengkapnya tentang cara menggunakan Logs Explorer, lihat Melihat log menggunakan Logs Explorer.
Mengamati dan men-debug Pengumpul
OpenTelemetry Collector Buatan Google secara otomatis memberikan metrik pengamatan mandiri untuk membantu Anda memantau performanya dan memastikan uptime berkelanjutan pipeline penyerapan OTLP.
Untuk memantau Kolektor, instal contoh dasbor untuk Kolektor. Dasbor ini menawarkan insight sekilas tentang beberapa metrik dari Pengumpul, termasuk waktu aktif, penggunaan memori, dan panggilan API ke Google Cloud Observability.
Untuk menginstal dasbor, lakukan hal berikut:
-
Di konsol Google Cloud, buka halaman
Dasbor:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
- Klik Dashboard Templates.
- Telusuri dasbor OpenTelemetry Collector.
- Opsional: Untuk melihat pratinjau dasbor, pilih dasbor.
Klik playlist_add Tambahkan dasbor ke daftar Anda, lalu selesaikan dialog.
Dialog ini memungkinkan Anda memilih nama dasbor, dan menambahkan label ke dasbor.
Untuk informasi selengkapnya tentang cara menginstal dasbor, lihat Menginstal template dasbor.