Journal d'activité

Modifier en ligne

Utilisez la stratégie « Journal d'activité » pour configurer vos préférences de journalisation concernant l'activité de l'API enregistrée dans les statistiques d' IBM® API Connect. Les préférences que vous définissez remplacent les paramètres par défaut de collecte et de stockage des détails de l'activité de l'API.

Prise en charge des passerelles

Tableau 1. Tableau indiquant les passerelles prenant en charge cette politique, ainsi que la version correspondante de la politique
Passerelle	Version de la stratégie
DataPower® Gateway (v5 compatible)	1.0.0

Cette rubrique explique comment configurer la stratégie dans l'interface utilisateur d'Assembly; pour plus d'informations sur la configuration de la stratégie dans votre source d' OpenAPI, consultez la rubrique « activity-log ».

Notez que si vous utilisez DataPower API Gateway, vous pouvez configurer vos préférences de journalisation à l'aide de l'éditeur de conception d'API. Pour plus d'informations, consultez la section « Configuration de la journalisation des activités » ( OpenAPI2.0 ) ou « Configuration de la journalisation des activités » ( OpenAPI3.0 ).

A propos de

Il existe un enregistrement d'événement d'API pour chaque événement d'exécution d'API sur le serveur de passerelle. Par défaut, le type de contenu collecté et stocké dans les enregistrements d'événement d'API est activity si l'API est exécutée correctement et payload si elle se termine par un code d'erreur. Appliquez la stratégie Journal d'activité à votre assemblage pour modifier le type de contenu à consigner dans ces enregistrements d'événement d'API. Pour plus d'informations sur les enregistrements d'événements API, consultez la référence des champs des enregistrements d'événements API.

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. Activez la mise en mémoire tampon comme suit dans le fichier YAML de l'API:

x-ibm-configuration:
  ...
  activity-log:
    enabled: true
    error-content: payload
    success-content: payload
  ...
  buffering: true

Remarque :

Les stratégies du journal d'activité qui nécessitent la consignation des données d'analyse lors d'une opération réussie ne s'appliquent pas au fournisseur OAuth. Le fournisseur OAuth consigne les données d'analyse pour les cas d'échec, mais ne consigne pas les cas de réussite.

Propriétés

Le tableau suivant répertorie les propriétés des stratégies, indique si une propriété est nécessaire, définit les valeurs d'entrée et par défaut valides et précise le type de données des valeurs.

Tableau 2. Propriétés de la stratégie du journal des activités
Libellé de la propriété	Obligatoire	Descriptif	Type de données
Titre	Oui	Un titre est requis pour la règle, mais une valeur par défaut, `activity-log` , est fournie.	chaîne
Description	Non	Description de la stratégie.	chaîne
Contenu	Oui	Définit le type de contenu à consigner lorsque l'opération a abouti. Valeurs valides : `none` : Indique qu'il n'y a aucune consignation. Restriction : cette option désactive les notifications pour les développeurs d'applications qui utilisent votre catalogue grand public. `activity` : Consignation des appels uniquement (seuls l'URI de la ressource est enregistré). `header` : Consignation de l'activité et de l'en-tête. `payload` : Consignation de l'activité, de l'en-tête et du contenu (demande d'origine, le cas échéant, et réponse finale). La valeur par défaut est `activity`.	chaîne
Contenu de l'erreur	Non	Indique le contenu à consigner en cas d'erreur. Valeurs valides : `none` : Indique qu'il n'y a aucune consignation. Restriction : cette option désactive les notifications pour les développeurs d'applications qui utilisent votre catalogue grand public. `activity` : Consignation des appels uniquement (seuls l'URI de la ressource est enregistré). `header` : Consignation de l'activité et de l'en-tête. `payload` : Consignation de l'activité, de l'en-tête et du contenu (demande d'origine, le cas échéant, et réponse finale). La valeur par défaut est `payload`.	chaîne