Tutorial: Depuración de las API con el seguimiento de solicitudes

  • Artículo

SE APLICA A: Consumo | Desarrollador | Básico | Estándar | Premium

En este tutorial se describe cómo inspeccionar, o realizar el seguimiento, del procesamiento de solicitudes en Azure API Management. El seguimiento le ayuda a depurar y solucionar problemas de la API.

En este tutorial, aprenderá a:

  • Realizar el seguimiento de una llamada de ejemplo
  • Revisar los pasos del procesamiento de solicitudes

Captura de pantalla que muestra el inspector de API.

Nota:

Actualmente, el seguimiento de solicitudes de API no se admite en los niveles Básico v2 ni Estándar v2.

Requisitos previos

Comprobación del valor Permitir seguimiento

Para realizar un seguimiento del procesamiento de solicitudes, debe habilitar la opción Permitir seguimiento en la suscripción usada para depurar la API. Para comprobarlo en el portal,

  1. vaya a la instancia de API Management y seleccione Suscripciones para revisar la configuración.

    Captura de pantalla que muestra cómo permitir el seguimiento de la suscripción.

  2. Si el seguimiento no está habilitado en la suscripción que está usando, seleccione la suscripción y habilite Permitir seguimiento.

Advertencia

  • Solo permita el seguimiento en suscripciones destinadas a fines de depuración. Compartir claves de suscripciones con seguimiento permitido con usuarios no autorizados podría dar lugar a divulgación de información confidencial contenida en los registros de seguimiento, como claves, tokens de acceso, contraseñas, nombres de host internos y direcciones IP.
  • En la consola de prueba, API Management deshabilita automáticamente el seguimiento una hora después de habilitarlo en una suscripción.

Realizar el seguimiento de una llamada

  1. Inicie sesión en Azure Portal y vaya a la instancia de API Management.

  2. Seleccione API.

  3. Seleccione Demo Conference API en la lista de API.

  4. Seleccione la pestaña Prueba.

  5. Seleccione la operación GetSpeakers.

  6. Tiene la opción de comprobar el valor del encabezado Ocp-Apim-Subscription-Key que se usa en la solicitud seleccionando el icono de ojo.

    Sugerencia

    Puede reemplazar el valor de Ocp-Apim-Subscription-Key mediante la recuperación de una clave de otra suscripción del portal. Seleccione Suscripciones y abra el menú contextual (...) de otra suscripción. Seleccione Mostrar u ocultar claves y copie una de las claves. También puede regenerar claves si es necesario. A continuación, en la consola de prueba, seleccione + Agregar encabezado para agregar un encabezado Ocp-Apim-Subscription-Key con el nuevo valor de clave.

  7. Seleccione Seguimiento.

    • Si la suscripción aún no permite el seguimiento, se le pedirá que lo habilite si desea realizar un seguimiento de la llamada.

    • También puede optar por enviar la solicitud sin seguimiento.

      Captura de pantalla que muestra la configuración del seguimiento de API.

Revisión de la información de seguimiento

  1. Una vez finalizada la llamada, vaya a la pestaña Seguimiento en Respuesta HTTP.

  2. Seleccione cualquiera de los siguientes vínculos para saltar ainformación de seguimiento detallada: Entrada, Back-end, Salida, En caso de error.

    Revisión del seguimiento de respuestas

    • Entrada: muestra la solicitud original API Management recibida del autor de llamada y las directivas aplicadas a la solicitud. Por ejemplo, si agregó directivas en Tutorial: Transformación y protección de la API, aparecerán aquí.

    • Back-end: muestra las solicitudes que API Management envió al back-end de la API y la respuesta que recibió.

    • Salida: muestra todas las directivas que se aplican a la respuesta antes de enviarla de vuelta al autor de llamada.

    • En caso de error : muestra los errores que se produjeron durante el procesamiento de la solicitud y las directivas aplicadas a los errores.

    Sugerencia

    Cada paso muestra también el tiempo transcurrido desde que API Management recibe la solicitud.

  3. En la pestaña Mensaje, el encabezado ocp-apim-trace-location muestra la ubicación de los datos de seguimiento almacenados en Azure Blob Storage. Si es necesario, vaya a esta ubicación para recuperar el seguimiento. Se puede acceder a los datos de seguimiento durante un máximo de 24 horas.

    Ubicación de seguimiento en Azure Storage

Habilitación del seguimiento mediante el encabezado Ocp-Apim-Trace

Al realizar solicitudes a API Management mediante curl, un cliente REST como Postman o una aplicación cliente, habilite el seguimiento agregando los siguientes encabezados de solicitud:

  • Ocp-Apim-Trace: establezca el valor en true
  • Ocp-Apim-Subscription-Key: establezca el valor en la clave de una suscripción habilitada para seguimiento que permita el acceso a la API.

La respuesta incluye el encabezado Ocp-Apim-Trace-Location, con una dirección URL a la ubicación de los datos de seguimiento en Azure Blob Storage.

Para más información sobre cómo personalizar la información de seguimiento, consulte la directiva de seguimiento.

Pasos siguientes

En este tutorial, ha aprendido a:

  • Realizar el seguimiento de una llamada de ejemplo
  • Revisar los pasos del procesamiento de solicitudes

Avance hasta el siguiente tutorial:

Uso de revisiones