Tomcat di Apache

L'integrazione di Apache Tomcat raccoglie metriche relative al traffico, come il numero di sessioni attive o la velocità effettiva di rete. L'integrazione raccoglie anche i log di accesso e Catalina. I log degli accessi vengono analizzati in un payload JSON incentrato sui dettagli delle richieste, mentre i log di Catalina vengono analizzati per dettagli generali. Il ricevitore tomcat raccoglie la telemetria dalla macchina virtuale (JVM) Java del server Tomcat tramite JMX.

Per ulteriori informazioni su Tomcat, consulta la documentazione di Apache Catcat.

Prerequisiti

Per raccogliere la telemetria di Tomcat, devi installare l'agente Ops:

Per le metriche, installa la versione 2.9.0 o successive.
Per i log, installa la versione 2.9.0 o successive.

Questa integrazione supporta Tomcat 10.x e 9.0.x.

Configura la tua istanza Tomcat

Per esporre un endpoint JMX, devi impostare la proprietà di sistema com.sun.management.jmxremote.port all'avvio della JVM. Ti consigliamo inoltre di impostare la proprietà di sistema com.sun.management.jmxremote.rmi.port sulla stessa porta. Per esporre un endpoint JMX da remoto, devi anche impostare la proprietà di sistema java.rmi.server.hostname.

Per impostazione predefinita, queste proprietà sono impostate nel file tomcat-env.sh di un deployment Tomcat.

Per impostare le proprietà di sistema utilizzando gli argomenti della riga di comando, anteponi -Dil nome della proprietà all'avvio di JVM. Ad esempio, per impostare com.sun.management.jmxremote.port sulla porta 8050, specifica quanto segue all'avvio della JVM:

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

Configura l'agente Ops per Tomcat

Segui la guida per la configurazione dell'agente Ops, aggiungi gli elementi richiesti per raccogliere la telemetria dalle istanze Tomcat e riavvia l'agente.

Configurazione di esempio

I seguenti comandi creano la configurazione per raccogliere e importare la telemetria per Tomcat e riavvia l'agente Ops.

# 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

Configura raccolta di log

Per importare i log da Tomcat, devi creare ricevitori per i log prodotti da Tomcat, quindi creare una pipeline per i nuovi ricevitori.

Per configurare un destinatario per i log tomcat_system, specifica i seguenti campi:

Campo	Predefinito	Descrizione
`exclude_paths`		Un elenco di pattern di percorsi del file system da escludere dal set corrispondente a `include_paths`.
`include_paths`	`[/opt/tomcat/logs/catalina.out]`	Un elenco di percorsi del filesystem da leggere aggiungendo in coda ogni file. Nei percorsi è possibile utilizzare un carattere jolly (`*`).
`record_log_file_path`	`false`	Se è impostato su `true`, il percorso del file specifico da cui è stato ottenuto il record di log viene visualizzato nella voce di log di output come valore dell'etichetta `agent.googleapis.com/log_file_path`. Quando utilizzi un carattere jolly, viene registrato solo il percorso del file da cui è stato ottenuto il record.
`type`		Il valore deve essere `tomcat_system`.
`wildcard_refresh_interval`	`60s`	L'intervallo con cui vengono aggiornati i percorsi dei file con caratteri jolly in include_paths. Specificato come durata temporale analizzabile da `time.ParseDuration`, ad esempio `30s` o `2m`. Questa proprietà potrebbe essere utile in velocità effettiva di logging elevata in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Per configurare un destinatario per i log tomcat_access, specifica i seguenti campi:

Campo	Predefinito	Descrizione
`exclude_paths`		Un elenco di pattern di percorsi del file system da escludere dal set corrispondente a `include_paths`.
`include_paths`	`[/opt/tomcat/logs/localhost_access_log.*.txt]`	Un elenco di percorsi del filesystem da leggere aggiungendo in coda ogni file. Nei percorsi è possibile utilizzare un carattere jolly (`*`).
`record_log_file_path`	`false`	Se è impostato su `true`, il percorso del file specifico da cui è stato ottenuto il record di log viene visualizzato nella voce di log di output come valore dell'etichetta `agent.googleapis.com/log_file_path`. Quando utilizzi un carattere jolly, viene registrato solo il percorso del file da cui è stato ottenuto il record.
`type`		Il valore deve essere `tomcat_access`.
`wildcard_refresh_interval`	`60s`	L'intervallo con cui vengono aggiornati i percorsi dei file con caratteri jolly in include_paths. Specificato come durata temporale analizzabile da `time.ParseDuration`, ad esempio `30s` o `2m`. Questa proprietà potrebbe essere utile in velocità effettiva di logging elevata in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Cosa viene registrato

logName deriva dagli ID ricevitore specificati nella configurazione. I campi dettagliati all'interno di LogEntry sono i seguenti.

I log tomcat_system contengono i seguenti campi in LogEntry:

Campo	Tipo	Descrizione
`jsonPayload.level`	string	Livello voce di log
`jsonPayload.message`	string	Invia messaggio di log, includendo stackt dettagliato, se fornito
`jsonPayload.module`	string	Modulo di tomcat da cui ha avuto origine il log
`jsonPayload.source`	string	Origine da cui ha avuto origine il log
`severity`	stringa (`LogSeverity`)	Livello delle voci di log (tradotto).

I log tomcat_access contengono i seguenti campi in LogEntry:

Campo	Tipo	Descrizione
`httpRequest`	oggetto	Leggi `HttpRequest`
`jsonPayload.host`	string	Contenuti dell'intestazione Host
`jsonPayload.user`	string	Nome utente autenticato per la richiesta
`severity`	stringa (`LogSeverity`)	Livello delle voci di log (tradotto).

Configurazione della raccolta di metriche

Per importare metriche da Tomcat, devi creare ricevitori per le metriche prodotte da Tomcat e quindi creare una pipeline per i nuovi ricevitori.

Per configurare un destinatario per le metriche tomcat, specifica i seguenti campi:

Campo	Predefinito	Descrizione
`collect_jvm_metrics`	`true`	Configura il destinatario in modo che raccolga anche le metriche JVM supportate.
`collection_interval`	`60s`	Una durata, ad esempio `30s` o `5m`.
`endpoint`	`localhost:8050`	L'URL o l'host del servizio JMX utilizzato per creare l'URL del servizio. Questo valore deve essere nel formato `service:jmx:<protocol>:<sap>` o `host:port`. I valori nel modulo `host:port` vengono utilizzati per creare un URL di servizio pari a `service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi`.
`password`		La password configurata se JMX è configurata per richiedere l'autenticazione.
`type`		Questo valore deve essere `tomcat`.
`username`		Il nome utente configurato se JMX è configurato per richiedere l'autenticazione.

Che cosa viene monitorato

La tabella seguente fornisce l'elenco delle metriche che l'agente operativo raccoglie dall'istanza Tomcat.

Tipo di metrica
Tipo, tipo Risorse monitorate	Etichette
`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`

Dashboard di esempio

Per visualizzare le metriche Tomcat, devi configurare un grafico o una dashboard. Cloud Monitoring offre una libreria di dashboard di esempio per le integrazioni, che contengono grafici preconfigurati. Per informazioni sull'installazione di queste dashboard, consulta Installazione di dashboard di esempio.

Verificare la configurazione

Questa sezione descrive come verificare se hai configurato correttamente il ricevitore Tomcat. L'agente Ops potrebbe richiedere uno o due minuti per iniziare a raccogliere la telemetria.

Per verificare che i log siano importati, vai a Esplora log ed esegui la query seguente per visualizzare i log di Tomcat:

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

Per verificare che le metriche siano importate, vai a Metrics Explorer ed esegui la seguente query nella scheda MQL:

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

Passaggi successivi

Per una procedura dettagliata su come utilizzare Ansible per installare l'agente Ops, configurare un'applicazione di terze parti e installare una dashboard di esempio, guarda il video Installare l'agente Ops per risolvere i problemi delle applicazioni di terze parti.