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 WildFly, consultez la page wildfly.org/.

Prérequis

Pour collecter et ingérer des journaux WildFly, vous devez installer l'agent Ops version 2.12.0 ou ultérieure.

Ce récepteur est compatible avec les versions 25.x et 26.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 le fichier de configuration permettant de collecter et d'ingérer des journaux de WildFly, et de redémarrer l'agent Ops sous Linux.

sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
  receivers:
    wildfly_system:
      type: wildfly_system
  service:
    pipelines:
      wildfly_system:
        receivers:
          - wildfly_system
metrics:
  receivers:
    wildfly:
      type: wildfly
  service:
    pipelines:
      wildfly:
        receivers:
          - wildfly
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 WildFly, 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
`type`		La valeur doit être égale à `wildfly_system`.
`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. Exemple : `/var/log/wildfly/*.log`.
`exclude_paths`		Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à `include_paths`.
`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`. Renseigné sous la forme d'une durée, 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 logName des journaux wildfly_system 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.

Champ	Type	Description
`timestamp`	chaîne (`Timestamp`)	Heure de réception de la requête.
`jsonPayload.thread`	chaîne	Thread d'où provient le journal.
`jsonPayload.source`	chaîne	Source d'où provient le 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.message`	chaîne	Message de journal.
`severity`	chaîne (`LogSeverity`)	Niveau d'entrée de journal (traduit).

Les entrées de journal ne contiennent aucun champ vide ni manquant.

Configurer la collecte de métriques

Pour collecter des métriques à partir de WildFly, vous devez créer un récepteur pour les métriques WildFly, puis créer un pipeline pour le nouveau récepteur. Pour configurer un récepteur pour vos métriques WildFly, spécifiez les champs suivants :

Champ	Par défaut	Description
`type`		Cette valeur doit être `wildfly`.
`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`.
`username`		Le nom d'utilisateur configuré si JMX est configuré pour exiger une authentification.
`password`		Le mot de passe configuré si JMX est configuré pour exiger une authentification.
`collection_interval`	`60s`	Une valeur time.Duration, telle que `30s` ou `5m`.
`additional_jars`	`/opt/wildfly/bin/client/jboss-client.jar`	Le chemin d'accès au fichier `jboss-client.jar`, requis pour surveiller WildFly via JMX.

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	`state` `data_source`
`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	`state` `listener` `server`
`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`, `DOUBLE` gce_instance	`listener` `server`

Exemple de tableau de bord

Vous pouvez afficher les métriques de cette intégration à l'aide d'un exemple de tableau de bord Cloud Monitoring. Suivez les procédures décrites dans la section Installer des exemples de tableaux de bord pour importer le tableau de bord Présentation de WildFly GCE à partir de l'exemple de bibliothèque et afficher les graphiques qui présentent vos métriques WildFly.

Vérifier la configuration

Vous pouvez utiliser l'explorateur de journaux et l'explorateur de métriques pour vérifier que vous avez correctement configuré le récepteur WildFly. La collecte des journaux et des métriques 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"
logName=("projects/PROJECT_ID/logs/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.request.count'
| align rate(1m)
| 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).