Apache Tomcat

Integrasi Apache Tomcat mengumpulkan metrik terkait traffic, seperti jumlah sesi aktif atau throughput jaringan. Integrasi ini juga mengumpulkan log akses dan Catalina. Log akses diuraikan menjadi payload JSON yang berfokus pada detail permintaan, sedangkan log Catalina diuraikan untuk detail umum. Penerima tomcat mengumpulkan telemetri dari Java Virtual Machine (JVM) server Tomcat melalui JMX.

Untuk mengetahui informasi selengkapnya tentang Tomcat, lihat dokumentasi Apache Tomcat.

Prasyarat

Untuk mengumpulkan telemetri Tomcat, Anda harus menginstal Agen Operasional:

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

Integrasi ini mendukung Tomcat versi 10.x dan 9.0.x.

Mengonfigurasi instance Tomcat

Untuk mengekspos endpoint JMX, Anda harus menetapkan properti sistem com.sun.management.jmxremote.port saat memulai JVM. Sebaiknya setel 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 tomcat-env.sh deployment Tomcat.

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

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

Mengonfigurasi Agen Operasional untuk Tomcat

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

Contoh konfigurasi

Perintah berikut membuat konfigurasi untuk mengumpulkan dan menyerap telemetri untuk Tomcat:

# 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:
    tomcat:
      type: tomcat
      endpoint: service:jmx:rmi:///jndi/rmi://127.0.0.1:8050/jmxrmi
  service:
    pipelines:
      tomcat:
        receivers:
          - tomcat

logging:
  receivers:
    tomcat_access:
      type: tomcat_access
    tomcat_system:
      type: tomcat_system
  service:
    pipelines:
      tomcat:
        receivers:
          - tomcat_access
          - tomcat_system
EOF

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

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 verifikasi bahwa 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 istimewa 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 verifikasi bahwa komponen "Metrics Agent" dan "Logging Agent" telah dimulai: 
    Get-Service google-cloud-ops-agent*

Mengonfigurasi pengumpulan log

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

Untuk mengonfigurasi penerima log tomcat_system, tentukan kolom berikut:

Kolom Default Deskripsi
exclude_paths Daftar pola jalur sistem file yang akan dikecualikan dari set yang cocok dengan include_paths.
include_paths [/opt/tomcat/logs/catalina.out] Daftar jalur sistem file yang akan dibaca dengan mengikuti setiap file. Karakter pengganti (*) dapat digunakan di jalur.
record_log_file_path false Jika disetel 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 rekaman diperoleh yang dicatat.
type Nilai harus berupa tomcat_system.
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 yang tinggi saat file log dirotasi lebih cepat daripada interval default.

Untuk mengonfigurasi penerima log tomcat_access, tentukan kolom berikut:

Kolom Default Deskripsi
exclude_paths Daftar pola jalur sistem file yang akan dikecualikan dari set yang cocok dengan include_paths.
include_paths [/opt/tomcat/logs/localhost_access_log*.txt] Daftar jalur sistem file yang akan dibaca dengan mengikuti setiap file. Karakter pengganti (*) dapat digunakan di jalur.
record_log_file_path false Jika disetel 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 rekaman diperoleh yang dicatat.
type Nilai harus berupa tomcat_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 yang tinggi saat file log dirotasi lebih cepat daripada interval default.

Apa itu log?

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

Log tomcat_system berisi kolom berikut dalam LogEntry:

Kolom Jenis Deskripsi
jsonPayload.level string Tingkat entri log
jsonPayload.message string Pesan log, termasuk stacktrace mendetail jika ada
jsonPayload.module string Modul tomcat tempat log berasal
jsonPayload.source string Sumber tempat log berasal
severity string (LogSeverity) Tingkat entri log (diterjemahkan).

Log tomcat_access berisi kolom berikut dalam LogEntry:

Kolom Jenis Deskripsi
httpRequest objek Lihat HttpRequest
jsonPayload.host string Isi header Host
jsonPayload.user string Nama pengguna yang diautentikasi untuk permintaan
severity string (LogSeverity) Tingkat entri log (diterjemahkan).

Mengonfigurasi pengumpulan metrik

Untuk menyerap metrik dari Tomcat, Anda harus membuat penerima untuk metrik yang dihasilkan Tomcat, 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 metrik tomcat, 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:8050 URL Layanan JMX atau host dan port yang digunakan untuk membuat URL layanan. Nilai ini harus dalam bentuk service:jmx:<protocol>:<sap> atau host:port. Nilai dalam formulir 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 tomcat.
username Nama pengguna yang dikonfigurasi jika JMX dikonfigurasi untuk mewajibkan autentikasi.

Yang dipantau

Tabel berikut memberikan daftar metrik yang dikumpulkan Ops Agent dari instance Tomcat.

Jenis metrik 
Jenis, Tipe
Resource yang dimonitor		 Label
workload.googleapis.com/tomcat.errors
CUMULATIVE, INT64
gce_instance 		proto_handler
workload.googleapis.com/tomcat.max_time
GAUGE, INT64
gce_instance 		proto_handler
workload.googleapis.com/tomcat.processing_time
CUMULATIVE, INT64
gce_instance 		proto_handler
workload.googleapis.com/tomcat.request_count
CUMULATIVE, INT64
gce_instance 		proto_handler
workload.googleapis.com/tomcat.sessions
GAUGE, DOUBLE
gce_instance 		 
workload.googleapis.com/tomcat.threads
GAUGE, INT64
gce_instance 		proto_handler
state
workload.googleapis.com/tomcat.traffic
CUMULATIVE, INT64
gce_instance 		direction
proto_handler

Memverifikasi konfigurasi

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

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

  1. Di konsol Google Cloud , 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("tomcat_system") OR log_id("tomcat_access"))

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

  1. Di konsol Google Cloud , 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  MQL atau  PromQL.
  3. Pastikan PromQL dipilih di tombol Language. Tombol bahasa ada di toolbar yang sama yang memungkinkan Anda memformat kueri.
  4. Masukkan kueri berikut di editor, lalu klik Run query: 
    {"workload.googleapis.com/tomcat.threads", monitored_resource="gce_instance"}

Lihat dasbor

Untuk melihat metrik Tomcat, Anda harus mengonfigurasi diagram atau dasbor. Integrasi Tomcat 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 tindakan berikut:

  1. Di konsol Google Cloud , buka halaman  Dasbor:

    Buka Dasbor

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

  2. Pilih tab Daftar Dasbor, lalu pilih kategori Integrasi.
  3. Klik nama dasbor yang ingin Anda lihat.

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

Untuk melihat pratinjau statis dasbor, lakukan tindakan berikut:

  1. Di konsol Google Cloud , 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 Tomcat lalu klik Lihat Detail.
  4. Pilih tab Dasbor untuk melihat pratinjau statis. Jika dasbor telah diinstal, Anda dapat membukanya dengan mengklik Lihat dasbor.

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

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

Menginstal kebijakan pemberitahuan

Kebijakan pemberitahuan menginstruksikan Cloud Monitoring untuk memberi tahu Anda saat kondisi tertentu terjadi. Integrasi Tomcat mencakup satu atau beberapa kebijakan pemberitahuan yang dapat Anda gunakan. Anda dapat melihat dan menginstal kebijakan pemberitahuan ini dari halaman Integrasi di Monitoring.

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

  1. Di konsol Google Cloud , buka halaman  Integrations:

    Buka Integrations

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

  2. Temukan entri untuk Tomcat lalu klik Lihat Detail.
  3. Pilih tab Peringatan. Tab ini memberikan deskripsi tentang kebijakan pemberitahuan yang tersedia dan menyediakan antarmuka untuk menginstalnya.
  4. Instal kebijakan pemberitahuan. Kebijakan pemberitahuan perlu mengetahui ke mana harus mengirimkan 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 Konfigurasi notifikasi, pilih satu atau beberapa saluran notifikasi. Anda memiliki opsi untuk menonaktifkan penggunaan saluran notifikasi, tetapi jika Anda melakukannya, kebijakan pemberitahuan akan diaktifkan secara diam-diam. Anda dapat memeriksa statusnya di Monitoring, tetapi Anda tidak menerima notifikasi.

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

    3. Klik Buat Kebijakan.

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

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

Langkah berikutnya

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