L'integrazione di Apache Tomcat raccoglie metriche relative al traffico, come il numero di sessioni attive o la velocità effettiva della rete. L'integrazione raccoglie anche
i log di accesso e Catalina. I log degli accessi vengono analizzati in un payload JSON incentrato sui dettagli della richiesta, mentre i log di Catalina vengono analizzati per fornire dettagli generali. Il ricevitore tomcat
raccoglie la telemetria dalla Java Virtual Machine (JVM) del server Tomcat tramite JMX.
Per ulteriori informazioni su Tomcat, consulta la documentazione di Apache Tomcat.
Prerequisiti
Per raccogliere la telemetria 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 successive.
Questa integrazione supporta le versioni 10.x e 9.0.x di Tomcat.
Configura l'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 in remoto, devi impostare anche 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 -D
al nome della proprietà quando avvii la 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 Ops Agent per Tomcat
Segui la guida per la configurazione di Ops Agent, aggiungi gli elementi richiesti per raccogliere i dati di telemetria dalle istanze Tomcat, quindi riavvia l'agente.
Configurazione di esempio
I comandi seguenti creano la configurazione per raccogliere e importare la telemetria di Tomcat e riavvia Ops Agent.
Configura la raccolta dei 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 ricevitore 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 da include_paths . |
|
include_paths |
[/opt/tomcat/logs/catalina.out] |
Un elenco di percorsi di file system da leggere mediante il tailing di ogni file. È possibile utilizzare un carattere jolly (* ) nei percorsi. |
record_log_file_path |
false |
Se il criterio è 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. Data come durata di tempo analizzabile da time.ParseDuration , ad esempio 30s o 2m . Questa proprietà potrebbe essere utile con velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente rispetto all'intervallo predefinito. |
Per configurare un ricevitore 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 da include_paths . |
|
include_paths |
[/opt/tomcat/logs/localhost_access_log.*.txt] |
Un elenco di percorsi di file system da leggere mediante il tailing di ogni file. È possibile utilizzare un carattere jolly (* ) nei percorsi. |
record_log_file_path |
false |
Se il criterio è 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. Data come durata di tempo analizzabile da time.ParseDuration , ad esempio 30s o 2m . Questa proprietà potrebbe essere utile con velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente rispetto all'intervallo predefinito. |
Cosa viene registrato
logName
deriva dagli ID destinatario specificati nella configurazione. Di seguito sono riportati i campi dettagliati all'interno della LogEntry
.
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 presente |
jsonPayload.module |
string | Modulo di tomcat in cui ha avuto origine il log |
jsonPayload.source |
string | Origine dell'origine del log |
severity |
stringa (LogSeverity ) |
Livello di voce 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 di voce di log (tradotto). |
Configurazione della raccolta di metriche
Per importare le metriche da Tomcat, devi creare un ricevitore per le metriche produttive da Tomcat, quindi creare una pipeline per il nuovo ricevitore.
Questo ricevitore non supporta l'utilizzo 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 distinguerle.
Per configurare un ricevitore per le metriche tomcat
, specifica i seguenti campi:
Campo | Predefinito | Descrizione |
---|---|---|
collect_jvm_metrics |
true |
Configura il ricevitore in modo che raccolga anche le metriche JVM supportate. |
collection_interval |
60s |
Una durata, 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 di servizio di 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. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere i dati di telemetria.
Per verificare che i log Tomcat vengano inviati a Cloud Logging, segui questi passaggi:
-
Nel pannello di navigazione della console Google Cloud, seleziona Logging, quindi Esplora log:
- Inserisci la seguente query nell'editor e 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:
-
Nella console Google Cloud, vai alla pagina Metrics Explorer leaderboard:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è code MQL o code PromQL.
- Verifica che sia selezionato MQL nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che consente di formattare la query.
- Inserisci la seguente query nell'editor e fai clic su Esegui query:
fetch gce_instance | metric 'workload.googleapis.com/tomcat.threads' | every 1m
Visualizza dashboard
Per visualizzare le metriche Tomcat, devi aver configurato un grafico o una dashboard. L'integrazione di Tomcat include una o più dashboard per te. Tutte le dashboard vengono installate automaticamente dopo la configurazione dell'integrazione e dopo che Ops Agent ha iniziato a raccogliere i dati delle metriche.
Puoi anche visualizzare anteprime statiche delle dashboard senza installare l'integrazione.
Per visualizzare una dashboard installata, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina Dashboard:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Seleziona la scheda Elenco dashboard, quindi scegli la categoria Integrazioni.
- Fai clic sul nome della dashboard da visualizzare.
Se hai configurato un'integrazione, ma la dashboard non è stata installata, verifica che Ops Agent sia in esecuzione. Se nella dashboard non sono disponibili dati delle metriche per un grafico, l'installazione della dashboard non riesce. Dopo che Ops Agent ha iniziato a raccogliere le metriche, la dashboard viene installata automaticamente.
Per visualizzare un'anteprima statica della dashboard:
-
Nella console Google Cloud, vai alla pagina Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Fai clic sul filtro piattaforma di deployment di Compute Engine.
- Individua la voce per Tomcat e fai clic su Visualizza dettagli.
- Seleziona la scheda Dashboard per visualizzare un'anteprima statica. Se la dashboard è installata, puoi accedervi facendo clic su Visualizza dashboard.
Per ulteriori informazioni sulle dashboard in Cloud Monitoring, consulta Dashboard e grafici.
Per ulteriori informazioni sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.
Installa criteri di avviso
I criteri di avviso indicano a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specificate. L'integrazione di Tomcat include uno o più criteri di avviso che puoi utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrazioni in Monitoring.
Per visualizzare le descrizioni dei criteri di avviso disponibili e installarli:
-
Nella console Google Cloud, vai alla pagina Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Individua la voce per Tomcat e fai clic su Visualizza dettagli.
- Seleziona la scheda Avvisi. Questa scheda fornisce descrizioni dei criteri di avviso disponibili e un'interfaccia per installarli.
- Installa i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche relative all'attivazione dell'avviso, per cui richiedono informazioni da parte tua per l'installazione.
Per installare i criteri di avviso:
- Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.
Nella sezione Configura le notifiche, seleziona uno o più canali di notifica. Puoi disattivare l'utilizzo dei canali di notifica. Tuttavia, in questo caso i criteri di avviso si attivano in modo invisibile. Puoi verificarne lo stato in Monitoring, ma non ricevi notifiche.
Per maggiori informazioni sui canali di notifica, consulta la pagina Gestire i canali di notifica.
- Fai clic su Crea criteri.
Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, consulta Introduzione agli avvisi.
Per ulteriori informazioni sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.
Passaggi successivi
Per una procedura dettagliata su come utilizzare Ansible per installare Ops Agent, configurare un'applicazione di terze parti e installare una dashboard di esempio, consulta il video Installare Ops Agent per la risoluzione dei problemi delle applicazioni di terze parti.