Configuración del registro de actividad

Editar en línea

Puede configurar las preferencias del registro de la actividad de API que se almacena en el Análisis alterando temporalmente el comportamiento de registro de actividad predeterminado.

Acerca de esta tarea

Nota:
  • Esta tarea está relacionada con la configuración de una definición de API OpenAPI 3.0. Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 2.0 , consulte Edición de una definición de API de OpenAPI 2.0.
  • Las API de OpenAPI 3.0 solo están soportadas con DataPower® API Gateway, no con DataPower Gateway (v5 compatible).
  • Para obtener detalles sobre las limitaciones actuales del soporte de OpenAPI 3.0 , consulte el soporte de OpenAPI 3.0 en IBM® API Connect.

Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o utilizando la interfaz de usuario de API Manager basada en navegador.

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 para una ejecución correcta de la API es activityy payload para una llamada de API da como resultado 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. Durante la ejecución de la API, los datos de actividad se almacenan en la variable de contexto log , que llena el registro de sucesos de la API al finalizar la ejecución de la API; para obtener más información, consulte Variables de contexto de registro de actividad de la API.

Nota:

El registro de actividad que llama a datos de Análisis cuando la actividad se ha realizado satisfactoriamente no se aplica al proveedor de OAuth. El proveedor de OAuth registra datos de Análisis para casos de error, pero no registra los casos satisfactorios.

En cualquier momento, puedes pasar directamente al código fuente YAML de « OpenAPI » haciendo clic Icono OpenAPI Source en el icono «Fuente ». Para volver al formulario de diseño, haz clic en el icono del formulario Icono de formulario.

Procedimiento

  1. Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 3.0.
  2. Seleccione la pestaña Pasarela , expanda Pasarela y valores del portaly, a continuación, pulse Registro de actividad.
  3. Seleccione Habilitadoy, a continuación, seleccione las opciones para los campos Contenido satisfactorio y Contenido de error del modo siguiente:

    Tabla 1. Información de referencia
    Etiqueta de campo Descripción
    Contenido de éxito Define el tipo de contenido a registrar cuando la operación es satisfactoria.
    • ninguno : los eventos de la API no se registran.
    • Acción : Registra el URI del recurso de la API.
    • Encabezado : Registra el URI del recurso de la API y los encabezados « HTTP ».
    • carga útil : registra el URI del recurso de la API, los encabezados HTTP y la carga útil; se registra toda la información, incluida la carga útil que se recibe en una solicitud o se devuelve en una respuesta.

    El valor predeterminado es activity.
    Contenido de error Indica qué contenido se debe registrar cuando se produce un error.
    • ninguno : los eventos de la API no se registran.
    • Acción : Registra el URI del recurso de la API.
    • Encabezado : Registra el URI del recurso de la API y los encabezados « HTTP ».
    • carga útil : registra el URI del recurso de la API, los encabezados HTTP y la carga útil; se registra toda la información, incluida la carga útil que se recibe en una solicitud o se devuelve en una respuesta.

    El valor predeterminado es payload.
  4. Pulse Guardar para guardar los cambios.