Molo

L'integrazione Jetty raccoglie metriche relative a sessioni e thread sull'utilizzo. L'integrazione raccoglie anche i log di sistema e degli accessi. 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 la telemetria di Jetty, devi installare Ops Agent:

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

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

Configura Ops Agent per Jetty

Segui la guida per configurare Ops Agent, aggiungi gli elementi richiesti per raccogliere la telemetria dalle istanze Jetty e riavvia l'agente.

Per raccogliere metriche da questa integrazione, devi esporre anche 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 Jetty /etc/jetty-jmx.xml.

Per esporre un endpoint JMX in remoto, devi anche impostare la proprietà di sistema java.rmi.server.hostname.

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

# 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 ricevitori per i log prodotti da Jetty, quindi creare una pipeline per i nuovi ricevitori.

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

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorsi del file system da escludere dal set che corrispondono a percorsi include_path.
include_paths ["/opt/logs/*.request.log"] Un elenco di percorsi di file system da leggere mediante la coda di ciascun file. Nei percorsi è possibile utilizzare un carattere jolly (*).
type Il valore deve essere jetty_access.
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.
wildcard_refresh_interval 60s L'intervallo in cui i percorsi dei file con caratteri jolly in includi_path vengono aggiornati. Indicata come durata di tempo, ad esempio 30s o 2m. Questa proprietà potrebbe essere utile in caso di velocità effettiva di logging elevata, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Cosa viene registrato

logName viene ricavato 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.
httpRequest.requestUrl string URL della richiesta (in genere solo la parte del percorso dell'URL)
httpRequest.responseSize string Dimensioni 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 prodotta da Jetty, quindi creare una pipeline per il nuovo ricevitore.

Questo destinatario 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 Predefinito Descrizione
collect_jvm_metrics true Configura il ricevitore in modo che raccolga anche le metriche JVM supportate.
collection_interval 60s Un valore time.Duration, come 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 di servizio di service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi.
password La password configurata se JMX è configurato in modo da richiedere l'autenticazione.
type Questo valore deve essere jetty.
username Il nome utente configurato se JMX è configurato in modo da 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
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

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

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

  1. Nel pannello di navigazione della console Google Cloud, seleziona Logging e poi Esplora log:

    Vai a Esplora log

  2. Inserisci la seguente query nell'editor e 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:

  1. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi  Metrics Explorer:

    Vai a Metrics Explorer

  2. Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è  MQL o  PromQL.
  3. Verifica che MQL sia selezionato 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.
  4. Inserisci la seguente query nell'editor e 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 con Jetty include una o più dashboard per te. 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:

  1. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring, quindi seleziona  Dashboard:

    Vai a Dashboard

  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 installata, verifica che Ops Agent sia in esecuzione. Se non sono disponibili 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 automaticamente.

Per visualizzare un'anteprima statica della dashboard:

  1. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi  Integrazioni:

    Vai a Integrazioni

  2. Fai clic sul filtro della piattaforma di deployment di Compute Engine.
  3. Individua la voce Jetty e fai clic su Visualizza dettagli.
  4. 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, 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 Jetty 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:

  1. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi  Integrazioni:

    Vai a Integrazioni

  2. Individua la voce Jetty e fai clic su Visualizza dettagli.
  3. Seleziona la scheda Avvisi. Questa scheda fornisce descrizioni dei criteri di avviso disponibili e un'interfaccia per installarli.
  4. Installa i criteri di avviso. I criteri di avviso devono sapere dove inviare notifiche relative all'attivazione dell'avviso, quindi richiedono informazioni da parte tua per l'installazione. Per installare i criteri di avviso:
    1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.

    2. Nella sezione Configura le notifiche, seleziona uno o più canali di notifica. Hai la possibilità di disattivare l'utilizzo dei canali di notifica, ma in questo caso i criteri di avviso si attivano automaticamente. Puoi controllarne lo stato in Monitoring, ma non ricevi notifiche.

      Per maggiori informazioni sui canali di notifica, consulta Gestire i canali di notifica.

    3. 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, consulta Gestire le integrazioni.

Passaggi successivi

Per istruzioni dettagliate 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.