Composant SYSLOG

Généralités

Ce composant permet de générer des logs de type Windows (journaux d'événements logiciel).

Un exemple d'utilisation se trouve sous \cvsroot\oxyprj.700\Exemples\syslog\

 

C'est un composant serveur, qui gère un tableau d'objets Logger référencés par un nom de module (le nom de l'applicatif qui l'utilise).

Il se base sur un Service (processus masqué et permanent dans Windows).

Les logs sortent sous c:\windows\logger.

 

Remarque : Une alternative séparée avec des journaux textes simples est possible : voir les méthodes en fin de page.

Méthodes publiques

La méthode LOG

Paramètres : 

Chaine nomModule

Entier errorCode

Chaine message

Le paramètre nomModule est généralement le nom du fichier (du composant ou de la DLL).

Le code d'erreur errorCode sert à différencier et à filtrer les erreurs dans le viewer de logs.

5000 est le plus bas niveau d'erreur.

En règle générale :

< 1000 == erreur critique

1000 - 1999 == erreur non critique

2000 - 2999 == warning

3000 - 3999 == log niveau 1

4000 - 4999 == log niveau 2

>=5000 == log niveau 3

 

Exemple :

AppliquerMethodeComposant "SYSLOG"."LOG"("COMPTA", 3000, "INIT")

 

La méthode INITIALISER

Paramètres : 

Chaine nomModule

Entier seuil_erreur

Cette méthode sert à limiter les logs à un certain niveau d'erreur en l'appelant avant tout appel de la méthode LOG.

 

Exemple :

// limiter les logs aux erreurs de code < 4000
AppliquerMethodeComposant "SYSLOG"."INITIALISER"("COMPTA", 4)

Remarques

Pour que les logs s'inscrive dans le fichier, un service doit être lancé. Ce service est géré par logger.exe.

Il est possible de lancer logger.exe manuellement mais vérifiez que cet exécutable a été "registré" (référencé dans la base de registre) en service.

Le service doit ensuite être lancé manuellement dans le gestionnaire de service (il est donc possible de la lancer tout le temps).

 

Une notion de log journalier est gérée (les logs des jours précédents sont renommés, par exemple COMPTA.20060711.log)

Les logs sortent sous un format de type csv, et peuvent donc être importés dans Excel.

Un viewer spécialisé existe : logviewer.exe

 

Ajouter un événement dans le journal Windows (Observateur d'évènements)

La méthode AJOUTER_EVT_WIN

Parametres :

Entier pType //1=ERREUR, 2=WARNING, 4=INFORMATION

Chaine pTitre

Chaine pData

Méthodes pour créer un journal fichier simple

Permet d'ajouter facilement des informations dans un fichier texte au format TSV sans le service Windows. Les fichiers sont générés dans OXYPP\Journaux\[nom].log.

Dans votre application, une ligne suffit pour ajouter une information dans un journal.

AppliquerMethodeComposant SYSLOG.AJOUTER ("GESCOM", 2, CodeObjet, NomMethode, "Contrôle avant modification : Enregistrement "+IDENT+" réservé. EtatTable:"+EtatTable)

 

La méthode AJOUTER "Ajouter une ligne dans le journal"

Parametres:

Chaine pNom    ("Nom du journal")

Entier pType   ("1=info,2=warning,3=erreur")

Chaine pModule ("Code Composant-Objet")

Chaine pMethode("Code méthode")

Chaine pInfo   ("Informations")

Si le fichier OXYPP \Journaux\[pNom].log n'existe pas, il sera créé. Outre les informations passées en paramètre, chaque ligne du journal contiendra des informations sur la session.

Les colonnes sont : pType, Date, Heure, Utilisateur, Dossier, pModule,p Methode, pInfo

 

La méthode EFFACER "Supprimer un journal"

Parametres:

Chaine pNom    ("Nom du journal")