Halaman ini diterjemahkan oleh Cloud Translation API.

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 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 tetapkan 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, 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 Ops Agent.

# 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 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 kumpulan yang dicocokkan oleh `include_paths`.
`include_paths`	`[/opt/tomcat/logs/catalina.out]`	Daftar jalur sistem file yang akan dibaca dengan mengikuti setiap file. Karakter pengganti (`*`) dapat digunakan dalam 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 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, 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 dicocokkan oleh `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 dalam 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 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, 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	Tingkat entri log
`jsonPayload.message`	string	Pesan log, termasuk stacktrace mendetail jika tersedia
`jsonPayload.module`	string	Modul tomcat tempat log berasal
`jsonPayload.source`	string	Sumber asal log
`severity`	string (`LogSeverity`)	Level entri log (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 terautentikasi untuk permintaan
`severity`	string (`LogSeverity`)	Level 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 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.

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 Ops Agent mulai mengumpulkan telemetri.

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

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.

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 tindakan berikut:

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.
Di toolbar panel pembuat kueri, pilih tombol yang namanya adalah MQL atau PromQL.
Pastikan MQL dipilih di tombol Language. Tombol bahasa berada di toolbar yang sama 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. Dasbor apa pun akan otomatis diinstal setelah Anda mengonfigurasi integrasi dan Agen Operasional telah mulai mengumpulkan data metrik.

Anda juga dapat melihat pratinjau statis dasbor tanpa menginstal integrasi.

Untuk melihat dasbor yang terinstal, lakukan tindakan berikut:

Di konsol Google Cloud, buka halaman Dasbor:
Buka Dasbor

Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
Pilih tab Daftar Dasbor, lalu pilih kategori Integrasi.
Klik nama dasbor yang ingin Anda lihat.

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

Untuk melihat pratinjau statis dasbor, lakukan tindakan berikut:

Di konsol Google Cloud, buka halaman Integrations:
Buka Integrations

Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
Klik filter platform deployment Compute Engine.
Temukan entri untuk Tomcat dan klik Lihat Detail.
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 informasi selengkapnya tentang cara menggunakan halaman Integrasi, lihat Mengelola integrasi.

Menginstal kebijakan pemberitahuan

Kebijakan pemberitahuan menginstruksikan Cloud Monitoring untuk memberi tahu Anda saat kondisi yang ditentukan terjadi. Integrasi Tomcat menyertakan satu atau beberapa kebijakan pemberitahuan untuk 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 hal berikut:

Di konsol Google Cloud, buka halaman Integrations:
Buka Integrations

Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
Temukan entri untuk Tomcat dan klik Lihat Detail.
Pilih tab Notifikasi. Tab ini memberikan deskripsi tentang kebijakan pemberitahuan yang tersedia dan menyediakan antarmuka untuk menginstalnya.
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 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 otomatis. Anda dapat memeriksa statusnya di Pemantauan, tetapi Anda tidak menerima notifikasi.
  
  Untuk mengetahui informasi selengkapnya tentang saluran notifikasi, lihat Mengelola saluran notifikasi.
3. Klik Create Policies.

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

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

Langkah selanjutnya

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