Solo pasarela de API de DataPower

activity-log

Si utilizas la API DataPower® API Gateway, puedes usar la activity-log extensión para configurar tus preferencias de registro de la actividad de la API que se almacena en Analytics. 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.

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. Cuando compone la definición de la API, puede cambiar el tipo de contenido a registrar en estos registros de suceso de API. Para obtener más información sobre los registros de eventos de la API, consulta la referencia de campos de los registros de eventos de la API.

Tenga en cuenta que si utiliza DataPower Gateway (v5 compatible), puede configurar las preferencias de registro utilizando una política activity-log en el ensamblaje de API. Para obtener más información, consulta el registro de actividades.

La extensión activity-log tiene el formato siguiente:
activity-log:
  success-content: activity_to_log_if_call_successful
  error-content: activity_to_log_if_call_unsuccessful
  enabled: is_activity_logging_enabled
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.
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

La tabla siguiente muestra las propiedades de la extensión activity-log:

Tabla 1. Las características de la extensión del registro de actividad
Propiedad Obligatorio Descripción Tipo
success-content Nee 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 Catálogo de consumidores.
  • 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
error-content Nee Indica qué contenido se debe registrar cuando 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 Catálogo de consumidores.
  • 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
enabled Nee Indica si el registro de actividad está habilitado o inhabilitado. Booleano

Ejemplo 1

Alterar temporalmente los valores de registro de actividad predeterminados:
activity-log:
    success-content: none
    error-content: header
    enabled: true

Ejemplo 2

Desactivar el registro de actividad:
activity-log:
    enabled: false