A.3. Référence de Journalisation d'auditing de l'interface de gestion
En plus d'activer ou de désactiver la Journalisation de l'auditing de l'interface de gestion, vous pouvez utiliser les attributs de confiugration de logger
suivants.
- log-boot
- Si défini sur
true
, quand on démarre le serveur, les opérations de gestion seront incluses dans le log d'auditing, sinonfalse
. La valeur par défaut esttrue
. - log-read-only
- Si défini sur
true
, toutes les opérations d'auditing seront journalisées. Si défini surfalse
, seules les opérations qui changeront le modèle seront journalisées. La valeur par défaut est :false
.
Le formateur indique le format des entrées de journalisation. Il n'y a qu'un formateur disponible, qui transforme les entrées de journalisation en format JASON.
Exemple A.1. Inclut l'horodatage dans les archives log
/core-service=management/access=audit/json-formatter=json-formatter:write-attribute(name=include-date,value=true
)
Attributs de Formateurs de journeaux
- include-date
- Une valeur booléenne qui indique si oui ou non l'horodatage est inclus dans les archives log formatées. La valeur par défaut est
true
. - date-separator
- Une chaîne contenant des caractères à utiliser pour séparer la date du reste des messages log formatés. Sera ignoré si
include-date
=false
. La valeur par défaut est–
(espace, suivi d'un trait d'union, puis espace à nouveau). - date-format
- Format de date utilisé pour les horodatages compris par java.text.SimpleDateFormat. Ignoré si
include-date
=false
. La valeur par défaut estyyyy-MM-dd HH:mm:ss
. - compact
- Si défini sur
true
, formatera le JSON sur une seule ligne. Il y a sans doute encore des valeurs contenant de nouvelles lignes, donc s'il est important pour vous d'avoir l'enregistrement total sur une seule ligne, définirescape-new-line
ouescape-control-characters
àtrue
. La valeur par défaut estfalse
. - escape-control-characters
- Si défini sur
true
, échapera tous les caractères de contrôle (entrées ASCII à valeur décimales < 32) avec le code ASCII en octale ; par exemple, une nouvelle ligne devient#012
. Si défini surtrue
, remplaceraescape-new-line
=false
. La valeur par défaut estfalse
. - escape-new-line
- Si défini sur
true
, échappera toutes les nouvelles lignes avec le code ASCII en octale, comme par exemple#012
. La valeur par défaut estfalse
.
Un gestionnaire de fichiers indique les paramètres par lesquels les enregistrements de journalisation sont mis dans les fichiers. Il indique plus particulièrement le formateur, le nom du fichier et le chemin d'accès du fichier.
Attributs de Gestionnaire de fichiers
- formatter
- Le nom d'un formateur JSON à utiliser pour formater les enregistrements de journalisation. La valeur par défaut est
json-formatter
. - path
- Le chemin d'accès du fichier de journalisation de l'auditing. La valeur par défaut est
audit-log.log
. - relative-to
- Le nom d'un chemin d'accès déjà nommé, ou d'un des chemins standard fournis par le système. Si
relative-to
est donné, la valeur de l'attribut du chemin d'accès sera traitée comme relative au chemin spécifié par cet attribut. La valeur par défaut estjboss.server.data.dir
. - failure-count
- Le nombre d'échecs de journalisation depuis l'initialisation du gestionnaire. La valeur par défaut est 0.
- max-failure-count
- Le nombre maximum d'échecs de journalisation avant de désactiver ce gestionnaire. La valeur par défaut est 10.
- disabled-due-to-failure
- Sur
true
si ce gestionnaire était désactivé à cause des échecs de journalisation. La valeur par défaut estfalse
.
Un gestionnaire de syslog indique les paramètres par lesquels les entrées de journalisations d'auditing sont envoyées à un serveur syslog, comme le nom d'hôte du serveur syslog et le nom du port sur lequel le serveur syslog écoute.
/core-service=management/access=audit/syslog-handler=mysyslog:read-resource-description(recursive=true)
Attributs de Gestionnaire Syslog
- app-name
- Le nom de l'application à ajouter aux archives syslog ainsi défini dans la section 6.2.5 de RFC-5424. Si non spécifié, aura comme valeur par défaut le nom du produit.
- disabled-due-to-failure
- Sur
true
si ce gestionnaire était désactivé à cause des échecs de journalisation. La valeur par défaut estfalse
. - fonctionnalité
- La fonctionnalité à utiliser pour la journalisation de syslog ainsi définie dans la section 6.2.1 de RFC-5424, et la section 4.1.1 de RFC-3164.
- failure-count
- Le nombre d'échecs de journalisation depuis l'initialisation du gestionnaire. La valeur par défaut est
0
. - formatter
- Le nom d'un formateur à utiliser pour formater les enregistrements de journalisation. La valeur par défaut est
json-formatter
. - max-failure-count
- Le nombre maximum d'échecs de journalisation avant de désactiver ce gestionnaire. La valeur par défaut est
10
. - max-length
- La taille maximum d'un message de journalisation (en octets), comprenant l'en-tête. Si non défini, la valeur par défaut sera de
1024
octets si lesyslog-format
estRFC3164
, ou2048
octets si lesyslog-format
estRFC5424
. - protocol
- Le protocole à utiliser pour le gestionnaire de syslog. Doit correspondre à l'un des protocoles suivants
udp
,tcp
outls
. - reconnect-timeout
- Disponible à partir de JBoss EAP 6.4. Le nombre de secondes à attendre avant de tenter de se reconnecter au serveur de syslog, en cas de perte de connectivité. La valeur par défaut est :
-1
(désactivé). - syslog-format
- Format de Syslog : RFC-5424 ou RFC-3164. Valeur par défaut :
RFC-5424
. - truncate
- Indique si un message et son en-tête doivent ou non être tronqués quand la longueur en octets est supérieure à la
max-length
(longueur maximale) de l'attribut. Si la valeur est définie surfalse
, les messages seront divisés et envoyés avec les mêmes valeurs d'en-tête. La valeur par défaut estfalse
.