activity-log

Utilisez la stratégie Journal d'activité pour configurer vos préférences de journalisation pour l'activité d'API qui est stockée dans l'analyse 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 des passerelles prenant en charge cette stratégie, ainsi que la version de stratégie correspondante
Passerelle	Version de la stratégie
DataPower® Gateway (v5 compatible)	1.0.0

Cette rubrique explique comment configurer la stratégie dans votre source OpenAPI . Pour plus de détails sur la configuration de la stratégie dans l'interface utilisateur de l'assemblage, voir Journal d'activité.

Remarque: Si vous utilisez DataPower API Gateway, vous configurez vos préférences de journalisation à l'aide de l'extension activity-log .

A propos de

Le format de la règle activity-log est le suivant:

- activity-log:
  version: version
  title: title
  description: description
  content: activity_to_log_if_call_successful
  error-content: activity_to_log_if_call_unsuccessful

Appliquez cette règle en ajoutant une extension assembly avec une zone execute à votre fichier de définition OpenAPI .

Vous pouvez également appliquer une stratégie activity-log à l'aide de l'éditeur d'assemblage API Designer pour ajouter une stratégie intégrée à l'API. Pour plus d'informations, voir Journal d'activité dans la section des stratégies intégrées.

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: activity_to_log_if_call_successful
  error-content: activity_to_log_if_call_unsuccessful
  enabled: is_activity_logging_enabled
buffering: true

Propriétés

Le tableau suivant décrit les propriétés de la stratégie :

Tableau 2. Propriétés de la stratégie Journal d'activité
Propriété	Obligatoire	Descriptif	Type de données
version	Oui	Numéro de version de la stratégie	chaîne
title	Oui	Titre de la stratégie.	chaîne
description	Non	Description de la stratégie.	chaîne
content	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 portail CMS. `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
error-content	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 portail CMS. `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

Exemple 1

# use defaults

- activity-log:
  version: 1.0.0
  title: default activity logging

Exemple 2

- activity-log:
  version: 1.0.0
  title: no logging for successful calls
  content: none
  error-content: activity