Estás viendo la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Más información
Los informes personalizados te permiten desglosar métricas específicas de la API y ver los datos exactos que deseas consultar. Desde los paneles de supervisión de las APIs, puedes crear un informe personalizado con el ajuste predeterminado de filtro y métricas según las condiciones configuradas en el momento de la creación. Además, se configura automáticamente un conjunto de dimensiones y métricas predeterminadas en el informe.
Crea un informe personalizado según tu contexto
Crea rápidamente informes personalizados basados en tu contexto, como se resume en la siguiente tabla. En la página Informes personalizados, los informes personalizados que se crean con la supervisión de APIs tienen un nombre único (de forma predeterminada) como se indica en la tabla; puedes cambiar el nombre cuando editas el informe personalizado.
| Contexto del informe personalizado | Convención de nombres predeterminada para los informes personalizados |
|---|---|
| Panel reciente | API Monitoring Recent Generated |
| Panel de cronograma | API Monitoring Timeline Generated |
| Investigar panel | API Monitoring Investigate Generated |
| Condición de alerta | API Monitoring Generated: alert-name |
Dimensión y métricas predeterminadas
De forma predeterminada, el informe personalizado incluirá las dimensiones y métricas que se indican en la siguiente tabla para todos los informes generados por la supervisión de las APIs.
| Componente | Valores predeterminados |
|---|---|
| Dimensiones | URI de solicitud |
| Métricas |
|
Cómo editar el informe personalizado
Como se mencionó en la sección anterior, en los informes personalizados se preconfigura un conjunto predefinido de dimensiones y métricas predeterminadas de API Monitoring. Después de crearlo, podrás editarlo para agregar o borrar métricas y dimensiones, según sea necesario. Por ejemplo, es posible que desee limitar su investigación a un token de acceso, una aplicación de desarrollador, un proxy de API o un ID de solicitud específicos.
En el siguiente informe personalizado, agregas la dimensión predefinida Gateway Flow ID, en la que Gateway Flow ID contiene el UUID único de cada solicitud a la API realizada a Edge.
Ten en cuenta que el informe ya usa la dimensión Request URI:
En el siguiente ejemplo, se agrega la dimensión Client ID al informe personalizado.
La dimensión Client ID contiene la clave de consumidor (clave de API) del desarrollador que realiza la llamada a la API, ya sea que se haya pasado en la solicitud como una clave de API o esté incluido en un token de OAuth:
El informe personalizado contiene información de todos los valores de Client ID.
En el siguiente ejemplo, se agrega un filtro a fin de que puedas crear un informe personalizado para una Client ID específica:
Para obtener más información sobre todas las dimensiones y métricas predefinidas que puedes agregar a un informe, consulta la referencia de métricas, dimensiones y filtros de Analytics.
En el siguiente ejemplo, agregarás un filtro a un informe personalizado que capture las métricas y dimensiones predeterminadas para el código de falla policies.ratelimit.QuotaViolation y los códigos de estado 5xx:
Para obtener información detallada sobre cómo editar un informe personalizado, consulta el artículo Administra informes personalizados.
Ejemplo: Usa informes personalizados para diagnosticar problemas de implementación
Adjunta la política de StatisticsCollector a tus proxies de API para recopilar datos de estadísticas personalizados, como el ID del producto o del usuario, el precio, la acción de REST, la versión de destino, la URL de destino y la longitud del mensaje. Los datos pueden provenir de variables de flujo predefinidas por Apigee, encabezados de solicitudes, parámetros de consulta o variables personalizadas que usted defina.
Por ejemplo, las solicitudes al proxy de API incluyen encabezados para el ID del producto, el ID del usuario y la versión del servidor de destino. Esta solicitud puede tener el siguiente formato:
curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi
Luego, podrá usar la información de los encabezados para diagnosticar problemas en el tiempo de ejecución con su proxy de API.
Si deseas crear un informe personalizado para estos encabezados, sigue estos pasos:
Agrega la política StatisticsCollector a tu API para capturar el valor de los encabezados personalizados:
<StatisticsCollector name="publishPurchaseDetails"> <Statistics> <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic> <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic> <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic> </Statistics> </StatisticsCollector>
Implementa tu proxy y permite el acceso a él.
Haz clic en Analyze > API Monitoring > Recent en la IU de Edge para ver cualquier problema con tu API. Observe que se muestran errores 4xx y 5xx para el proxy myapi:
Seleccione la fila del proxy myapi para ver más detalles en el panel derecho del panel Recientes.
En el panel derecho del panel Recientes, selecciona
> Ver en Investigate para acceder al panel de Investigación:
Filtre el panel Investigate por el proxy myapi y, luego, visualice el Código de estado en el gráfico de la parte superior. Ten en cuenta que se muestran los errores 403 y 501:
En la IU de Edge, selecciona Analytics > Informes personalizados > Informes para crear un informe personalizado que incluya los valores de estas métricas personalizadas como una dimensión.
Seleccione + Informe personalizado para crear un informe personalizado con el nombre myapi_errors.
Seleccione Proxy Errors para la métrica y configure la Aggregate Function en Sum. Puedes agregar más métricas si lo deseas.
Seleccione la dimensión predefinida Código de estado de la respuesta y, luego, agregue las tres estadísticas personalizadas prodid, targetersion y userid a Dimensiones:
Configura el filtro para incluir solo los datos del proxy de API myapi
(apiproxy eq 'myapi'):
Guarda el informe.
Ejecuta el informe de las últimas 24 horas. Cuando el informe se abra por primera vez, verás un gráfico de errores HTTP 403 y 501:
En Resumen, haz clic en 403 o 510 para ver qué producto está generando los errores. Por ejemplo, seleccionas 403:
Haz clic en un ID del producto en Resumen para ver los errores por versión de destino (alfa o beta):
Haz clic en una versión de destino en Resumen para ver los errores por usuario:
