Apache Tomcat

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

Per ulteriori informazioni su Tomcat, vedi documentazione di Apache Tomcat.

Prerequisiti

Per raccogliere la telemetria di Tomcat, devi installare Ops Agent:

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

Questa integrazione supporta le versioni di Tomcat 10.xe 9.0.x.

Configura l'istanza Tomcat

Per esporre un endpoint JMX, devi impostare la proprietà di sistema com.sun.management.jmxremote.port quando avvii la JVM. Ti consigliamo inoltre di impostare il com.sun.management.jmxremote.rmi.port proprietà di sistema alla stessa porta. Per esporre un endpoint JMX da remoto, devi impostare anche la proprietà di sistema java.rmi.server.hostname.

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

Per impostare le proprietà di sistema utilizzando gli argomenti della riga di comando, anteponi al nome della proprietà -D quando avvii la JVM. Ad esempio, per impostare com.sun.management.jmxremote.port sulla porta 8050, specifica quanto segue quando avvia la JVM:

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

Configurare Ops Agent per Tomcat

Seguendo la guida alla configurazione delle operazioni Agent, aggiungi gli elementi richiesti per raccogliere dati di telemetria dalle istanze Tomcat riavvia l'agente.

Configurazione di esempio

I comandi seguenti creano la configurazione per raccogliere e importare dati di telemetria per Tomcat e riavvia 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

Configura la raccolta dei log

Per importare i log da Tomcat, devi creare un ricevitore per i log prodotti da Tomcat e poi una pipeline per il nuovo ricevitore.

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 dall'insieme corrispondente a include_paths.
include_paths [/opt/tomcat/logs/catalina.out] Un elenco di percorsi del file system da leggere tramite il comando tail di 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 del log viene visualizzato nella voce del 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 di aggiornamento dei percorsi dei file con caratteri jolly in include_paths. Specificato come durata, ad esempio 30s o 2m. Questa proprietà può essere utile in caso di velocità effettiva di logging elevate, 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 dall'insieme corrispondente a include_paths.
include_paths [/opt/tomcat/logs/localhost_access_log*.txt] Un elenco di percorsi del file system da leggere tramite il comando tail di 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 del log viene visualizzato nella voce del 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 di aggiornamento dei percorsi file con caratteri jolly in include_paths. Data come durata di tempo, ad esempio 30s o 2m. Questa proprietà può essere utile in caso di velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Che cosa viene registrato nei log

logName è ricavato dagli ID dei destinatari 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 di voce di log
jsonPayload.message string Messaggio di log, inclusa l'analisi dettagliata dello stack, se fornita
jsonPayload.module string Modulo di tomcat da cui ha avuto origine il log
jsonPayload.source string Origine del luogo di origine del log
severity stringa (LogSeverity) Livello di voce del 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 di voce del log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da Tomcat, devi creare un ricevitore per le metriche prodotte da Tomcat e poi una pipeline per il nuovo ricevitore.

Questo ricevitore non supportare l'uso di più istanze nella configurazione, ad esempio per monitorare più endpoint. Tutte queste istanze scrivono nella stessa serie temporale, e Cloud Monitoring non ha modo di distinguerli.

Per configurare un ricevitore per le metriche tomcat, specifica quanto segue campi:

Campo Predefinito Descrizione
collect_jvm_metrics true Configura il ricevitore in modo che raccolga anche le metriche JVM supportate.
collection_interval 60s Un valore di durata temporale, ad esempio 30s o 5m.
endpoint localhost:8050 L'URL del servizio JMX o l'host e la porta utilizzati per creare l'URL del servizio. Questo valore deve essere nel formato service:jmx:<protocol>:<sap> o host:port. I valori nel formato host:port vengono utilizzati per creare un URL del servizio service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi.
password La password configurata se JMX è configurato 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 raccolte da Ops Agent 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

Verificare la configurazione

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore Tomcat. Potrebbero essere necessari uno o due minuti prima che Ops Agent inizi a raccogliere dati di telemetria.

Per verificare che i log Tomcat vengano inviati a Cloud Logging, segui questi passaggi:

  1. Nella console Google Cloud, vai alla pagina Esplora log:

    Vai a Esplora log

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.

  2. Inserisci la seguente query nell'editor e poi fai clic su Esegui query: 
    resource.type="gce_instance"
(log_id("tomcat_system") OR log_id("tomcat_access"))

Per verificare che le metriche Tomcat vengano inviate a Cloud Monitoring, segui questi passaggi:

  1. Nella console Google Cloud, vai alla pagina  Esplora metriche:

    Vai a Esplora metriche

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Nella barra degli strumenti del riquadro Query Builder, seleziona il pulsante  MQL o  PromQL.
  3. Verifica che sia selezionato MQL con l'opzione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti. consente di formattare la query.
  4. Inserisci la seguente query nell'editor e poi fai clic su Esegui query: 
    fetch gce_instance
| metric 'workload.googleapis.com/tomcat.threads'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di Tomcat, devi avere configurato un grafico o una dashboard. L'integrazione di Tomcat include una o più dashboard per te. Qualsiasi dashboard viene installata automaticamente dopo integrazione e Ops Agent ha iniziato a raccogliere dati delle metriche.

Puoi anche visualizzare anteprime statiche delle dashboard senza installando l'integrazione.

Per visualizzare una dashboard installata:

  1. Nella console Google Cloud, vai alla pagina  Dashboard:

    Vai a Dashboard

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Seleziona la scheda Elenco dashboard e poi scegli la categoria Integrazioni.
  3. Fai clic sul nome della dashboard che vuoi visualizzare.

Se hai configurato un'integrazione, ma la dashboard non è stata installato, quindi verifica che Ops Agent sia in esecuzione. Quando non c'è dati delle metriche per un grafico nella dashboard, l'installazione della dashboard non riesce. Una volta che Ops Agent inizia a raccogliere le metriche, la dashboard viene installata per te.

Per visualizzare un'anteprima statica della dashboard:

  1. Nella console Google Cloud, vai alla  Integrazioni pagina:

    Vai a Integrations (Integrazioni).

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Fai clic sul filtro della piattaforma di deployment di Compute Engine.
  3. Individua la voce per Tomcat e fai clic su Visualizza dettagli.
  4. Seleziona la scheda Dashboard per visualizzare un'anteprima statica. Se sia installata, quindi puoi accedervi facendo clic Visualizza dashboard.

Per ulteriori informazioni sulle dashboard in Cloud Monitoring, consulta Dashboard e grafici.

Per saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestisci le integrazioni.

Installa criteri di avviso

I criteri di avviso chiedono a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specifiche. L'integrazione di Tomcat include uno o più criteri di avviso da utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrazioni in Monitoraggio.

Per visualizzare le descrizioni dei criteri di avviso disponibili e installarli:

  1. Nella console Google Cloud, vai alla  Integrazioni pagina:

    Vai a Integrazioni

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Individua la voce per Tomcat e fai clic su Visualizza dettagli.
  3. Seleziona la scheda Avvisi. Questa scheda fornisce le descrizioni criteri di avviso disponibili e fornisce un'interfaccia per l'installazione che li rappresentano.
  4. Installa i criteri di avviso. I criteri di avviso richiedono per sapere dove inviare le notifiche relative a un avviso vengono attivati, quindi richiedono informazioni per l'installazione. Per installare i criteri di avviso, segui questi passaggi:
    1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli da installare.

    2. Nella sezione Configura notifiche, seleziona uno o più canali di notifica. Puoi scegliere di disattivare l'uso dei canali di notifica, ma se lo fai, la funzione si attivano automaticamente. Puoi controllarne lo stato in monitoraggio, ma non ricevi notifiche.

      Per saperne di più sui canali di notifica, consulta la pagina Gestire i canali di notifica.

    3. Fai clic su Crea criteri.

Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, consulta la pagina Introduzione agli avvisi.

Per saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestisci le integrazioni.

Passaggi successivi

Per una procedura dettagliata su come utilizzare Ansible per installare Ops Agent, configura un'applicazione di terze parti e installare una dashboard di esempio, consulta Video: installa Ops Agent per risolvere i problemi relativi alle applicazioni di terze parti.