Jetty

Integrasi Jetty mengumpulkan metrik penggunaan sesi dan thread. Integrasi ini juga mengumpulkan log akses dan sistem. Log akses diurai ke dalam payload JSON yang difokuskan pada detail permintaan.

Untuk mengetahui informasi selengkapnya tentang Jetty, lihat dokumentasi Jetty.

Prasyarat

Untuk mengumpulkan telemetri Jetty, Anda harus menginstal Agen Operasional:

  • Untuk metrik, instal versi 2.17.0 atau yang lebih tinggi.
  • Untuk log, instal versi 2.16.0 atau yang lebih tinggi.

Integrasi ini mendukung Jetty versi 9.4.x, 10.x, dan 11.x.

Mengonfigurasi instance Jetty

Untuk mengumpulkan metrik dari integrasi ini, Anda harus mengekspos endpoint Java Management Extensions (JMX).

Untuk mengekspos endpoint JMX, Anda harus menetapkan properti sistem com.sun.management.jmxremote.port saat memulai JVM. Sebaiknya tetapkan juga properti sistem com.sun.management.jmxremote.rmi.port ke port yang sama. Untuk mengekspos endpoint JMX dari jarak jauh, Anda juga harus menetapkan properti sistem java.rmi.server.hostname.

Secara default, properti ini ditetapkan dalam file Jetty /etc/jetty-jmx.xml.

Untuk menetapkan properti sistem menggunakan argumen command line, tambahkan nama properti dengan -D saat memulai JVM. Misalnya, untuk menetapkan com.sun.management.jmxremote.port ke port 1099, tentukan hal berikut saat memulai JVM:

-Dcom.sun.management.jmxremote.port=1099

Mengonfigurasi Agen Operasional untuk Jetty

Dengan mengikuti panduan Mengonfigurasi Agen Operasional, tambahkan elemen yang diperlukan untuk mengumpulkan telemetri dari instance Jetty, lalu mulai ulang agen.

Contoh konfigurasi

Perintah berikut membuat konfigurasi guna mengumpulkan dan menyerap telemetri untuk Jetty:

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    jetty_metrics:
      type: jetty
  service:
    pipelines:
      jetty_pipeline:
        receivers:
          - jetty_metrics
logging:
  receivers:
    jetty_access:
      type: jetty_access
  service:
    pipelines:
      jetty:
        receivers:
          - jetty_access
EOF

Agar perubahan ini diterapkan, Anda harus memulai ulang Agen Operasional:

Linux

  1. Untuk memulai ulang agen, jalankan perintah berikut di instance Anda: 
    sudo systemctl restart google-cloud-ops-agent
  2. Untuk mengonfirmasi bahwa agen telah dimulai ulang, jalankan perintah berikut dan pastikan komponen "Metrics Agent" dan "Logging Agent" telah dimulai: 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. Hubungkan ke instance Anda menggunakan RDP atau alat serupa dan login ke Windows.
  2. Buka terminal PowerShell dengan hak administrator dengan mengklik kanan ikon PowerShell dan memilih Run as Administrator
  3. Untuk memulai ulang agen, jalankan perintah PowerShell berikut: 
    Restart-Service google-cloud-ops-agent -Force
  4. Untuk mengonfirmasi bahwa agen telah dimulai ulang, jalankan perintah berikut dan pastikan komponen "Metrics Agent" dan "Logging Agent" telah dimulai: 
    Get-Service google-cloud-ops-agent*

Mengonfigurasi pengumpulan log

Untuk menyerap log dari Jetty, Anda harus membuat penerima untuk log yang dihasilkan Jetty, lalu membuat pipeline untuk penerima baru.

Untuk mengonfigurasi penerima untuk log jetty_access, tentukan kolom berikut:

Kolom Default Deskripsi
exclude_paths Daftar pola jalur sistem file yang akan dikecualikan dari kumpulan yang cocok dengan include_paths.
include_paths ["/opt/logs/*.request.log"] Daftar jalur sistem file yang akan dibaca dengan mengikuti setiap file. Karakter pengganti (*) dapat digunakan di jalur.
record_log_file_path false Jika ditetapkan ke true, jalur ke file tertentu tempat catatan log diperoleh akan muncul dalam entri log output sebagai nilai label agent.googleapis.com/log_file_path. Saat menggunakan karakter pengganti, hanya jalur file tempat catatan diperoleh yang akan direkam.
type Nilai ini harus jetty_access.
wildcard_refresh_interval 60s Interval saat jalur file karakter pengganti di include_paths diperbarui. Diberikan sebagai durasi waktu, misalnya 30s atau 2m. Properti ini mungkin berguna dalam throughput logging tinggi saat file log dirotasi lebih cepat dari interval default.

Yang dicatat di log

logName berasal dari ID penerima yang ditentukan dalam konfigurasi. Kolom mendetail di dalam LogEntry adalah sebagai berikut.

Log jetty_access berisi kolom berikut di LogEntry:

Kolom Jenis Deskripsi
httpRequest objek Lihat HttpRequest
severity string (LogSeverity) Tingkat entri log (diterjemahkan).

Log syslog berisi kolom berikut di LogEntry:

Kolom Jenis Deskripsi
jsonPayload.message string Pesan log

Mengonfigurasi pengumpulan metrik

Untuk menyerap metrik dari Jetty, Anda harus membuat penerima untuk metrik yang dihasilkan Jetty, lalu membuat pipeline untuk penerima baru.

Penerima ini tidak mendukung penggunaan beberapa instance dalam konfigurasi, misalnya, untuk memantau beberapa endpoint. Semua instance tersebut menulis ke deret waktu yang sama, dan Cloud Monitoring tidak dapat membedakannya.

Untuk mengonfigurasi penerima untuk metrik jetty, tentukan kolom berikut:

Kolom Default Deskripsi
collect_jvm_metrics true Mengonfigurasi penerima untuk juga mengumpulkan metrik JVM yang didukung.
collection_interval 60s Nilai durasi waktu, seperti 30s atau 5m.
endpoint localhost:1099 URL Layanan JMXatau host dan port yang digunakan untuk membuat URL layanan. Nilai ini harus dalam bentuk service:jmx:<protocol>:<sap> atau host:port. Nilai dalam bentuk host:port digunakan untuk membuat URL layanan service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi.
password Sandi yang dikonfigurasi jika JMX dikonfigurasi untuk mewajibkan autentikasi.
type Nilai ini harus jetty.
username Nama pengguna yang dikonfigurasi jika JMX dikonfigurasi untuk mewajibkan autentikasi.

Yang dipantau

Tabel berikut memberikan daftar metrik yang dikumpulkan Agen Operasional dari instance Jetty.

Jenis metrik
Jenis, Jenis
Resource yang dipantau		 Label
workload.googleapis.com/jetty.select.count
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/jetty.session.count
CUMULATIVE, INT64
gce_instance 		resource
workload.googleapis.com/jetty.session.time.max
GAUGE, INT64
gce_instance 		resource
workload.googleapis.com/jetty.session.time.total
GAUGE, INT64
gce_instance 		resource
workload.googleapis.com/jetty.thread.count
GAUGE, INT64
gce_instance 		state
workload.googleapis.com/jetty.thread.queue.count
GAUGE, INT64
gce_instance 		 

Memverifikasi konfigurasi

Bagian ini menjelaskan cara memverifikasi bahwa Anda telah mengonfigurasi penerima Jetty dengan benar. Mungkin perlu waktu satu atau dua menit agar Agen Operasional mulai mengumpulkan telemetri.

Untuk memverifikasi bahwa log Jetty dikirim ke Cloud Logging, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman Logs Explorer:

    Buka Logs Explorer

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.

  2. Masukkan kueri berikut di editor, lalu klik Run query: 
    resource.type="gce_instance"
(log_id("jetty_access") OR log_id("syslog"))

Untuk memverifikasi bahwa metrik Jetty dikirim ke Cloud Monitoring, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman  Metrics explorer:

    Buka Metrics explorer

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar panel pembuat kueri, pilih tombol yang namanya  PromQL.
  3. Masukkan kueri berikut di editor, lalu klik Run query: 
    {"workload.googleapis.com/jetty.select.count", monitored_resource="gce_instance"}

Lihat dasbor

Untuk melihat metrik Jetty, Anda harus mengonfigurasi diagram atau dasbor. Integrasi Jetty menyertakan satu atau beberapa dasbor untuk Anda. Dasbor apa pun akan otomatis diinstal setelah Anda mengonfigurasi integrasi dan Agen Operasional mulai mengumpulkan data metrik.

Anda juga dapat melihat pratinjau statis dasbor tanpa menginstal integrasi.

Untuk melihat dasbor yang terinstal, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman  Dashboards:

    Buka Dashboards

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Pilih tab Dashboard List, lalu pilih kategori Integrations.
  3. Klik nama dasbor yang ingin Anda lihat.

Jika Anda telah mengonfigurasi integrasi, tetapi dasbor belum diinstal, pastikan Agen Operasional sedang berjalan. Jika tidak ada data metrik untuk diagram di dasbor, penginstalan dasbor akan gagal. Setelah Agen Operasional mulai mengumpulkan metrik, dasbor akan diinstal untuk Anda.

Untuk melihat pratinjau statis dasbor, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman  Integrations:

    Buka Integrations

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Klik filter platform deployment Compute Engine.
  3. Temukan entri untuk Jetty lalu klik View Details.
  4. Pilih tab Dashboards untuk melihat pratinjau statis. Jika dasbor diinstal, Anda dapat membuka dasbor tersebut dengan mengklik View dashboard.

Untuk mengetahui informasi selengkapnya tentang dasbor di Cloud Monitoring, lihat Dasbor dan diagram.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan halaman Integrations, lihat Mengelola integrasi.

Menginstal kebijakan pemberitahuan

Kebijakan pemberitahuan meminta Cloud Monitoring mengirimkan pemberitahuan kepada Anda jika kondisi tertentu terjadi. Integrasi Jetty menyertakan satu atau beberapa kebijakan pemberitahuan untuk Anda gunakan. Anda dapat melihat dan menginstal kebijakan pemberitahuan ini dari halaman Integrations di Monitoring.

Untuk melihat deskripsi kebijakan pemberitahuan yang tersedia dan menginstalnya, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman  Integrations:

    Buka Integrations

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Temukan entri untuk Jetty lalu klik View Details.
  3. Pilih tab Alerts. Tab ini memberikan deskripsi kebijakan pemberitahuan yang tersedia dan menyediakan antarmuka untuk menginstalnya.
  4. Instal kebijakan pemberitahuan. Kebijakan pemberitahuan perlu mengetahui tempat untuk mengirim notifikasi bahwa pemberitahuan telah dipicu, sehingga memerlukan informasi dari Anda untuk penginstalan. Untuk menginstal kebijakan pemberitahuan, lakukan hal berikut:
    1. Dari daftar kebijakan pemberitahuan yang tersedia, pilih kebijakan yang ingin Anda instal.

    2. Di bagian Configure notifications, pilih satu atau lebih saluran notifikasi. Anda memiliki opsi untuk menonaktifkan penggunaan saluran notifikasi, tetapi jika melakukannya, kebijakan pemberitahuan Anda akan diaktifkan secara diam-diam. Anda dapat memeriksa statusnya di Monitoring, tetapi Anda tidak akan menerima notifikasi.

      Untuk mengetahui informasi selengkapnya tentang saluran notifikasi, lihat Mengelola saluran notifikasi.

    3. Klik Create Policies.

Untuk mengetahui informasi selengkapnya tentang kebijakan pemberitahuan di Cloud Monitoring, lihat Pengantar tentang pemberitahuan.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan halaman Integrations, lihat Mengelola integrasi.

Langkah berikutnya

Untuk mengetahui panduan cara menggunakan Ansible untuk menginstal Agen Operasional, mengonfigurasi aplikasi pihak ketiga, dan menginstal contoh dasbor, lihat video Menginstal Agen Operasional untuk memecahkan masalah aplikasi pihak ketiga.