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 la documentazione di WildFly.

Prerequisiti

Per raccogliere la telemetria di WildFly, devi installare 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 la tua istanza WildFly

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

Per raccogliere le metriche di sessione, devi abilitare le statistiche nel sottosistema di undertow eseguendo questo comando utilizzando l'interfaccia a riga di comando di JBoss:

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

Configura Ops Agent per WildFly

Segui la guida per la configurazione di Ops Agent, aggiungi gli elementi richiesti per raccogliere i dati di telemetria dalle istanze WildFly, quindi riavvia l'agente.

Configurazione di esempio

Il seguente comando crea la configurazione per raccogliere e importare la telemetria di WildFly 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:
    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 ricevitori per i log prodotti da WildFly, quindi creare una pipeline per i nuovi ricevitori.

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

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorsi del file system da escludere dal set corrispondente 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 mediante il tailing di ogni file. È possibile utilizzare un carattere jolly (*) nei percorsi, ad esempio /var/log/wildfly/.log.
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 wildfly_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. Deve essere un multiplo di 1.

Cosa viene registrato

logName deriva dagli ID destinatario specificati nella configurazione. Di seguito sono riportati i campi dettagliati all'interno della LogEntry.

I log wildfly_system contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.level string Livello di voce di log
jsonPayload.message string Messaggio di log
jsonPayload.messageCode string Codice del messaggio specifico di Wildfly che precede il log, ove 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 di log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da WildFly, devi creare un ricevitore per le metriche prodotti da WildFly, 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 wildfly, specifica i seguenti 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 del tempo, 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 host:port, utilizzato per creare l'URL del servizio service:jmx:remote+http://<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
GAUGEINT64
gce_instance
data_source
state
workload.googleapis.com/wildfly.jdbc.request.wait
CUMULATIVEINT64
gce_instance
data_source
workload.googleapis.com/wildfly.jdbc.rollback.count
CUMULATIVEINT64
gce_instance
cause
workload.googleapis.com/wildfly.jdbc.transaction.count
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/wildfly.network.io
CUMULATIVEINT64
gce_instance
listener
server
state
workload.googleapis.com/wildfly.request.count
CUMULATIVEINT64
gce_instance
listener
server
workload.googleapis.com/wildfly.request.server_error
CUMULATIVEINT64
gce_instance
listener
server
workload.googleapis.com/wildfly.request.time
CUMULATIVEINT64
gce_instance
listener
server
workload.googleapis.com/wildfly.session.active
GAUGEINT64
gce_instance
deployment
workload.googleapis.com/wildfly.session.count
CUMULATIVEINT64
gce_instance
deployment
workload.googleapis.com/wildfly.session.expired
CUMULATIVEINT64
gce_instance
deployment
workload.googleapis.com/wildfly.session.rejected
CUMULATIVEINT64
gce_instance
deployment

Verificare la configurazione

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore WildFly. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere i dati di telemetria.

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

  1. Nel pannello di navigazione della console Google Cloud, seleziona Logging, quindi 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("wildfly_system")
    

Per verificare che le metriche WildFly vengano inviate a Cloud Monitoring, segui questi passaggi:

  1. Nella console Google Cloud, vai alla pagina Metrics Explorer :

    Vai a Metrics Explorer

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

  2. Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è  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 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/wildfly.network.io'
    | every 1m
    

Visualizza dashboard

Per visualizzare le metriche WildFly, devi aver configurato un grafico o una dashboard. L'integrazione di WildFly 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:

  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 il cui sottotitolo è Monitoring.

  2. Seleziona la scheda Elenco dashboard, quindi scegli la categoria Integrazioni.
  3. 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:

  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 il cui sottotitolo è Monitoring.

  2. Fai clic sul filtro piattaforma di deployment di Compute Engine.
  3. Individua la voce relativa a 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 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 WildFly 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. Nella console Google Cloud, vai alla pagina  Integrazioni:

    Vai a Integrazioni

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

  2. Individua la voce relativa a WildFly e fai clic su View Details (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 le notifiche relative all'attivazione dell'avviso, per cui 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. 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.

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