L’essentiel de la gestion des journaux dans K2

K2 blackpearl a une structure de journalisation unifiée. Cela permet à tous les composants de K2 blackpearl d’enregistrer les informations au même endroit, en tirant parti d’un mécanisme unique et en éliminant la nécessité de code supplémentaire. Cette structure de journalisation unifiée offre une variété d’options de journalisation pour le K2 HostServer, comme le choix de destination ou des types de fichier, de fixer individuellement les niveaux de gravité et plus encore. Cet article décrit les options disponibles du serveur hôte de journalisation, comment les configurer et les considérations de performance pour leur utilisation.

Le fichier de configuration des journaux K2

Le fichier utilisé pour définir le niveau de journalisation du K2 Host Server est appelé HostServerLogging.config. Il est généralement situé à l’emplacement C:\Program Files\K2 blackpearl\Host Server\Bin\HostServerLogging.config. Ce fichier peut être édité avec n’importe quel éditeur de texte (notepad par exemple). Sa structure est composée de 5 parties (nœuds) :

  • appSettings (traité dans un prochain article)
  • Extensions
  • ApplicationLevelLogSettings
  • CategoryList (traité dans un prochain article)
  • MessageList (traité dans un prochain article)
Les destinations (Extensions)

De manière standard, il existe cinq types de journalisation disponibles. Vous pouvez choisir l’activation d’un, de tous ou aucun d’entre eux. Chaque destination peut avoir un niveau de journalisation personnalisé. Les cinq types (et leur propriétés) disponibles sont :

  • Console: Les messages seront affichés dans la console K2 blackpearl Server lorsque le serveur est en cours d’exécution en mode console. Pour exécuter le serveur en mode console, arrêtez le service K2 blackpearl puis lancer le programme K2 blackpearl Server.
    K2server

    • Shorthand="True" est la propriété qui permet de réduire l’horodatage de la journalisation. False présente l’affichage complet.

    Console

  • Fichier (File) : les messages seront enregistrés dans un fichier journal (.log), enregistré à l’emplacement spécifié dans les propriétés de configuration.
    file

    • LogFileName=″HostServer.log″ permet de préciser le nom du fichier.
    • LogFilePath=″″ permet de changer sa destination
    • HashAlgorithm=″CRC32″ est l’outil de détection des erreurs utilisé. Si vous ne savez pas ce que cela signifie, ne changez pas la valeur
    • MaxFileSizeKB=″0″ est la taille maximale des fichiers
    • MaxLifeTimeSpan=″0:0:0:00″ est la limite de durée d’écriture dans le fichier (en j:h:m:ss). C’est à dire que le plus vieux message de chaque fichier ne peux excéder la durée de vie saisie. Les entrées suivantes seront ajoutées dans un nouveau fichier.
  • Observateur des événements Windows (Windows Event Log) : les messages seront enregistrés dans l’observateur d’événements Windows (Event viewer) de la machine.
    EventViewer
  • MS Message Queue (MSMQ) : Les messages peuvent être enregistrés dans le Microsoft Messaging Queue. Un enregistreur peut alors être configuré pour surveiller le Message Queue et prendre des mesures si nécessaire. C’est utile lorsque plusieurs serveurs K2 blackPearl sont exécutés dans une ferme de serveurs par exemple. Nous ne nous attarderons pas sur cette configuration dans cet article.
    • QueuePath=″./private$/SCQueue″
  • Base de données SQL (SQL database) : les messages seront enregistrés dans la table d’une base de donnée SQL Serveur. Cela permet par exemple d’exécuter des requêtes à l’apparition d’une entrée. Par défaut, les messages seront enregistrés à l’adresse de connexion HostServerDB, mais la base de données de destination peut être modifiée en changeant les propriétés associées à cette extension.
    • HostServerConfigFileName=″K2HostServer.config″
    • ConfigDBConnectionName=″HostserverDB″

Chaque destination introduit son propre niveau de gestion pour le serveur K2. Par conséquent, il est important d’équilibrer la quantité d’informations, la destination et les performances du serveur.

 Avant toute modification dans le fichier de configuration, pensez à prendre les précautions nécessaires et faire une sauvegarde du fichier original, afin de faciliter le retour arrière en cas d’erreur de configuration.

 Les modifications seront prises en compte lors du redémarrage du service K2.

Les niveaux de journalisation (ApplicationLevelLogSettings)

Chaque extension peut être configurée individuellement  avec son propre niveau de journalisation. Les valeurs Active=“True” / “False” permettent d’activer et de désactiver une destination. La valeur de LogLevel permet de définir le niveau de journalisation. Les niveaux sont les suivants (standard log4net), du plus sévère au moins sévère (du moins verbeux au plus verbeux) :

      • Error
      • Warning
      • Info
      • Debug
      • All

 Configurer un niveau inclus tous les messages de sécurité plus sévère, c’est à dire qu’un niveau à Info renverra les journaux Info, Warning et Error.

 Ne changer les niveaux de sécurité que si nécessaire et pendant une durée précise. Un niveau All pour File sur un serveur de production va générer des centaines de Mo par jour sur le serveur.

Le K2 Host server configurator

Le Market de l’espace communautaire K2 propose un outil pour configurer les différents paramètres de cet article, sans risque de faire une erreur dans le fichier. Vous le trouverez à cette adresse : K2 Host server configurator. Cet outil permet également de configurer la journalisation des smartobjects, qui sera présenté dans le deuxième article concernant la gestion des journaux dans K2.

K2 Host server configurator

C’est tout pour cette fois, cheers !

benjamin

Technical Specialist @t K2 France ----- Twitter : @benjaminbertram ----- LinkedIn : Benjamin Bertram

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.