Généralités

Les statistiques liées aus services globales utilisent les enregistrements de code CTARG et CCALL_EXT ).

Voici un extrait d'enregistrement de ces évènements :

2004-11-10 15:50:49,100 ent2 SSTART employee 20 user0003 6
2004-11-10 15:50:49,100 ent2 CCALL_EXT employee 20 user0003 mailpers 1
2004-11-10 15:53:59,437 ent2 SSTOP employee 20 user0003 6
2004-11-10 15:53:59,438 ent2 CTARG employee 20 user0003 pers-esup-annu 2 10
2004-11-10 15:53:59,440 ent2 CTARG employee 20 user0003 etu-esup-annu 2 10
2004-11-10 15:53:59,442 ent2 CTARG employee 20 user0003 esup-webdav 1 25

Description de l'utilitaire

C'est un programme perl, traiteStatsServicesEsup.pl . Il utilise les librairies common.pm et common_services.pm.

D'une manière générale, il exploite en entrée un fichier stats.log mensuel issu d'esup-portail (voir cet exemple de fichier stats.log) , et produit en sortie un fichier xml qui synthétise l'activité du mois (voir cet exemple de fichier stats.serv.xml).

Il est exécuté depuis un script shell traiteStatsEsup.sh, qui réalise des pré-traitements (tri et 'nettoyage' du fichier en entrée, cacul du mois à traiter, ...).

Le fichier principal en entrée doit être trié par date. S'il contient des lignes avec des dates en dehors du mois choisi, ces lignes sont automatiquement rejetées.

Les différentes statistiques sont fournies en fonction de catégories d'utilisateurs d'esup-portail.

Le code retour est égal à 0 s'il n'y a pas d'erreur fatale, différent de 0 sinon.

Ce chapitre décrit le fonctionnement général de cet utilitaire.

Arguments de ce programme

La syntaxe de lancement est la suivante :

traiteStatsServicesEsup.pl [-mois <mois>] [-etablissement <etablissement>] [-ficstat <ficstat>] [-ficxml <ficxml>] [-ficmaptypes <ficmaptypes>] [-ficmapserv<ficmapserv>] [-noprintdays] [-noprinttrait]

Les arguments sont précédés du caractère "-" ; aucun argument n'est obligatoire.

Il détermine le mois concerné pour les statistiques. Le format est "AAAA-MM".
ex : -mois 2004-11
Par défaut, la première date rencontrée dans le fichier à traiter indique le mois de traitement

facultatif. L'argument suivant permet d'indiquer l'établissement concerné dans le rapport xml de sortie.
Par défaut : univ.fr

facultatif. Indique le nom du fichier de stats issu d'esup-portail.
Par défaut : ./stats.log ou ./stats.AAAA-MM.log si l'argument -mois est passé.

facultatif. Indique le nom de fichier de résultat principal.
Par défaut : ./stats.AAAA-MM.xml

facultatif. Indique le nom du fichier permettant la correspondance entre des catégories de personnes issues du fichier de stats esup-portail et les catégories du rapport final.
Par défaut : ./types.map

facultatif. Indique le nom du fichier permettant de faire la correspondance entre des 'fnames" de services, et le nom du service du rapport final.
Par défaut : ./services.map

facultatif. Si présent, évite la sortie de l'élément <days> dans l'état xml principal, et de ses sous-éléments

facultatif. Si présent, évite la sortie de l'élément <traitement> dans l'état xml principal, et de ses sous-éléments

Fichiers manipulés

Les fichiers manipulés par cet utilitaire sont les suivants :

ficstats

C'est le fichier de logs de sessions issu d'esup-portail. Voir cet exemple. Il est utilisé en entrée.

Dans le cas fort probable où plusieurs instances d'esup-portail fonctionnent en 'load-balancing', il faut s'assurer que le nom logique de chaque instance est bien renseigné ( esup.host.logicalName du fichier esup.properties ) afin d'éviter des risques d'anomalies.

Ce fichier doit impérativement être trié par date ascendante.

En cas de multiples serveurs, c'est la concaténation des fichiers des différents serveurs, triée ensuite par date.

ficmaptypes

C'est un fichier qui fait la correspondance entre des catégories d'usagers issus du portail, et les catégories qu'on désire voir afficher en sortie. Il est utilisé en entrée. En voici un exemple.

Le détail de ce fichier est décrit dans le document des indicateurs globaux.

ficmapservices

C'est un fichier qui fait la correspondance entre le nom logique d'un service (fname d'un canal, ou fname d'un appel à service externe), et le nom du service qu'on désire voir afficher en sortie. Il est utilisé en entrée. En voici un exemple.

C'est un fichier texte, dont chaque ligne utile est composée de 2 champs obligatoires et un facultatif, separés par un ou des caractères espace ou tabulation :

• fname en entree, donc tel qu'il est dans le fichier stats.log d'entree
• nom du serviceen sortie, donc tel qu'il apparaitra dans le fichier resultant
• identifiant du service. Cette information n'est pas nécessaire pour l'utilitaire traiteStatsServicesEsup.pl, mais servira de clé pour l'enrichissement d'une base de données des indicateurs esup.
  Les règles de formatage sont identiques au fichier précédent.

ficxml

C'est le fichier de résultat désiré, au format xml. Voir cet exemple.

Il donne d'abord une information globale pour le mois, puis pour chaque jours du mois, puis des informations concernant le déroulement du traitement.

La signification des différentes information est la suivante :

Pour les infos de stats d'utilisation :

• nbUsers : nombre d'utilisateurs ayant accédé au service pour la période donnée
• nbServicesCalls : nombre d'accès entrant au service spécifié
  Pour les infos relatives au traitement de l'utilitaire :

• firstDay : premier jour de traitement dans le mois
• lastDay : dernier jour de traitement dans le mois
• nbLines : nombre de lignes de type ouverture/fermeture de sessions traitées
• nbServ : nombre d'occurences logiques esup-portail traitées