SNMP

Les métriques SNMP sont accessibles sur le serveur par le port 9161, configurable dans le fichier conf/snmp.properties.

Par défaut, le préfixe OID par lequel les métriques sont accessibles est le 2.16.756.5.1332

Activation de SNMP et configuration de base

Par défaut l’accès par SNMP n’est pas activé. Il faut configurer les paramètres de base de l’agent SNMP dans le fichier de configuration conf/snmp.properties et l’activer.

Les paramètres de base sont les suivants :

  • snmp.enabled=false - Booléen, mettre à true pour que l’agent SNMP soit activé.
  • snmp.port=9161 - Port sur lequel l’agent écoute les requêtes.
  • snmp.base=.2.16.756.5.1332 - Identifiant de base pour les différentes métriques.
  • snmp.sysdesc=SAINet Application Server - Identifiant système pour identifier l’agent.
  • snmp.community=snmprd - Communauté SNMP dans laquelle l’agent travaille et répond.

Métriques de méthodes business

Chaque appel serveur impliquant une méthode business est mesuré et comptabilisé dans les métriques exportées. Le nombre ainsi que le temps moyen d’exécution sont accessibles par SNMP, sous le préfixe 2.16.756.5.1332.300

Le format ensuite pour accéder aux différentes métriques est 2.16.756.5.1332.300.tache.methode.metrique

Codes de tâche

Les codes de tâche sont configurés dans le fichier de propriétés conf/snmp.properties. Seules les tâches configurées dans ce fichier sont accessibles par SNMP pour des raisons pratiques de stabilité des identifiants.

snmp.tasks.enabled=SYS00,ADR02,ADR03,ADR05,ADR40,ADRHI,ADRV2,GTP40,GTPLC

snmp.tasks.ADR02=100
snmp.tasks.ADR03=101
snmp.tasks.ADR05=102
snmp.tasks.ADR40=103
snmp.tasks.ADRHI=104
snmp.tasks.ADRV2=105

snmp.tasks.GTP40=201
snmp.tasks.GTPLC=202

snmp.tasks.SYS00=302

Dans cet exemple, la tâche ADR02 sera par exemple accessible par le préfixe 2.16.756.5.1332.300.100.methode.metrique, la tâche ADRHI elle sera accessible par 2.16.756.5.1332.300.104.methode.metrique.

Il est possible d’énumérer les tâches en accédant directement à l’OID, sans préciser d’identifiant de méthode ou de métrique :

$ snmpget -c public -v 2c localhost:9161 2.16.756.5.1332.300.100
joint-iso-ccitt.16.756.5.1332.300.100 = STRING: "ADR02"

Codes de méthode

Toutes les méthodes business de SAINet sont mesurées et exportées. Toutes les tâches n’utilisent pas toutes les méthodes, par exemple les tâches de vue ne feront pas d’appel de modification d’entrée. Le compteur ne fera aucune erreur si l’on tente d’y accéder mais restera à 0.

Méthode
getUserInfos 900
getServerInfos 901
login 902
logout 903
uploadFile 910
downloadFile 911
getGridData 920
longGetGridData 921
printFile 922
longPrintFile 923
run 924
longRun 925
newEntry 932
deleteEntry 933
modifyEntry 934
prepareNewEntry 935
getPageList 940
getDossierData 941
addPage 942
modifyPage 943
deletePage 944
prepareNewPage 945
getFormData 950
onFieldChange 951
onGridAction 952
onOpenTask 953
getWorkflowData 960
prepareNewWorkflow 961
onWorkflowActionStateChange 962

De même, il est possible d’obtenir une description de la métrique en appelant le préfixe, sans préciser d’identifiant de métrique :

$ snmpget -c public -v 2c localhost:9161 2.16.756.5.1332.300.104.921
joint-iso-ccitt.16.756.5.1332.300.104.921 = STRING: "ADRHI - longGetGridData"

Codes de métrique

Le dernier composant de l’identifiant est le code de métrique.

Métrique
Description 0
Nombre d’appels 1
Temps moyen par appel 2

Exemples

OID Explication
2.16.756.5.1332.300.302.902.2 Authentifier un utilisateur au login
2.16.756.5.1332.300.100.920.2 Récupération de la liste des dossiers dans ADR02
2.16.756.5.1332.300.100.940.2 Ouverture de la liste des pages d’un dossier ADR02
2.16.756.5.1332.300.100.941.2 Récupération des données d’un dossier ADR02
2.16.756.5.1332.300.100.942.2 Création d’une page dans un dossier ADR02
2.16.756.5.1332.300.100.943.2 Mise à jour d’une page dans un dossier ADR02
2.16.756.5.1332.300.104.921.2 Affichage du journal de bord dans l’ADRHI
2.16.756.5.1332.300.201.920.2 Récupération des événements dans un planning GTP40/GTP41/Dashboard