Règle de journal d'activité

Configurez la règle de journal d'activité pour gérer le niveau de détail des données stockées dans les événements d'API.

Lorsque vous configurez une API dans l'interface utilisateur API Manager , vous choisissez les données qui sont stockées dans les enregistrements d'événement d'API pour les appels à cette API avec la propriété activity log . La propriété activity log possède des paramètres distincts pour les appels d'API ayant abouti et pour les appels d'API ayant échoué. Les options du journal d'activité sont les suivantes:
  • none - Les événements de l'API ne sont pas enregistrés.
  • activity - Enregistre l'URI de la ressource API. activity est le paramètre de journal par défaut pour les appels d'API ayant abouti.
  • header - Enregistre l'URI de la ressource API et les en-têtes HTTP.
  • payload - Enregistre l'URI de la ressource API, les en-têtes HTTP et les données utiles de la demande et de la réponse. payload est le paramètre de journal par défaut pour les appels d'API ayant échoué, car le contenu de la réponse peut contenir des informations utiles sur la cause de l'échec.
Remarque :

Si votre passerelle est configurée pour authentifier tous les appels d'API avec un fournisseur OAuth, les données associées à l'appel OAuth sont uniquement incluses dans les données d'événement d'API lorsque l'appel OAuth échoue. L'authentification OAuth réussie n'est pas enregistrée dans les données d'événement d'API.

Important : la taille maximale d'un enregistrement d'événement API est de 19 Mo. Le sous-système d'analyse rejette tout enregistrement d'événement API d'une taille supérieure à 19 Mo.

Définition des paramètres de journal dans l'interface utilisateur d' API Manager

  1. Dans la vue Développement de l'interface utilisateur d' API Manager , sélectionnez l'API que vous souhaitez utiliser. Si vous n'êtes pas familiarisé avec la vue Develop de l'interface utilisateur du gestionnaire d'API, reportez-vous à la section Working with API definitions (Travailler avec des définitions d'API).
  2. Sélectionnez l'onglet Passerelle , développez Paramètres de passerelle et de portail, puis sélectionnez Journal d'activité.
  3. Sélectionnez Enabled, puis sélectionnez le paramètre de journal préféré pour Success Content et Error Content:
    • none - Les événements de l'API ne sont pas enregistrés.
    • activity - Enregistre l'URI de la ressource API. activity est le paramètre de journal par défaut pour les appels d'API ayant abouti.
    • header - Enregistre l'URI de la ressource API et les en-têtes HTTP.
    • payload - Enregistre l'URI de la ressource API, les en-têtes HTTP et les données utiles de la demande et de la réponse. payload est le paramètre de journal par défaut pour les appels d'API ayant échoué, car le contenu de la réponse peut contenir des informations utiles sur la cause de l'échec.
  4. Cliquez sur Enregistrer pour enregistrer vos changements.

Définition des paramètres de journal dans la source pour DataPower® API Gateway

Utilisez l'extension activity-log pour configurer vos préférences de journalisation.

activity-log:
  success-content: <success log setting: none, activity, header, payload>
  error-content: <failure log setting: none, activity, header, payload>
  enabled: <if activity logging is enabled: true or false>
Remarque: Si la journalisation de la charge utile est activée, la mise en mémoire tampon de la passerelle pour capturer la charge utile doit également être activée.
activity-log:
  success-content: <success log setting: none, activity, header, payload>
  error-content: <failure log setting: none, activity, header, payload>
  enabled: <if activity logging is enabled: true or false>
buffering: true
Exemple
Aucune consignation des appels ayant abouti, consignation d'en-tête pour les appels ayant échoué
activity-log:
    success-content: none
    error-content: header
    enabled: true
Désactiver la consignation des activités
activity-log:
    enabled: false