Registro de actividad

Utilice la política Registro de actividad para configurar las preferencias de registro para la actividad de API que se almacena en el análisis de IBM® API Connect . Las preferencias que especifique van a alterar temporalmente los valores predeterminados en cuanto a la recopilación y almacenado de detalles de la actividad de la API.

Soporte de pasarela

Tabla 1. Tabla que muestra qué pasarelas soportan esta política y la versión de política correspondiente
Pasarela Versión de política
DataPower® Gateway (v5 compatible) 1.0.0

En este tema se describe cómo configurar la política en la interfaz de usuario de ensamblaje. Para obtener detalles sobre cómo configurar la política en el origen de OpenAPI , consulte activity-log.

Tenga en cuenta que si utiliza DataPower API Gateway, puede configurar las preferencias de registro utilizando el editor de diseño de API. Para obtener más información, consulte Configuración del registro de actividad (OpenAPI 2.0) o Configuración del registro de actividad (OpenAPI 3.0).

Acerca de

Existe un registro de suceso de API para cada suceso de ejecución API en el servidor de pasarela. De forma predeterminada, el tipo de contenido que se recopila y se almacena en registros de suceso de API es activity cuando la ejecución de la API se realiza satisfactoriamente y payload cuando la ejecución de la API se realiza con un código de error. Aplique la política Registro de actividad al ensamblaje para cambiar el tipo de contenido para registrar en estos registros de sucesos de API. Para obtener más información sobre los registros de sucesos de API, consulte Referencia de campo de registro de sucesos de API.
Nota: Si el registro de carga útil está habilitado, para que la pasarela capture el almacenamiento intermedio de cargas útiles también debe estar habilitado. Habilite el almacenamiento intermedio como se indica a continuación en el archivo YAML de la API:
x-ibm-configuration:
  ...
  activity-log:
    enabled: true
    error-content: payload
    success-content: payload
  ...
  buffering: true
Nota:

Las políticas de registro de actividad que llaman a datos de Análisis cuando la actividad se ha realizado satisfactoriamente no se aplican al proveedor de OAuth. El proveedor de OAuth registra datos de Análisis para casos de error, pero no registra los casos satisfactorios.

Propiedades

En la tabla siguiente se listan las propiedades de política, se indica si se requiere una propiedad, y se especifica los valores válidos y predeterminados para la entrada, así como el tipo de datos de los valores.

Tabla 2. Propiedades de la política Registro de actividad
Etiqueta de propiedad Obligatorio Descripción Tipo de datos
Título Sí Se necesita un título para la política, pero se proporciona un valor predeterminado, activity-log . serie
Descripción Nee Una descripción de la política. serie
Contenido Sí Define el tipo de contenido a registrar cuando la operación es satisfactoria.
Valores válidos:
  • none: Indica que no se produce ningún registro.
    Restricción: esta opción desactiva las notificaciones para los desarrolladores de aplicaciones que utilizan su Portal para desarrolladores.
  • activity: sólo registra la invocación (sólo se registra el URI de recurso).
  • header: registra la actividad y la cabecera.
  • payload: registra la actividad, cabecera y carga útil (la solicitud original, si existe, y la respuesta final).

El valor predeterminado es activity.

 serie
Contenido de error Nee Indica qué contenido se debe registrar si se produce un error.
Valores válidos:
  • none: Indica que no se produce ningún registro.
    Restricción: esta opción desactiva las notificaciones para los desarrolladores de aplicaciones que utilizan su Portal para desarrolladores.
  • activity: sólo registra la invocación (sólo se registra el URI de recurso).
  • header: registra la actividad y la cabecera.
  • payload: registra la actividad, cabecera y carga útil (la solicitud original, si existe, y la respuesta final).

El valor predeterminado es payload.

 serie