Estás consultando la documentación de Apigee Edge.
Consulta la
documentación de Apigee X. 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 la API, puedes crear un informe personalizado con el filtro y las métricas preestablecidos en función de las condiciones configuradas en el momento de la creación. Además, se configura un conjunto de dimensiones y métricas predeterminadas en el informe.
Crea un informe personalizado basado en tu contexto
Crea informes personalizados con rapidez en función de 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 la API 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
El informe personalizado incluirá de forma predeterminada las dimensiones y métricas que aparecen 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, hay un conjunto predefinido de dimensiones y métricas predeterminadas de Monitoring de la API en los informes personalizados. Después de crearlo, puedes editarlo para agregar o borrar métricas y dimensiones, según sea necesario. Por ejemplo, es posible que desees limitar tu investigación a un token de acceso, una app de desarrollador, un proxy de API o un ID de solicitud en particular.
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 utiliza 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é incluida en un token de OAuth:
El informe personalizado contiene información para todos los valores de Client ID.
En el siguiente ejemplo, se agrega un filtro para 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 el artículo Referencia de las métricas, las dimensiones y los 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 Cómo administrar informes personalizados.
Ejemplo: Usa informes personalizados para diagnosticar problemas de implementación
Adjunta la política de Statistics Collector a los proxies de API para recopilar datos de estadísticas personalizados, como el ID del producto o el 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 definas.
Por ejemplo, las solicitudes al proxy de tu API incluyen encabezados para el ID del producto, el ID de 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, puedes usar la información de los encabezados para diagnosticar problemas de tiempo de ejecución con tu proxy de API.
Si deseas crear un informe personalizado para estos encabezados:
Agrega la política de Statistics Collector a tu API para captar 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 espera tiempo para que se pueda acceder a él.
Haz clic en Analyze > API Monitoring > Recent en la IU de Edge para ver los problemas con la API. Observa que recibes errores 4xx y 5xx del proxy myapi:
Selecciona 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 Investigar:
Filtra el panel de investigación por el proxy myapi y, luego, visualiza el Código de estado en el gráfico de la parte superior. Ten en cuenta que recibes 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.
Selecciona + Informe personalizado para crear un informe personalizado llamado myapi_errors.
Selecciona Errores de proxy para la métrica y configura la Función de agregación como Suma. Puedes agregar más métricas si lo deseas.
Selecciona la dimensión predefinida Código de estado de la respuesta (Response Status Code) y, luego, agrega las tres estadísticas personalizadas prodid, targetersion y userid a Dimensiones:
Configura el filtro para que incluya 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 genera los errores. Por ejemplo, selecciona 403:
Haz clic en un ID de producto en Resumen para ver los errores por versión objetivo (alfa o beta):
Haz clic en una versión de destino en Resumen para ver los errores por usuario:
