Red Hat Training

A Red Hat training course is available for Red Hat JBoss Enterprise Application Platform

12.3.7. Configurer un gestionnaire de journal de taille de fichiers périodique en rotation dans l'interface CLI

Les gestionnaire de journaux de taille de fichiers périodiques en rotation peuvent être ajoutés, supprimés ou modifiés dans le CLI.
Voici les tâches principales qui vous reviendront pour configurer un gestionnaire de journal de taille de fichiers périodique en rotation :
  • Ajouter un nouveau gestionnaire de journal de taille de fichiers périodique en rotation.
  • Afficher la configuration d'un gestionnaire de taille de fichiers périodique en rotation.
  • Définir le niveau de journalisation du gestionnaire
  • Définir le comportement d'ajout du gestionnaire.
  • Définir si le gestionnaire utilise autoflush ou non.
  • Définir la codification utilisée pour la sortie du gestionnaire.
  • Indiquer le fichier dans lequel le gestionnaire de journal écrit.
  • Définir le formateur utilisé pour la sortie du gestionnaire.
  • Définir la taille maximum de chaque fichier journal.
  • Définir le nombre maximum de journaux de sauvegarde à conserver.
  • Définit l'option de démarrage de la rotation à l'amorçage pour le gestionnaire de taille de fichiers périodique en rotation.
  • Définir le suffixe pour les journaux en rotation.
  • Supprimer un gestionnaire de journal de taille de fichiers périodique en rotation.
Chacune de ces actions sont décrites ci-dessous.

Important

Pour la configuration d'un gestionnaire de taille de fichiers périodique en rotation dans un profil de journalisation de système autonome, la racine (root) du chemin de configuration est /subsystem=logging/logging-profile=NAME/ au lieu de /subsystem=logging/.
Dans un domaine géré, vous devez spécifier quel profil utiliser. Vous devez ajouter le nom de profil en début de chemin de configuration pour un domaine géré, et remplacer /subsystem=logging/ par /profile=NAME/subsystem=logging/.
Ajouter un nouveau gestionnaire de taille de fichiers périodique en rotation.
Utiliser l'opération add avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:add(file={"path"=>"PATH", "relative-to"=>"DIR"}) 
Remplacer gestionnaire par le nom du gestionnaire de journal. 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.

Exemple 12.54. Ajouter un nouveau gestionnaire de journal

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:add(file={"path"=>"periodic_size.log","relative-to"=>"jboss.server.log.dir"},suffix=".yyyy.MM.dd")
{"outcome" => "success"}
Afficher la configuration du gestionnaire de journal
Utiliser l'opération read-resource avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:read-resource 
Remplacer HANDLER par le nom du gestionnaire de journal.

Exemple 12.55. Afficher la configuration du gestionnaire de journal

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:read-resource
{
    "outcome" => "success",
    "result" => {
        "append" => true,
        "autoflush" => true,
        "enabled" => true,
        "encoding" => undefined,
        "file" => {
            "relative-to" => "jboss.server.log.dir",
            "path" => "periodic_size.log"
        },
        "filter-spec" => undefined,
        "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n",
        "level" => "ALL",
        "max-backup-index" => 1,
        "name" => "PERIODIC_SIZE",
        "named-formatter" => undefined,
        "rotate-on-boot" => false,
        "rotate-size" => "2m",
        "suffix" => ".yyyy.MM.dd"
    }
}
[standalone@localhost:9999 /]
Définir le niveau de journalisation du gestionnaire
Utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="level", value="LOG_LEVEL_VALUE") 
Remplacer HANDLER par le nom du gestionnaire de journal et LOG_LEVEL_VALUE par le niveau de journalisation à définir.

Exemple 12.56. Définir le niveau de journalisation du gestionnaire

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="level", value="TRACE")
{"outcome" => "success"}
[standalone@localhost:9999 /]
Définir le comportement d'ajout du gestionnaire.
Utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="append", value="BOOLEAN") 
Remplacer HANDLER par le nom du gestionnaire de journal. Remplacer BOOLÉEN par false si vous souhaitez qu'un nouveau fichier journal 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.
JBoss EAP 6 doit démarrer à nouveau pour prendre effet.

Exemple 12.57. Définir le comportement d'ajout du gestionnaire.

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="append", value="true")
{
    "outcome" => "success",
    "response-headers" => {
        "operation-requires-reload" => true,
        "process-state" => "reload-required"
    }
}
[standalone@localhost:9999 /]
Définir si le gestionnaire utilise autoflush ou non
Utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN") 
Remplacer HANDLER par le nom du gestionnaire de journal et BOOLEAN par true si le handler doit écrire sa sortie immédiatement.

Exemple 12.58. Définir si le gestionnaire utilise autoflush ou non

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="autoflush", value="true")
{"outcome" => "success"}
[standalone@localhost:9999 /]
Définir la codification utilisée pour la sortie du gestionnaire
Utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="encoding", value="ENCODING") 
Remplacer HANDLER par le nom du gestionnaire de journal et ENCODING par le nom de codification du caractère qui convient.

Exemple 12.59. Définir la codification utilisée pour la sortie du gestionnaire

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="encoding", value="utf-8")
{"outcome" => "success"}]
Indiquer le fichier dans lequel le gestionnaire de journal écrit
Utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="file", value={"path"=>"PATH", "relative-to"=>"DIR"}) 
Remplacer gestionnaire par le nom du gestionnaire de journal. 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.

Exemple 12.60. Indiquer le fichier dans lequel le gestionnaire de journal écrit

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="file", value={"path"=>"accounts_trace.log", "relative-to"=>"jboss.server.log.dir"})
{"outcome" => "success"}
Définir le formateur utilisé pour la sortie du gestionnaire.
Utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="formatter", value="FORMAT") 
Remplacer HANDLER par le nom du gestionnaire de journal et FORMAT par le string de formateur à définir ou le nom du formateur spécifié dans le fichier de configuration.

Exemple 12.61. Définir le formateur utilisé pour la sortie du gestionnaire.

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p (%c) [%t] %s%E%n")
{"outcome" => "success"}
Définir la taille maximum de chaque fichier journal
Utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="rotate-size", value="SIZE") 
Remplacer HANDLER par le nom du gestionnaire de journal et SIZE par la taille de fichier maximum.

Exemple 12.62. Définir la taille maximum de chaque fichier journal

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="rotate-size", value="50m")  
{"outcome" => "success"}
[standalone@localhost:9999 /]
Définir le nombre maximum de journaux de sauvegarde à conserver
Utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="max-backup-index", value="NUMBER") 
Remplacer HANDLER par le nom du gestionnaire de journal et NUMBER par le nombre de fichiers de journalisation à conserver.

Exemple 12.63. Définir le nombre maximum de journaux de sauvegarde à conserver

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="max-backup-index", value="5")
{"outcome" => "success"}
[standalone@localhost:9999 /]
Définit l'option de rotation au démarrage du periodic-size-rotating-file-handler
Une valeur par défaut de false indique qu'un nouveau fichier journal n'est pas créé au redémarrage du serveur.
Pour changer cela, utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="rotate-on-boot", value="BOOLEAN") 
Remplacer HANDLER par le nom du gestionnaire de journal periodic-size-rotating-file-handler. Remplacer BOOLEAN par true si un nouveau fichier journal periodic-size-rotating-file-handler doit être créé au redémarrage.

Exemple 12.64. Indique qu'il faut créer un nouveau fichier journal periodic-size-rotating-file-handler lors du redémarrage du serveur.

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="rotate-on-boot", value="true")
{"outcome" => "success"}
[standalone@localhost:9999 /]
Définir le suffixe pour les journaux en rotation
Utiliser l'opération write-attribute avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:write-attribute(name="suffix", value="SUFFIX") 
Remplacer HANDLER par le nom du gestionnaire de journal et SUFFIX par le string de suffixe à définir.

Exemple 12.65. 

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:write-attribute(name="suffix", value=".yyyy-MM-dd-HH")
{"outcome" => "success"}
[standalone@localhost:9999 /]
Supprimer un gestionnaire de journal
Utiliser l'opération remove avec la syntaxe suivante.
 /subsystem=logging/periodic-size-rotating-file-handler=HANDLER:remove 
Remplacer HANDLER par le nom du gestionnaire de journal.

Exemple 12.66. Supprimer un gestionnaire de journal

[standalone@localhost:9999 /] /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE:remove
{"outcome" => "success"}