L'integrazione di Jetty raccoglie le metriche relative alle sessioni e all'utilizzo dei thread. L'integrazione raccoglie anche i log di sistema e di accesso. I log degli accessi vengono analizzati in un payload JSON incentrato sui dettagli delle richieste.
Per ulteriori informazioni su Jetty, consulta la documentazione di Jetty.
Prerequisiti
Per raccogliere dati di telemetria Jetty, devi installare Ops Agent:
- Per i log, installa la versione 2.16.0 o successiva.
- Per le metriche, installa la versione 2.17.0 o successive.
Questa integrazione supporta le versioni Jetty 9.4.x, 10.x e 11.x.
Configura Ops Agent per Jetty
Seguendo la guida per la configurazione di Ops Agent, aggiungi gli elementi richiesti per raccogliere la telemetria dalle istanze Jetty e riavvia l'agente.
Per raccogliere metriche da questa integrazione, devi anche esporre un endpoint Java Management Extensions (JMX).
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 impostazione predefinita, queste proprietà sono impostate nel file /etc/jetty-jmx.xml
Jetty.
Per esporre un endpoint JMX da remoto, devi impostare anche la
proprietà di sistema java.rmi.server.hostname
.
Per impostare le proprietà di sistema utilizzando argomenti della riga di comando, anteponi -D
al nome
della proprietà quando avvii la JVM. Ad esempio, per impostare la proprietà com.sun.management.jmxremote.port
sulla porta 1099, specifica quanto segue all'avvio della JVM:
-Dcom.sun.management.jmxremote.port=1099
Configurazione di esempio
Il seguente comando crea la configurazione per raccogliere e importare la telemetria per Jetty e riavvia Ops Agent su Linux.
Configura la raccolta dei log
Per importare i log da Jetty, devi creare ricevitori per i log prodotti da Jetty, quindi creare una pipeline per i nuovi ricevitori.
Per configurare un ricevitore per i log di jetty_access
, specifica i seguenti campi:
Campo | Predefinita | Descrizione |
---|---|---|
exclude_paths |
Un elenco di pattern di percorso del file system da escludere dal set che corrisponde a include_paths. | |
include_paths |
["/opt/logs/*.request.log"] |
Un elenco di percorsi di file system da leggere eseguendo la coda di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*). |
type |
Il valore deve essere jetty_access . |
|
record_log_file_path |
false |
Se il criterio viene 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. |
wildcard_refresh_interval |
60s |
L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_path. Indicata 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
logName
deriva dagli ID destinatario specificati nella configurazione. Di seguito sono riportati i campi dettagliati all'interno di LogEntry
.
I log jetty_access
contengono i seguenti campi in LogEntry
:
Campo | Tipo | Descrizione |
---|---|---|
httpRequest.protocol |
string | Protocollo utilizzato per la richiesta. |
httpRequest.remoteIp |
string | Indirizzo IP client. |
httpRequest.requestMethod |
string | HTTP(S). |
httpRequest.requestUrl |
string | URL della richiesta (in genere solo la parte del percorso dell'URL) |
httpRequest.responseSize |
string | Dimensioni della risposta. |
httpRequest.status |
string | Codice di stato HTTP. |
httpRequest.userAgent |
string | Contenuti dell'intestazione User-Agent . |
I log syslog
contengono i seguenti campi in LogEntry
:
Campo | Tipo | Descrizione |
---|---|---|
jsonPayload.message |
string | Messaggio di log. |
Configurazione della raccolta di metriche
Per importare le metriche da Jetty, devi creare un ricevitore per le metriche prodotte da Jetty, 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 jetty
, specifica i seguenti campi:
Campo | Predefinita | Descrizione |
---|---|---|
collect_jvm_metrics |
true |
Configura il ricevitore in modo che raccolga anche le metriche JVM supportate. |
collection_interval |
60s |
Un valore time.Duration, ad esempio 30s o 5m . |
endpoint |
localhost:1099 |
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 jetty . |
|
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 Jetty.
Tipo di metrica | |
---|---|
Tipo, tipo Risorse monitorate |
Etichette |
workload.googleapis.com/jetty.select.count
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/jetty.session.count
|
|
CUMULATIVE , INT64 gce_instance |
resource
|
workload.googleapis.com/jetty.session.time.max
|
|
GAUGE , INT64 gce_instance |
resource
|
workload.googleapis.com/jetty.session.time.total
|
|
GAUGE , INT64 gce_instance |
resource
|
workload.googleapis.com/jetty.thread.count
|
|
GAUGE , INT64 gce_instance |
state
|
workload.googleapis.com/jetty.thread.queue.count
|
|
GAUGE , INT64 gce_instance |
Verificare la configurazione
In questa sezione viene descritto come verificare la corretta configurazione del ricevitore Jetty. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere dati di telemetria.
Per verificare che i log Jetty vengano inviati a Cloud Logging, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina Esplora log:
Se usi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.
- Inserisci la seguente query nell'editor, quindi fai clic su Esegui query:
resource.type="gce_instance" log_id("jetty_access")
Per verificare che le metriche Jetty vengano inviate a Cloud Monitoring, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina leaderboard Esplora metriche:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Nella barra degli strumenti del riquadro di creazione di query, seleziona il pulsante con il nome code MQL o code PromQL.
- Verifica che sia selezionato MQL nell'opzione di attivazione/disattivazione Lingua. L'opzione di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che ti consente di formattare la query.
- Inserisci la seguente query nell'editor, quindi fai clic su Esegui query:
fetch gce_instance | metric 'workload.googleapis.com/jetty.select.count' | every 1m
Visualizza dashboard
Per visualizzare le metriche Jetty, devi aver configurato un grafico o una dashboard. L'integrazione di Jetty include una o più dashboard per te. Qualsiasi dashboard viene installata automaticamente dopo che hai configurato l'integrazione e 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:
-
Nella console Google Cloud, vai alla pagina Dashboard
:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Seleziona la scheda Elenco dashboard, quindi scegli la categoria Integrazioni.
- Fai clic sul nome della dashboard che vuoi visualizzare.
Se hai configurato un'integrazione, ma la dashboard non è stata installata, verifica che Ops Agent sia in esecuzione. Se non sono presenti dati delle metriche per un grafico nella dashboard, l'installazione della dashboard non riesce. Dopo che Ops Agent inizia 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 con il sottotitolo Monitoring.
- Fai clic sul filtro della piattaforma di deployment di Compute Engine.
- Individua la voce Jetty e fai clic su View Details (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 saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestire le integrazioni.
Installa criteri di avviso
I criteri di avviso indicano a Cloud Monitoring di avvisarti quando si verificano condizioni specificate. L'integrazione di Jetty include uno o più criteri di avviso da 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, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina
Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Individua la voce per Jetty e fai clic su Visualizza dettagli.
- Seleziona la scheda Avvisi. Questa scheda fornisce le descrizioni dei criteri di avviso disponibili e fornisce un'interfaccia per installarli.
- Installa i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche di attivazione dell'avviso, pertanto richiedono informazioni da parte tua per l'installazione.
Per installare i criteri di avviso, segui questi passaggi:
- Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.
Nella sezione Configura notifiche, seleziona uno o più canali di notifica. Puoi scegliere di disabilitare l'utilizzo dei canali di notifica, ma in questo caso i criteri di avviso vengono attivati automaticamente. Puoi verificarne lo stato in Monitoring, ma non riceverai notifiche.
Per maggiori informazioni sui canali di notifica, consulta la pagina relativa alla gestione dei canali di notifica.
- Fai clic su Crea criteri.
Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, consulta Introduzione agli avvisi.
Per saperne di più sull'utilizzo della pagina Integrazioni, vedi 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, guarda il video Installare Ops Agent per risolvere i problemi delle applicazioni di terze parti.