14.3.4. Configurer un log handler de fichiers dans le CLI

Les log handlers de fichiers peuvent être ajoutés, supprimés ou modifiés dans le CLI.
Voici les tâches principales qui vous reviendront pour configurer un log handler de fichiers :
  • Ajouter un nouveau log handler de fichiers.
  • Afficher la configuration d'un log handler de fichiers
  • Définir le niveau de journalisation du handler.
  • Définir le comportement d'ajout du handler.
  • Définir si le handler utilise autoflush ou non.
  • Définir la codification utilisée pour la sortie du handler.
  • Indiquer le fichier dans lequel le log handler écrit.
  • Définir le formateur utilisé pour la sortie du handler.
  • Supprimer un log handler de fichiers.

Important

Pour la configuration d'un handler de journalisation dans un profil de journalisation, la racine (root) du chemin de configuration est /subsystem=logging/logging-profile=NAME/ au lieu de /subsystem=logging/.
Ajouter un log handler de fichiers
Utiliser l'opération add avec la syntaxe suivante. Remplacer PATH par le nom du fichier dans lequel le log est écrit. Remplacer DIR par le nom du répertoire dans lequel le fichier se trouve. La valeur DIR peut correspondre à une variable de chemin. 
 /subsystem=logging/file-handler=HANDLER:add(file={"path"=>"PATH", "relative-to"=>"DIR"})

Exemple 14.20. Ajouter un log handler de fichiers

[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:add(file={"path"=>"accounts.log", "relative-to"=>"jboss.server.log.dir"})
{"outcome" => "success"}
[standalone@localhost:9999 /]
Afficher une configuration de log handler de fichiers
Utiliser l'opération read-resource avec la syntaxe suivante. Remplacer HANDLER par le nom du log handler de fichiers. 
 /subsystem=logging/file-handler=HANDLER:read-resource

Exemple 14.21. Utiliser l'opération read-resource

[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:read-resource
{
    "outcome" => "success",
    "result" => {
        "append" => true,
        "autoflush" => true,
        "encoding" => undefined,
        "file" => {
            "path" => "accounts.log",
            "relative-to" => "jboss.server.log.dir"
        },
        "filter" => undefined,
        "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n",
        "level" => undefined
    }
}
Définir le niveau de journalisation
Utiliser l'opération write-attribute avec la syntaxe suivante. Remplacer HANDLER par le nom du log handler de fichiers et LOG_LEVEL_VALUE par le niveau de journalisation à définir. 
 /subsystem=logging/file-handler=HANDLER:write-attribute(name="level", value="LOG_LEVEL_VALUE")

Exemple 14.22. Changer le niveau de journalisation

/subsystem=logging/file-handler=accounts_log:write-attribute(name="level", value="DEBUG")
{"outcome" => "success"}
[standalone@localhost:9999 /]
Définir le comportement d'ajout
Utiliser l'opération write-attribute avec la syntaxe suivante. Remplacer HANDLER par le nom du log handler de fichiers. Remplacer BOOLÉEN par false si vous souhaitez qu'un nouveau fichier de journalisation soit créé à chaque fois qu'un serveur d'applications est lancé. Remplacer BOOLÉEN par true si le serveur d'applications doit continuer à utiliser le même fichier. 
 /subsystem=logging/file-handler=HANDLER:write-attribute(name="append", value="BOOLEAN")

Exemple 14.23. Changer la propriété d'ajout

[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="append", value="true")
{
    "outcome" => "success",
    "response-headers" => {
        "operation-requires-reload" => true,
        "process-state" => "reload-required"
    }
}
[standalone@localhost:9999 /]
JBoss EAP 6 doit démarrer à nouveau pour prendre effet.
Définir auto flush
Utiliser l'opération write-attribute avec la syntaxe suivante. Remplacer HANDLER par le nom du log handler de fichiers et BOOLEAN par true si le handler doit écrire sa sortie immédiatement. 
 /subsystem=logging/file-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN")

Exemple 14.24. Changer la propriété autoflush

[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="autoflush", value="false")
{
    "outcome" => "success",
    "response-headers" => {"process-state" => "reload-required"}
}
[standalone@localhost:9999 /]
JBoss EAP 6 doit démarrer à nouveau pour prendre effet.
Définir le codage
Utiliser l'opération write-attribute avec la syntaxe suivante. Remplacer HANDLER par le nom du log handler de fichiers et ENCODING par le nom de codification du caractère qui convient. 
 /subsystem=logging/file-handler=HANDLER:write-attribute(name="encoding", value="ENCODING")

Exemple 14.25. Définir le codage

[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="encoding", value="utf-8")     
{"outcome" => "success"}
Changer le fichier dans lequel le log handler écrit.
Utiliser l'opération write-attribute avec la syntaxe suivante. Remplacer PATH par le nom du fichier du fichier dans lequel le log est écrit. Remplacer DIR par le nom du répertoire dans lequel le fichier se trouve. La valeur DIR peut correspondre à une variable de chemin. 
 /subsystem=logging/file-handler=HANDLER:write-attribute(name="file", value={"path"=>"PATH", "relative-to"=>"DIR"})

Exemple 14.26. Changer le fichier dans lequel le log handler écrit.

[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="file", value={"path"=>"accounts-debug.log", "relative-to"=>"jboss.server.log.dir"})
{"outcome" => "success"}
[standalone@localhost:9999 /]
Définir le formateur
Utiliser l'opération write-attribute avec la syntaxe suivante. Remplacer HANDLER par le nom du log handler de fichiers et FORMAT par le string de formateur requis. 
 /subsystem=logging/file-handler=HANDLER:write-attribute(name="formatter", value="FORMAT")

Exemple 14.27. Définir le formateur

[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts-log:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n")
{"outcome" => "success"}
[standalone@localhost:9999 /]
Supprimer un log handler de fichiers.
Utiliser l'opération remove avec la syntaxe suivante. Remplacer HANDLER par le nom du log handler de fichiers à supprimer. 
 /subsystem=logging/file-handler=HANDLER:remove

Exemple 14.28. Supprimer un log handler de fichiers.

[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:remove
{"outcome" => "success"}
[standalone@localhost:9999 /]
Un log handler ne peut être supprimé que s'il ne peut pas être référencé par une catégorie de journalisation ou par un log handler async.
Rapporter un bogue