Apache Tomcat

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

Untuk 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 baru.
Untuk log, instal versi 2.9.0 atau yang lebih baru.

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

Mengonfigurasi instance Tomcat Anda

Untuk mengekspos endpoint JMX, Anda harus menetapkan properti sistem com.sun.management.jmxremote.port saat memulai JVM. Sebaiknya setel properti sistem com.sun.management.jmxremote.rmi.port ke port yang sama. Untuk mengekspos endpoint JMX dari jarak jauh, Anda juga harus menyetel 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, awali nama properti dengan -D 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 Ops, 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 dan memulai ulang Agen Operasional.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# 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

sudo service google-cloud-ops-agent restart
sleep 60

Mengonfigurasi koleksi 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 kumpulan yang cocok dengan `include_paths`.
`include_paths`	`[/opt/tomcat/logs/catalina.out]`	Daftar jalur sistem file yang akan dibaca dengan tailing setiap file. Karakter pengganti (`*`) dapat digunakan di jalur.
`record_log_file_path`	`false`	Jika ditetapkan ke `true`, jalur ke file tertentu tempat data log diperoleh akan muncul di entri log output sebagai nilai label `agent.googleapis.com/log_file_path`. Saat menggunakan karakter pengganti, hanya jalur file tempat data diperoleh yang akan dicatat.
`type`		Nilai harus berupa `tomcat_system`.
`wildcard_refresh_interval`	`60s`	Interval tempat jalur file karakter pengganti di include_paths dimuat ulang. Diberikan sebagai durasi waktu yang dapat diurai oleh `time.ParseDuration`, misalnya `30s` atau `2m`. Properti ini mungkin berguna pada throughput logging yang tinggi dengan 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 kumpulan yang cocok dengan `include_paths`.
`include_paths`	`[/opt/tomcat/logs/localhost_access_log.*.txt]`	Daftar jalur sistem file yang akan dibaca dengan tailing setiap file. Karakter pengganti (`*`) dapat digunakan di jalur.
`record_log_file_path`	`false`	Jika ditetapkan ke `true`, jalur ke file tertentu tempat data log diperoleh akan muncul di entri log output sebagai nilai label `agent.googleapis.com/log_file_path`. Saat menggunakan karakter pengganti, hanya jalur file tempat data diperoleh yang akan dicatat.
`type`		Nilai harus berupa `tomcat_access`.
`wildcard_refresh_interval`	`60s`	Interval tempat jalur file karakter pengganti di include_paths dimuat ulang. Diberikan sebagai durasi waktu yang dapat diurai oleh `time.ParseDuration`, misalnya `30s` atau `2m`. Properti ini mungkin berguna pada throughput logging yang tinggi dengan file log dirotasi lebih cepat daripada interval default.

Apa itu log?

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

Log tomcat_system berisi kolom berikut di LogEntry:

Kolom	Jenis	Deskripsi
`jsonPayload.level`	string	Log tingkat entri
`jsonPayload.message`	string	Pesan log, termasuk stacktrace terperinci jika diberikan
`jsonPayload.module`	string	Modul tomcat tempat log berasal
`jsonPayload.source`	string	Sumber asal log
`severity`	string (`LogSeverity`)	Log tingkat entri (diterjemahkan).

Log tomcat_access berisi kolom berikut di LogEntry:

Kolom	Jenis	Deskripsi
`httpRequest`	objek	Lihat `HttpRequest`
`jsonPayload.host`	string	Konten header Host
`jsonPayload.user`	string	Nama pengguna yang diautentikasi untuk permintaan
`severity`	string (`LogSeverity`)	Log tingkat entri (diterjemahkan).

Mengonfigurasi pengumpulan metrik

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

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 memiliki cara untuk membedakannya.

Untuk mengonfigurasi penerima metrik tomcat, tentukan kolom berikut:

Kolom	Default	Deskripsi
`collect_jvm_metrics`	`true`	Mengonfigurasi penerima agar juga mengumpulkan metrik JVM yang didukung.
`collection_interval`	`60s`	Durasi waktu, seperti `30s` atau `5m`.
`endpoint`	`localhost:8050`	JMX Service URL atau 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 `tomcat`.
`username`		Nama pengguna yang dikonfigurasi jika JMX dikonfigurasi untuk mewajibkan autentikasi.

Hal yang dipantau

Tabel berikut menyediakan daftar metrik yang dikumpulkan Agen Operasional dari instance Tomcat.

Jenis metrik
Jenis, Jenis Resource yang dipantau	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 mengonfigurasi penerima Tomcat dengan benar. Mungkin perlu waktu satu atau dua menit bagi Agen Operasional untuk mulai mengumpulkan telemetri.

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

Pada panel navigasi Google Cloud Console, pilih Logging, lalu pilih Logs Explorer:
Buka Logs Explorer

Masukkan kueri berikut di editor, lalu klik Run query:

resource.type="gce_instance"
(log_id("tomcat_system") OR log_id("tomcat_access"))

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

Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih Metrics Explorer:
Buka Metrics Explorer
Di toolbar panel pembuat kueri, pilih tombol yang namanya adalah MQL atau PromQL.
Pastikan MQL dipilih pada tombol Language. Tombol bahasa berada di toolbar yang sama dengan yang memungkinkan Anda memformat kueri.

Masukkan kueri berikut di editor, lalu klik Run query:

fetch gce_instance
| metric 'workload.googleapis.com/tomcat.threads'
| every 1m

Lihat dasbor

Untuk melihat metrik Tomcat, Anda harus mengonfigurasi diagram atau dasbor. Integrasi Tomcat menyertakan satu atau beberapa dasbor untuk Anda. Setiap dasbor 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:

Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih Dashboards:
Buka Dasbor
Pilih tab Dashboard List, lalu pilih kategori Integrations.
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 Operasional mulai mengumpulkan metrik, dasbor akan diinstal untuk Anda.

Untuk melihat pratinjau statis dasbor, lakukan langkah berikut:

Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih Integrations:
Buka Integrations
Klik filter platform deployment Compute Engine.
Temukan entri untuk Tomcat lalu klik View Details.
Pilih tab Dashboards untuk melihat pratinjau statis. Jika dasbor sudah terinstal, Anda dapat membukanya dengan mengklik View dashboard.

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

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

Menginstal kebijakan pemberitahuan

Kebijakan pemberitahuan menginstruksikan Cloud Monitoring untuk memberi tahu Anda saat kondisi tertentu terjadi. Integrasi Tomcat 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 langkah berikut:

Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih Integrations:
Buka Integrations
Temukan entri untuk Tomcat lalu klik View Details.
Pilih tab Alerts. Tab ini memberikan deskripsi tentang kebijakan pemberitahuan yang tersedia dan menyediakan antarmuka untuk menginstalnya.
Instal kebijakan pemberitahuan. Kebijakan pemberitahuan perlu mengetahui ke mana pemberitahuan harus dikirimkan jika pemberitahuan telah dipicu, sehingga memerlukan informasi dari Anda untuk penginstalan. Untuk menginstal kebijakan pemberitahuan, lakukan tindakan berikut:
1. Dari daftar kebijakan pemberitahuan yang tersedia, pilih yang ingin Anda instal.
2. Di bagian Configure notifications, pilih satu atau beberapa saluran notifikasi. Anda memiliki opsi untuk menonaktifkan penggunaan saluran notifikasi. Namun, jika Anda melakukannya, kebijakan pemberitahuan akan diaktifkan secara diam-diam. Anda dapat memeriksa statusnya di Monitoring, tetapi Anda tidak akan menerima notifikasi.
  
  Untuk informasi lebih lanjut tentang saluran notifikasi, lihat Mengelola saluran notifikasi.
3. Klik Create Policy.

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

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

Langkah selanjutnya

Untuk 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.