Interface XML pour les Messages Syslog

Présentation au sujet: "Interface XML pour les Messages Syslog"— Transcription de la présentation:

1 Interface XML pour les Messages Syslog
cch

2 Sommaire  Introduction
-Contenu  Information sur l'interface XML pour les messages syslog  Configurer le formatage XML des messages syslog  Exemples de configuration pour le formatage XML des messages syslog  Références additionnelles cch

3 Information sur l'interface XML pour les messages syslog
Introduction La fonctionnalité de l'interface XML pour les messages Syslog fournit des commandes CLI (Command Line Interface) pour valider la transmission de messages Syslog au format XML (eXtendable Markup Language). Les logs au format XML standardisé sont plus facilement utilisables par des outils de supervision externes personnalisés. Historique Release Modification 12.2(15)T Introduction de cette fonctionnalité Contenu  Information sur l'interface XML pour les messages syslog  Configurer le formatage XML des messages syslog  Exemple de configuration pour le formatage XML des messages syslog  Références additionnelles Information sur l'interface XML pour les messages syslog Pour configurer la fonctionnalité interface XML des messages Syslog, vous devez com- prendre les concepts suivants:  Système de message de log de l'IOS Cisco  Système de message de log formaté XML  Formatage du système de message de log Système de message de log de l'IOS Cisco Le processus du système de message de log de l'IOS Cisco (syslog) permet au système de rapporter et de sauvegarder des messages d'erreur et de notification importants soit localement soit vers un serveur de log distant. Ces messages syslog comprennent des messages au format standard (souvent appelés messages d'erreur système) et des sorties de commandes debug. Ces messages sont générés durant le fonctionnement du réseau pour aider les utilisateurs et les ingénieurs du TAC Cisco à identifier le type et la sévérité d'un problème ou pour aider les utilisateurs dans la supervision de l'ac- tivité du routeur. Les messages syslog peuvent être transmis vers la console, un termi- nal (TTY ou Telnet), un buffer système ou des hosts distants. Note: le processus des messages de log dans le logiciel IOS Cisco appelé "syslog". Les messages générés par ce processus sont appelés "messages syslog". Cependant, les messages syslog sont également référencés dans la documentation de l'IOS Cisco com- me "system error messages" ou "SEMS". Notez que les messages syslog ne sont pas cch

4 restreints aux conditions d'erreur et peuvent correspondre à des messages purement
informationnels. Système de message de log formaté XML XML, dérivé de SGML, fournit un système pour structurer des données formatées lo- giquement telles que celles présentes dans les messages syslog. L'interface XML des messages Syslog fournit des commandes CLI pour permettre la transmission de messages syslog au format XML. Le logs dans un format XML stan- dardisé peuvent être plus facilement lus et exploités par des outils de supervision per- sonnalisés. Dans l'IOS Cisco un ensemble limité de tags XML très significatifs est dé- fini et appliqués, lorsqu'ils sont validés, aux messages syslog transmis vers la console, un terminal, un buffer système ou des hosts distants. Deux formats de système de log existent dans le logiciel IOS Cisco: le format de log standard et le format XML. Cela signifie que vous pouvez spécifier que les messages de log standards sont transmis vers un host distant tandis que les messages de log au format XML sont transmis vers un autre host. De manière similaire, si les messa- ges de log sont transmis vers un buffer système, le buffer de log XML est séparé du buffer de log standard et vous pouvez avoir les deux buffers simultanément. Le processus de log XML est dépendant du processus de log standard. Dans la majo- rité des cas, les paramètres pour le processus de log standard sont transférables vers le processus de log XML. Par exemple le niveau de sévérité pour la commande logging buffered xml est déterminé par le niveau fixé par la commande logging buffered (ou s'il n'est pas fixé, par le niveau de sécurité par défaut du buffer standard). De manière similaire, la taille par défaut du buffer le logging XML est la même que la valeur par défaut de la taille du buffer de logging standard (la taille de buffer par défaut varie selon la plateforme). Formatage du système de message de log Les messages du système de log ont le format suivant: %<facility>-<severity>-<mnemonic>: <message-text> Par exemple: %LINK-5-CHANGED: Interface Serial3/3, changed state to administratively down Usuellement ces messages sont précédés par du texte additionnel tel que la marque de temps et le numéro de séquence du message: <sequence-number>: <date or system-up-time> <time>:%<facility>-<severity>- <mnemonic>: <message-text> 000013: Mar 18 14:52:10.039:%LINK-5-CHANGED: Interface Serial3/3, changed state to administratively down cch

5 Note: Le format de marque de temps utilisé dans les messages du système de log est
déterminé par la commande service timestamps en mode de configuration global. La commande service sequence-numbers en mode de configuration global valide ou dé- valide la présence du numéro de séquence en tête du message. Une astérisque (*) de- vant la marque de temps indique que le temps peut être incorrect à cause de l'horloge système qui n'a pas pu être synchronisée avec une source de temps fiable. Le tableau suivant montre les tags XML appliqués au messages syslog (format XML): Tag appliqué Item délimité <ios-log-msg></ios-log-message> Message syslog complet. <facility></facility> Nom de Facilité. FACILITY est un code constitué de deux ou plusieurs lettres majuscules qui indi-quent la facilité à la laquelle le message fait réfé-rence. Une facilité peut être un équipement maté-riel, un protocol ou un module du logiciel système. <severity></severity> Valeur de Sévérité . SEVERITY est code à un chif-fre de 0 à 7 qui reflète la condition de sévérité. Plus le chiffre est petit plus la situation est critique. <msg-id></msg-id> Mnémonique. MNEMONIC est un code (usuelle- ment une abréviation) qui identifie de manière unique le type d'erreur ou d'évènement. <seq></seq> Numéro de séquence du message. <time></time> Marque de temps incluant la date et l'heure ou le temps de fonctionnement du système (depuis le dernier redémarrage). <args></args> Les variables dans le texte du message. Le texte clairement lisible n'est pas repris en XML. Seules les variables sont extraites et formatées. Les varia-bles dans un message d'erreur sont identifiées avec des crochets ( [chars], [hex], [int], etc..) dans la documentation Cisco. Par exemple: %LINK-5-CHANGED: : Interface [chars], changed state to [chars] Pour le texte complet des messages syslog, voir le document "Cisco IOS System Error Messages." <arg id=“x”></arg> Argument spécifique. "x" est un numéro séquentiel d’ID de variable commençant à 0. L'exemple suivant montre un message syslog au format standard, suivi du même message avec le formatage XML. Format de message Syslog standard 000013: *Oct 11 14:52:10.039: %SYS-5-CONFIG_I: Configured from console by vty0 ( ) cch

6 L'exemple suivant montre un message syslog au format standard, suivi du même
message avec le formatage XML. Format de message Syslog XML <ios-log-msg><facility>SYS</facility><severity>5</severity><msg-id>CONFIG_I</msg-id> <seq>000013</seq><time>*Oct 11 14:52:10.039</time><args><arg id=“0”>console</arg> <argid=“1”>vty0 ( )</arg></args></ios-log-msg> Note: Les messages du système de log comprennent les messages de debugging quand le debugging est validé sur le routeur et que le log est configuré pour enregistrer les messages de niveau de sévérité 7. Cependant les messages de debugging n'utilisent pas le format de message du système de log. Le formatage XML ne sera pas par consé- quent appliqué à ce message. Comment configurer le formatage XML des messages Syslog Valider le logging au format XML consiste simplement à utiliser les commandes de logging appropriées pour indiquer vers où transmettre les messages de logging, suivies du mot clé xml. Le système de message de logging standard est validé par défaut, le formatage XML de ces messages est dévalidé par défaut. Comme cela a été dit précédemment, le processus de formatage XML du logging est séparé (mais dépendant) du processus de logging standard ainsi vos pouvez configurer le formatage XML du logging en plus du système de logging standard si la destination est un host distant ou un buffer système. Résumé des commandes Pour valider le formatage XML des messages syslog, utilisez une des commandes en mode de configuration global. • logging console xml • logging monitor xml • logging buffered xml • logging host {ip-address | host-name} xml Pour voir l'état du logging et le contenu du buffer de logging XML, utilisez la comman- de show logging xml en mode EXEC. Pour effacer le contenu du buffer de logging XML, utilisez la commande clear logging xml en mode EXEC. cch

7 cch Commandes détaillées Commande But
logging console xml [severity-level] Exemple: Routeur(config)#logging console xml informational Valide le système de message de logging vers la console au format XML. Les messages du ou en dessous de du niveau de sévérité seront loggués. Le niveau de sévérité par défaut varie selon les plateformes mais générale-ment il est égal à 7 (debugging) ce qui veut dire que tous les messages de tous les niveaux de sé- vérité (0 à 7) sont loggués. logging monitor xml [severity-level] Routeur(config)#logging monitor xml 6 Valide le système de message de logging vers les connexions moniteur (Tout TTY disponible ou Telnet) au format XML. Notez que par défaut l'affiche des messages de logging est souvent dévalidé par défaut ce qui veut dire que les messages ne seront pas affichés sur un terminal jusqu'à ce que vous entriez la commande terminal monitor en mode EXEC. logging buffered xml [xml-buffer-size] Routeur(config)#logging buffered xml 14336 Valide le système de logging vers le buffer systè-me au format XML. Le niveau de sévérité des messages loggués est déterminé par les paramètres de la commande logging buffered. Si la commande logging buffered n'a pas été utilisée, le niveau de sévérité par défaut de cette commande est utilisé. Le ni- veau de sévérité par défaut varie selon les plate- formes mais il est généralement égal à 7 (debug- ging) ce qui signifie que les messages de tous les niveaux de sécurité sont (0 à 7) loggués. Pour plus d'information sur les niveaux de sévérité, voir la documentation de la commande logging buffered. La taille par défaut du buffer de logging XML va- rie selon les plateformes. (La taille du buffer de logging XML est la même que celle par défaut du buffer de logging standard). L'intervalle pour la taille du buffer XML va de 4096 à octets (4 Koctets à 2 Gigaoctets). cch

8 Exemples de configuration pour le formatage XML des messages syslog
Commande But logging host {ip-address | host-name} xml Exemple: Routeur(config)# logging host xml logging host xml Valide le système de logging vers le host spécifié au format XML. En entrant cette commande plusieurs fois, vous construisez une liste de serveurs syslog qui reçoivent les messages de logging. Note: Pour transmettre la sortie de logging standard vers un host et le logging formaté XML vers un autre host, vous devez spécifier des adresses (ou des noms) IP différentes dans la commande logging host (standard). Le niveau de sévérité par défaut varie selon les plateformes mais il est généralement égal à 7 (debugging) ce qui signifie que les messages de tous les niveaux de sécurité sont (0 à 7) loggués. Pour spécifier le niveau de sévérité du logging vers tous les hosts distants, utilisez la commande logging trap. Exemples de configuration pour le formatage XML des messages syslog Dans l'exemple suivant, le logging est validé et ensuite les enregistrements vers le buffer standard et le buffer XML sont validés. Les deux dernières commandes show logging comparent les différences entre le buffer syslog standard et le buffer syslog XML. Router#show logging Syslog logging: disabled (10 messages dropped, 5 messages rate-limited, 6 flush) Console logging: disabled Monitor logging: disabled Buffer logging: disabled, xml disabled Logging Exception size (8192 bytes) Count and timestamp logging messages: disabled Trap logging: level informational, 31 message lines logged Router#config terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)#logging on Router(config)#logging buffered Router(config)#end Syslog logging: enabled (10 messages dropped, 5 messages rate-limited, 6 flushed) Buffer logging: level debugging, 1 messages logged, xml disabled Trap logging: level informational, 32 message lines logged Log Buffer (8192 bytes): 1w0d: %SYS-5-CONFIG_I: Configured from console by console cch

9 Références additionnelles
Router#config terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)#logging buffered xml Router(config)#end Router#show logging Syslog logging: enabled (10 messages dropped, 5 messages rate-limited, 6 flushes, 0 overruns, xml enabled) Console logging: disabled Monitor logging: disabled Buffer logging: level debugging, 2 messages logged, xml enabled (1 messages logged) Logging Exception size (8192 bytes) Count and timestamp logging messages: disabled Trap logging: level informational, 33 message lines logged Log Buffer (8192 bytes): 1w0d: %SYS-5-CONFIG_I: Configured from console by console Router#show logging xml <syslog-logging status="enabled" msg-dropped="10" msg-rate-limited="5" flushes="6" overruns="0"><xml>enabled</xml></syslog-logging> <console-logging>disabled</console-logging> <monitor-logging>disabled</monitor-logging> <buffer-logging level="debugging" messages-logged="2"><xml messages-logged="1">enabled</xml></buffer-logging> <logging-exception size="8192 bytes"></logging-exception> <count-and-timestamp-logging status="disabled"></count-and-timestamp-logging> <trap-logging level="informational" messages-lines-logged="33"></trap-logging> <log-xml-buffer size="8192 bytes"></log-xml-buffer> <ios-log-msg><facility>SYS</facility><severity>5</severity><msg-id>CONFIG_I</msg-id> <time> 1w0d</time><args><arg id="0">console</arg> Router# Références additionnelles Documents liés Sujet Titre du document Système de message de log "Cisco IOS Configuration Fundamentals Configura-tion Guide, Release 12.2"; chapitre Troubleshooting and Fault Management Messages d'erreur système "Cisco IOS System Error Messages, Release 12.2" Messages systèmes Debug-level “Cisco IOS Debug Command Reference, Release 12.2” Standards XML n'est pas un standard Internet. La recommandation XML 1.0 (Extensible Mark- up Language (XML) 1.0 (Second Edition)) est défini à Voir également le RFC 3076. cch

10 cch MIBs Aucune MIB n'est associée à cette fonctionnalité. RFCs RFC
Titre RFC 3470 “Guidelines for the Use of Extensible Markup Language (XML) within IETF Protocols” (Status: BEST CURRENT PRACTICE) cch