Jetty

L'integrazione di Jetty raccoglie le metriche relative all'utilizzo di sessioni e thread. La integrazione raccoglie anche i log di sistema e di accesso. I log degli accessi vengono analizzati in un payload JSON incentrato sui dettagli della richiesta.

Per ulteriori informazioni su Jetty, consulta Documentazione di Jetty.

Prerequisiti

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

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

Questa integrazione supporta le versioni 9.4.x, 10.x e 11.x di Jetty.

Configura la tua istanza Jetty

Per raccogliere metriche da questa integrazione, devi esporre una Java Management Extensions (JMX) endpoint.

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. A esporre un endpoint JMX da remoto, devi anche impostare java.rmi.server.hostname proprietà di sistema.

Per impostazione predefinita, queste proprietà sono impostate nel file /etc/jetty-jmx.xml di Jetty.

Per impostare le proprietà di sistema utilizzando argomenti della riga di comando, anteponi la proprietà nome con -D all'avvio della JVM. Ad esempio, per impostare com.sun.management.jmxremote.port alla porta 1099, specifica quanto segue quando avvia la JVM:

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

Configura Ops Agent per Jetty

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

Configurazione di esempio

I comandi seguenti creano la configurazione per raccogliere e importare dati di telemetria per Jetty 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:
    jetty_metrics:
      type: jetty
  service:
    pipelines:
      jetty_pipeline:
        receivers:
          - jetty_metrics
logging:
  receivers:
    jetty_access:
      type: jetty_access
  service:
    pipelines:
      jetty:
        receivers:
          - jetty_access
EOF

sudo service google-cloud-ops-agent restart

Configura la raccolta dei log

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

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

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorso del file system da escludere dal set con corrispondenza in base 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 (*).
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 Questo valore deve essere jetty_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à potrebbe essere utile in caso di flussi di lavoro elevati per la registrazione, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Che cosa viene registrato

logName deriva da gli ID destinatario specificati nella configurazione. I campi dettagliati all'interno di LogEntry sono i seguenti.

I log jetty_access contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
httpRequest oggetto Leggi HttpRequest
severity stringa (LogSeverity) Livello voce di log (tradotto).

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 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 distinguerle.

Per configurare un destinatario per le metriche jetty, 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 Un valore di durata, 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 modulo host:port vengono utilizzati per creare un URL del 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 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 dall'agente Ops 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. Potrebbero essere necessari uno o due minuti prima che Ops Agent inizi a raccogliere dati di telemetria.

Per verificare che i log di Jetty vengano inviati a Cloud Logging:

  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("jetty_access") OR log_id("syslog"))

Per verificare che le metriche Jetty vengano inviate 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 che 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/jetty.select.count'
| every 1m

Visualizza dashboard

Per visualizzare le metriche Jetty, devi disporre di un grafico o di una dashboard configurato. L'integrazione di Jetty 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, quindi 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. Se non sono disponibili dati metrici per un grafico nella dashboard, l'installazione della dashboard non va a buon fine. Dopo 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 pagina  Integrazioni:

    Vai a 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 Compute Engine.
  3. Individua la voce relativa a Jetty 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 i criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di avvisarti quando che si verifichino determinate condizioni. L'integrazione di Jetty include uno o più criteri di avviso per da utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrations (Integrazioni) in Monitoraggio.

Per visualizzare le descrizioni dei criteri di avviso disponibili e procedi nel seguente modo:

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

    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 Molo 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 devono sapere dove inviare le notifiche che indicano che l'avviso è stato attivato, quindi richiedono informazioni da te per l'installazione. Per installare i criteri di avviso, segui questi passaggi:
    1. Nell'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.

    2. Nella sezione Configura notifiche, seleziona una o più canali di notifica. Puoi disattivare l'uso dei canali di notifica, ma in questo caso i criteri di avviso vengono attivati in modo silenzioso. Puoi verificarne lo stato nella Monitoraggio, ma non riceverai notifiche.

      Per ulteriori informazioni sui canali di notifica, consulta Gestisci canali di notifica.

    3. Fai clic su Crea criteri.

Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, vedi 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, 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.