Traces des services web

Owned by Bertrand Littel
Last updated: 02/07/2024 by Christine Ihler
4 min read

Les services web peuvent bénéficier d’un trace côté métier. Cela signifie que la trace contient principalement des informations sur les données de la demande métier et de la réponse apportée. Il n’y a pas d’informations techniques, par exemple des informations sur l’authentification, les temps de réponse ou le cheminement du message

 

Trace des services web métier SYNCHRO_INFINITY_AGILEO (SOAP)

Les services web métiers, historiquement SOAP, par SYNCHRO_INFINITY_AGILEO (a5ppswagil.dhop) bénéficient d’un mécanisme de traçage depuis la version 10.5.

Activation

La trace s’active ou se désactive par un paramètre ERP (menu Administration / Paramètres)

Il est nommé "A5_SERVICEWEB". Si on veut que la trace soit activée on met ce paramètre à OUI

 

Résultat

Une fois activé, le prochain appel à un service web via A5PPSWAGIL (SYNCHRO_INFINITY_AGILEO, SOAP) donne la création d’un fichier de trace dans le répertoire usuel des fichiers de logs Divalto, par exemple 'C:\Divalto\DivaltoLog'.

  • Le fichier généré aura un nom sous la forme : “trace” + le nom de l'action qu'on a exécuté + “.log”.

  • Le contenu du fichier indique l'heure de la demande et son contenu ainsi que l'heure de la réponse et son contenu.

 

Exemple

Soit un appel au service web INTERROGER_STOCK en mode SOAP via a5ppswagil, avec la trace activée au préalable.

On constate la génération d’un fichier log nommé : trace_sw_interroger_stock.log

La trace indique la date/heure ainsi que les éléments de la demande et de la réponse

Trace des services web métier WEB_SERVICE_INFINITY (REST)

Les services web métiers REST par WEB_SERVICE_INFINITY (a5ppswinfinity.dhop) bénéficient d’un mécanisme de traçage depuis la version 10.5.

Activation

La trace s’active ou se désactive par un paramètre ERP (menu Administration / Paramètres)

Il est nommé "INHIBER_TRACE_WS". Si on veut que la trace soit activée on met ce paramètre à NON

L’attribut ‘withlog’ à ‘1' doit également être présent au niveau des paramètres de l’action.

image-20240702-100901.png

 

Attention, cette trace dépend également du code chemin DLOGPATH, qui doit exister et pointer un dossier existant dédié à ces trace

La valeur recommandé pour le chemin DLOGPATH est : c:\divalto\DivaltoLog\JSon

Résultat

Une fois activé, le prochain appel à un service web via A5PPSWINFINITY (WEB_SERVICE_INFINITY, REST) donne la création de deux fichiers de trace

  • Un fichier nommé sous la forme : “JSON_” + Dossier + ‘_' + Utilisateur + ‘_’ + Date et heure + “_WHK_” + le nom de l'action qu'on a exécuté + “_S.txt” pour les message SEND (=ce qu’à envoyé l’appelant)

  • Un fichier nommé sous la forme : “JSON_” + Dossier + ‘_' + Utilisateur + ‘_’ + Date et heure + “_WHK_” + le nom de l'action qu'on a exécuté + “_R.txt” pour les message RECEIVE (=ce qu’à reçu l’appelant en retour)

  • Le contenu du fichier donne la demande au format arborescent JSON.

  • Les fichiers sont crées dans le dossier paramétré précédemment

 

Exemple

Soit un appel au service web INTERROGER_RESUME_AFFAIRE en mode REST via a5ppswinfinity, avec la trace activée au préalable.

On constate la génération de deux fichier log nommé : JSON__$WEBSERVICE_20221213144622_WHK_Interrogerresumeaffaire_S.txt et JSON__$WEBSERVICE_20221213144623_WHK_Interrogerresumeaffaire_R.txt

Les noms de fichier indiquent la date/heure, et le contenu les éléments de la demande et de la réponse.

 

Trace des services web RecordSql

Le service web RecordSql propose un mécanisme différent, car il n'entre pas les couches métier. Cette trace est disponible depuis Harmony 408.

La trace, principalement a but de mesure de performance, se fait directement dans la demande dans une balise Json optionnelle.

Les informations sont retournées à l’appelant dans la réponse à l’appel SW.

Consultez le chapitre dédié avec le lien suivant 3 Demande d'action - cas SW RecordSql | Informations complémentaires : performances

 

Trace de appels webhooks Weavy

Le appels de webhook Weavy bénéficient d’un mécanisme de traçage depuis la version 10.5.

Activation

La trace s’active ou se désactive par un paramètre ERP (menu Administration / Paramètres)

Il est nommé "INHIBER_TRACE_JSON". Si on veut que la trace soit activée on met ce paramètre à NON

Attention, cette trace dépend également du code chemin DLOGPATH, qui doit exister et pointer un dossier existant dédié à ces trace

La valeur recommandé pour le chemin DLOGPATH est : c:\divalto\DivaltoLog\JSon

Résultat

Une fois activé, le prochain appel à un webhook donne la création d’un fichier trace dans le dossier paramétré précédemment.