WildFly

L'intégration WildFly collecte les journaux WildFly et les analyse en une charge utile JSON. Le résultat inclut la source, le code du message, le niveau et le message.

Pour plus d'informations sur WideFly, consultez la documentation WilFly.

Prerequisites

Pour collecter les données de télémétrie WildFly, vous devez installer l'agent Ops :

Pour les métriques, installez la version 2.12.0 ou ultérieure.
Pour les journaux, installez la version 2.11.0 ou ultérieure.

Cette intégration est compatible avec les versions 26.x et 25.x de WildFly.

Configurer votre instance WildFly

Pour exposer le point de terminaison JMX à distance, vous devez définir la propriété système jboss.bind.address.management. Par défaut, cette propriété est définie dans la configuration de WildFly. L'installation par défaut de WildFly ne nécessite aucune authentification JMX avec JMX exposé localement sur 127.0.0.1:9990.

Pour collecter les métriques de session, vous devez activer les statistiques sur le sous-système d'Undertow en exécutant la commande suivante à l'aide de la CLI JBoss :

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

Configurer l'agent Ops pour WildFly

En suivant le guide de configuration de l'agent Ops, ajoutez les éléments requis pour collecter les journaux de vos instances WildFly et redémarrez l'agent.

Exemple de configuration

La commande suivante crée la configuration permettant de collecter et d'ingérer la télémétrie pour WildFly, et redémarre l'agent Ops.

# 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

Configurer la collecte de journaux

Pour ingérer des journaux à partir de WildFly, vous devez créer des récepteurs pour les journaux produits par MongoDB, puis créer un pipeline pour les nouveaux récepteurs.

Pour configurer un récepteur pour vos journaux wildfly_system, spécifiez les champs suivants :

Champ	Par défaut	Description
`exclude_paths`		Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à include_paths.
`include_paths`	`[/opt/wildfly/standalone/log/server.log, /opt/wildfly/domain/servers/*/log/server.log]`	Liste des chemins d'accès du système de fichiers à lire en affichant chaque fichier. Un caractère générique (`*`) peut être utilisé dans les chemins d'accès. Par exemple, /var/log/wildfly/.log.
`record_log_file_path`	`false`	Si cette valeur est définie sur `true`, le chemin d'accès au fichier spécifique à partir duquel l'enregistrement de journal a été obtenu apparaît dans l'entrée de journal de sortie en tant que valeur du libellé `agent.googleapis.com/log_file_path`. Lorsque vous utilisez un caractère générique, seul le chemin du fichier à partir duquel l'enregistrement a été obtenu est enregistré.
`type`		La valeur doit être égale à `wildfly_system`.
`wildcard_refresh_interval`	`60s`	Intervalle d'actualisation pour les chemins d'accès de fichiers utilisant des caractères génériques dans include_paths. Donné en fonction de la durée d'analyse par `time.ParseDuration`, par exemple `30s` ou `2m`. Cette propriété peut s'avérer utile lorsque le débit de journalisation est élevé et que les fichiers journaux sont alternés plus rapidement que l'intervalle par défaut. La valeur doit être un multiple de 1 s.

Contenu consigné

Le champ logName est dérivé des ID de récepteur spécifiés dans la configuration. Les champs détaillés dans l'entrée de journal (LogEntry) sont les suivants.

Les journaux wildfly_system contiennent les champs suivants dans LogEntry :

Champ	Type	Description
`jsonPayload.level`	chaîne	Niveau de l'entrée de journal
`jsonPayload.message`	chaîne	Message du journal
`jsonPayload.messageCode`	chaîne	Code de message spécifique au caractère générique précédant le journal, le cas échéant.
`jsonPayload.source`	chaîne	Source d'où provient le journal.
`jsonPayload.thread`	chaîne	Thread d'où provient le journal
`severity`	chaîne (`LogSeverity`)	Niveau d'entrée de journal (traduit).

Configurer la collecte de métriques

Pour ingérer des métriques à partir de WildFly, vous devez créer des récepteurs pour les métriques produites par WildFly, puis créer un pipeline pour les nouveaux récepteurs.

Pour configurer un récepteur pour vos métriques wildfly, spécifiez les champs suivants :

Champ	Par défaut	Description
`additional_jars`	`/opt/wildfly/bin/client/jboss-client.jar`	Chemin d'accès au fichier jboss-client.jar, nécessaire pour surveiller WildFly via JMX.
`collection_interval`	`60s`	Une valeur time duration, telle que `30s` ou `5m`.
`endpoint`	`service:jmx:remote+http://localhost:9990`	L'URL du service JMX, ou l'hôte et le port utilisés pour créer l'URL du service. Cette valeur doit être au format `host:port`, qui permet de créer une URL de service `service:jmx:remote+http://<host>:<port>/jmxrmi`.
`password`		Le mot de passe configuré si JMX est configuré pour exiger une authentification.
`type`		Cette valeur doit être `wildfly`.
`username`		Le nom d'utilisateur configuré si JMX est configuré pour exiger une authentification.

Métriques surveillées

Le tableau suivant fournit la liste des métriques que l'agent Ops collecte à partir de l'instance WildFly.

Type de métrique
Genre, type Ressources surveillées	Libellés
`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`

Exemple de tableau de bord

Pour afficher vos métriques WildFly, vous devez configurer un graphique ou un tableau de bord. Cloud Monitoring fournit une bibliothèque d'exemples de tableaux de bord pour les intégrations, contenant des graphiques préconfigurés. Pour en savoir plus sur l'installation de ces tableaux de bord, consultez la page Installer des exemples de tableaux de bord.

Vérifier la configuration

Cette section explique comment vérifier que vous avez bien configuré le récepteur WildFly. La collecte de la télémétrie par l'agent Ops peut prendre une ou deux minutes.

Pour vérifier que les journaux sont ingérés, accédez à l'explorateur de journaux et exécutez la requête suivante pour afficher les journaux WildFly :

resource.type="gce_instance"
log_id("wildfly_system")

Pour vérifier que les métriques sont ingérées, accédez à l'explorateur de métriques et exécutez la requête suivante dans l'onglet MQL :

fetch gce_instance
| metric 'workload.googleapis.com/wildfly.network.io'
| every 1m

Étape suivante

Pour accéder à un tutoriel pas à pas expliquant comment utiliser Ansible pour installer l'agent Ops, configurer une application tierce et installer un exemple de tableau de bord, consultez la vidéo Install the Ops Agent to troubleshoot third-party applications (Installer l'agent Ops pour résoudre les problèmes liés à des applications tierces).