WildFly

L'integrazione di WildFly raccoglie i log di WildFly e li analizza in un payload JSON. Il risultato include origine, codice messaggio, livello e messaggio.

Per ulteriori informazioni su WildFly, consulta Documentazione di WildFly.

Prerequisiti

Per raccogliere dati di telemetria WildFly, devi installa Ops Agent:

  • Per le metriche, installa la versione 2.12.0 o successive.
  • Per i log, installa la versione 2.11.0 o successive.

Questa integrazione supporta le versioni 26.x e 25.x di WildFly.

Configura l'istanza WildFly

Per esporre l'endpoint JMX da remoto, devi impostare proprietà di sistema jboss.bind.address.management. Per impostazione predefinita, questa proprietà è impostata nella configurazione di WildFly. L'installazione predefinita di WildFly non richiede JMX autenticazione con JMX esposto localmente su 127.0.0.1:9990.

Per raccogliere metriche di sessione, devi attivare le statistiche sulla eseguendo questo comando mediante l'interfaccia a riga di comando JBoss:

/subsystem=undertow:write-attribute(name=statistics-enabled,value=true)

Configurare l'agente operativo per WildFly

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

Configurazione di esempio

I seguenti comandi creano la configurazione per raccogliere e importare la telemetria per WildFly e riavviare 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:
    wildfly:
      type: wildfly
      endpoint: localhost:9990
  service:
    pipelines:
      wildfly:
        receivers:
          - wildfly

logging:
  receivers:
    wildfly_system:
      type: wildfly_system
  service:
    pipelines:
      wildfly_system:
        receivers:
          - wildfly_system
EOF

sudo service google-cloud-ops-agent restart

Configura la raccolta dei log

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

Per configurare un ricevitore per i log di wildfly_system, specifica quanto segue 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/wildfly/standalone/log/server.log, /opt/wildfly/domain/servers/*/log/server.log] Un elenco di percorsi di file system da leggere eseguendo la coda di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*). ad esempio /var/log/wildfly*/*.log.
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.
type Il valore deve essere wildfly_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.

Che cosa viene registrato nei log

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

I log wildfly_system contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.level string Livello voce di log
jsonPayload.message string Messaggio di log
jsonPayload.messageCode string Codice messaggio specifico per Wildfly che precede il log, se applicabile
jsonPayload.source string Origine da cui ha avuto origine il log
jsonPayload.thread string Thread da cui ha avuto origine il log
severity stringa (LogSeverity) Livello di voce del log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da WildFly, devi creare un ricevitore per le metriche prodotto da WildFly, quindi crea 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 distinguerli.

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

Campo Predefinito Descrizione
additional_jars /opt/wildfly/bin/client/jboss-client.jar Il percorso del file jboss-client.jar, necessario per monitorare WildFly tramite JMX.
collection_interval 60s Un valore di durata, ad esempio 30s o 5m.
endpoint service:jmx:remote+http://localhost:9990 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 wildfly.
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 WildFly.

Tipo di metrica 
Tipo, tipo
Risorse monitorate		 Etichette
workload.googleapis.com/wildfly.jdbc.connection.open
GAUGE, INT64
gce_instance 		data_source
state
workload.googleapis.com/wildfly.jdbc.request.wait
CUMULATIVE, INT64
gce_instance 		data_source
workload.googleapis.com/wildfly.jdbc.rollback.count
CUMULATIVE, INT64
gce_instance 		cause
workload.googleapis.com/wildfly.jdbc.transaction.count
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/wildfly.network.io
CUMULATIVE, INT64
gce_instance 		listener
server
state
workload.googleapis.com/wildfly.request.count
CUMULATIVE, INT64
gce_instance 		listener
server
workload.googleapis.com/wildfly.request.server_error
CUMULATIVE, INT64
gce_instance 		listener
server
workload.googleapis.com/wildfly.request.time
CUMULATIVE, INT64
gce_instance 		listener
server
workload.googleapis.com/wildfly.session.active
GAUGE, INT64
gce_instance 		deployment
workload.googleapis.com/wildfly.session.count
CUMULATIVE, INT64
gce_instance 		deployment
workload.googleapis.com/wildfly.session.expired
CUMULATIVE, INT64
gce_instance 		deployment
workload.googleapis.com/wildfly.session.rejected
CUMULATIVE, INT64
gce_instance 		deployment

Verificare la configurazione

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore WildFly. L'inizio della raccolta della telemetria da parte di Ops Agent potrebbe richiedere uno o due minuti.

Per verificare che i log di WildFly 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("wildfly_system")

Per verificare che le metriche WildFly 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 della riquadro Query Builder, seleziona il pulsante con  MQL o  PromQL.
  3. 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. 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/wildfly.network.io'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di WildFly, devi avere configurato un grafico o una dashboard. L'integrazione di WildFly include una o più dashboard. 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 installata, controlla che l'agente operativo sia in esecuzione. Quando non c'è 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 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 per WildFly 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 saperne di più 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 chiedono a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specifiche. L'integrazione di WildFly include uno o più criteri di avviso per 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 Integrations (Integrazioni).

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

  2. Individua la voce relativa a WildFly 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. Dall'elenco dei criteri di avviso disponibili, seleziona quelli da installare.

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

      Per ulteriori informazioni sui canali di notifica, consulta Gestire 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, 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.