Esta página se aplica a Apigee y Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
En este tema se ofrece una referencia de las métricas, las dimensiones y los filtros de analíticas. Para obtener más contexto sobre el uso de estas APIs, consulte el artículo Información general sobre los análisis de APIs.
En este tema se muestran los nombres de las métricas y las dimensiones tal como aparecen en la interfaz de usuario y como debe usarlos en las llamadas a la API.
- Verá los nombres de la interfaz de usuario cuando cree y gestione informes personalizados.
- Utilice los nombres específicos de la API cuando obtenga métricas, cree una definición de informe o actualice una definición de informe.
Métricas
A continuación, se indican las métricas de la API que puede obtener en informes personalizados y llamadas a la API de Apigee.
Métrica | Nombre que se usará en la API de Apigee | Functions | Descripción |
---|---|---|---|
Promedio de transacciones por segundo | tps |
Ninguno |
Número medio de transacciones, es decir, solicitudes de proxy de API, por segundo. Ten en cuenta que, si tienes un número relativamente bajo de transacciones durante el periodo, el número medio de transacciones por segundo podría ser cero en los informes personalizados de la interfaz de usuario si el número tiene menos de dos decimales. Sintaxis de la API: |
Resultado en caché | cache_hit |
suma |
Número de solicitudes a la API correctas que usan Sintaxis de la API: |
Número de elementos de la caché de nivel 1 | ax_cache_l1_count |
Media, mínimo y máximo |
Número de elementos de la caché de nivel 1 (en memoria) por transacción durante un periodo determinado. Por ejemplo, si elige Sintaxis de la API: |
Errores de políticas | policy_error |
suma |
Número total de errores de políticas durante el periodo especificado. Los errores de políticas suelen producirse por diseño. Por ejemplo, la política Un error de política solo se registra en Analytics si provoca un fallo en el proxy de API.
Por ejemplo, si el atributo La dimensión Nombre de la política en caso de error ( Los errores de destino (como Sintaxis de la API: |
Errores de proxy | is_error |
suma |
Número total de veces que los proxies de API han fallado durante el periodo especificado. El error de proxy
puede producirse cuando falla una política o cuando se produce un error de tiempo de ejecución, como un La dimensión Proxy ( Sintaxis de la API: |
Latencia de procesamiento de solicitudes | request_processing_latency |
Media, mínimo y máximo |
Tiempo (medio, mínimo o máximo) en milisegundos que tarda Apigee en procesar las solicitudes entrantes. El tiempo empieza cuando la solicitud llega a Apigee y termina cuando Apigee reenvía la solicitud al servicio de destino. Si usas diferentes dimensiones, puedes examinar las latencias de procesamiento de solicitudes por proxy de API, aplicación de desarrollador, región, etc. Sintaxis de la API: |
Tamaño de la solicitud | request_size |
suma, media, mínimo y máximo |
Tamaño de la carga útil de la solicitud recibida por Apigee, en bytes. Sintaxis de la API: |
Caché de respuesta ejecutada | ax_cache_executed |
suma |
Número total de veces que se ha ejecutado una política Como la política Sin embargo, la ejecución de la caché de respuestas es 0 si el elemento
En la herramienta de depuración, puedes hacer clic en el icono Sintaxis de la API: |
Latencia de procesamiento de respuestas | response_processing_latency |
Media, mínimo y máximo |
Cantidad de tiempo (media, mínima o máxima), en milisegundos, que tarda Apigee en procesar las respuestas de la API. El tiempo empieza cuando el proxy de API recibe la respuesta del servicio de destino y termina cuando Apigee reenvía la respuesta a la persona que hizo la llamada original. Si usa diferentes dimensiones, puede examinar las latencias de procesamiento de respuestas por proxy de API, región, etc. Sintaxis de la API: |
Tamaño de la respuesta | response_size |
suma, media, mínimo y máximo |
Tamaño de la carga útil de la respuesta devuelta al cliente, en bytes. Sintaxis de la API: |
Errores de destino | target_error |
suma |
Número total de respuestas Sintaxis de la API: |
Tiempo de respuesta objetivo | target_response_time |
suma, media, mínimo y máximo |
Cantidad de tiempo (suma, media, mínimo o máximo), en milisegundos, que tarda el servidor de destino en responder a una llamada. Esta métrica indica el rendimiento de los servidores de destino. El tiempo empieza cuando Apigee reenvía una solicitud al servicio de destino y termina cuando Apigee recibe la respuesta. Ten en cuenta que, si una llamada a la API devuelve una respuesta de la caché (por ejemplo, mediante la política Sintaxis de la API: |
Tiempo total de respuesta | total_response_time |
suma, media, mínimo y máximo |
Cantidad de tiempo (suma, media, mínimo o máximo), en milisegundos, desde que Apigee recibe una solicitud de un cliente hasta que Apigee envía la respuesta al cliente. El tiempo incluye la sobrecarga de la red (por ejemplo, el tiempo que tardan los balanceadores de carga y los routers en hacer su trabajo), la latencia de procesamiento de solicitudes, la latencia de procesamiento de respuestas y el tiempo de respuesta de destino (si la respuesta se sirve desde el servicio de destino en lugar de desde la caché). Si usas diferentes dimensiones, puedes examinar las latencias de procesamiento por proxy de API, aplicación de desarrollador, región, etc. Sintaxis de la API: |
Tráfico | message_count |
suma |
Número total de llamadas a la API procesadas por Apigee en el periodo especificado. Use dimensiones para agrupar los recuentos de tráfico de las formas que le resulten más útiles. Sintaxis de la API: |
Monetización | |||
Tarifas | fees |
suma, media, mínimo y máximo |
Importe que representa la cuota de configuración, las cuotas periódicas o la recarga prepago. Sintaxis de la API: |
Reparto de ingresos del desarrollador | x_apigee_mintng_dev_share |
suma, media, mínimo y máximo |
Parte del desarrollador en los ingresos de una transacción. Apigee calcula la parte del desarrollador solo si has habilitado la opción de compartir ingresos en tu plan de tarifas. La cuota del desarrollador se calcula mediante la siguiente fórmula: x_apigee_mintng_dev_share = revShareGrossPrice * (share percentage)
El valor del porcentaje de participación se obtiene de tu plan de tarifas. Sintaxis de la API: |
Precio de monetización | x_apigee_mintng_price |
suma, media, mínimo y máximo |
Ingresos totales de una transacción.
Los ingresos de una transacción se definen como el valor de la variable de monetización Sintaxis de la API: |
Multiplicador de precios de la API | x_apigee_mintng_price_multiplier |
suma, media, mínimo y máximo |
Factor (multiplicador) por el que se multiplica el coste por transacción. El coste por transacción se especifica en la sección Tarifas basadas en el consumo del plan de tarifas. Sintaxis de la API: |
Tarifas de monetización | x_apigee_mintng_rate |
suma, media, mínimo y máximo |
Tarifa cobrada por una transacción. La tarifa que se cobra por una transacción se calcula mediante la siguiente fórmula: x_apigee_mintng_rate = (consumption-based pricing rate) * perUnitPriceMultiplier value
El valor de la tarifa de precios basada en el consumo se obtiene de tu plan de tarifas y el valor de Sintaxis de la API: |
Dimensiones
Las dimensiones le permiten ver las métricas en agrupaciones significativas. Por ejemplo, los recuentos de tráfico total son mucho más útiles cuando se consultan por cada aplicación de desarrollador o proxy de API.
A continuación, se indican las dimensiones que proporciona Apigee de forma predeterminada.
Dimensión | Nombre que se usará en la API de Apigee | Descripción |
---|---|---|
Token de acceso | access_token |
Token de acceso de OAuth del usuario final de la aplicación. |
Producto de API | api_product |
|
Nombre de la aplicación AppGroup | app_group_app |
Nombre de la aplicación a la que se llama cuando forma parte de un AppGroup. Consulta Usar AppGroups para organizar la propiedad de las aplicaciones para obtener información sobre AppGroups. |
Nombre de AppGroup | app_group_name |
Nombre del AppGroup que contiene las aplicaciones a las que se llama, si procede. Consulta Usar AppGroups para organizar la propiedad de las aplicaciones para obtener información sobre AppGroups. |
Clave de caché | ax_cache_key |
Clave que contiene el valor En la herramienta de depuración, cuando selecciona una política de |
Nombre de la caché | ax_cache_name |
Nombre de la caché que contiene las claves o los valores que usa la política En la herramienta de depuración,
cuando selecciona una política de |
Fuente de caché | ax_cache_source |
Nivel de caché (L1 en memoria o base de datos L2) del que se ha obtenido el En la herramienta Depuración,
cuando selecciona la política Para obtener más información sobre los niveles de caché, consulta Internos de la caché. |
ID de cliente | client_id |
Clave de consumidor (clave de API) de la aplicación del desarrollador que hace las llamadas a la API, ya sea que se haya incluido en la solicitud como clave de API o en tokens de OAuth. Para obtener esta dimensión, los proxies que reciben llamadas deben configurarse para comprobar si hay una clave de API o un token de OAuth válidos. Las aplicaciones de desarrollador obtienen claves de API, que se pueden usar para generar tokens de OAuth cuando las aplicaciones se registran en Apigee. Para obtener más información, consulta ¿Cómo puedo generar datos analíticos completos? Si no se cumplen los criterios anteriores, verás el valor |
Aplicación Developer | developer_app |
Aplicación de desarrollador registrada en Apigee que realiza llamadas a la API. Para obtener esta dimensión, las aplicaciones deben asociarse a uno o varios productos de API que contengan los proxies de API a los que se llama, y los proxies deben comprobar si se ha enviado una clave de API o un token de OAuth con la llamada a la API. La clave o el token identifican la aplicación del desarrollador. Para obtener más información, consulta ¿Cómo puedo generar datos analíticos completos? Si no se cumplen los criterios anteriores, verás el valor |
Correo electrónico del desarrollador | developer_email |
|
ID de desarrollador | developer |
ID de desarrollador único generado por Apigee con el formato
Para obtener esta dimensión, los desarrolladores deben tener aplicaciones asociadas a uno o varios productos de API que contengan los proxies de API a los que se llama. Además, los proxies deben comprobar si se ha enviado una clave de API o un token de OAuth con las llamadas a la API. La clave o el token identifica al desarrollador. Para obtener más información, consulta ¿Cómo puedo generar datos analíticos completos? Si no se cumplen los criterios anteriores, verás el valor |
Entorno | environment |
Entorno de Apigee en el que se despliegan los proxies de API. Por ejemplo, test o prod . |
Código de fallo en caso de error | ax_edge_execution_fault_code |
El código de error del error. Por ejemplo:
|
Nombre del flujo en caso de error | ax_execution_fault |
Flujo con nombre en un proxy de API que ha generado un error. Por ejemplo, Ten en cuenta que el nombre completo que se debe usar en la API de Apigee es
Si no se ha producido ningún error, verás el valor |
Recurso de flujo | flow_resource |
Solo para uso de Apigee. Si quieres saber más, consulta el artículo Cómo usar la dimensión "Flujo de recursos" en Analytics. |
Flow State on Error | ax_execution_fault |
Nombre de los estados del flujo del proxy de API que han generado errores, como Ten en cuenta que el nombre completo que se debe usar en la API de Apigee es |
ID de flujo de pasarela | gateway_flow_id |
A medida que las llamadas a la API se desplazan por Apigee, cada llamada obtiene su propio ID de flujo de la pasarela. Ejemplo: rrt329ea-12575-114653952-1. El ID de flujo de la pasarela es útil para distinguir métricas en situaciones de TPS alto en las que otras dimensiones, como la organización, el entorno y la marca de tiempo, son idénticas en todas las llamadas. |
Organización | organization |
Organización de Apigee en la que se despliegan los proxies de API. |
Nombre de la política en caso de error | ax_execution_fault |
Nombre de la política que ha devuelto un error y ha provocado que la llamada a la API falle. Ten en cuenta que el nombre completo que se debe usar en la API de Apigee es Si una política genera un error, pero el atributo raíz de la política |
Proxy | apiproxy |
Nombre del equipo (no el nombre visible) de un proxy de API. |
Ruta base del proxy | proxy_basepath |
BasePath configurado en el ProxyEndpoint del proxy de API. La ruta base no incluye la parte del dominio y del puerto de la URL del proxy de la API. Por ejemplo, si la URL base de un proxy de API es El valor también se almacena en la variable de flujo |
Tipo de implementación de proxy | proxy_deployment_type |
El
tipo de proxy de API
de los proxies desplegados. Si especificas un tipo de proxy, los resultados se limitarán a ese tipo. Los valores posibles son |
Sufijo de ruta de proxy | proxy_pathsuffix |
Ruta de recurso añadida a la ruta base del proxy de API. Por ejemplo, si la URL base de un proxy de API es Si no se usa El valor también se almacena en la variable de flujo |
Revisión de proxy | apiproxy_revision |
Número de revisión del proxy de API que ha gestionado las llamadas a la API. No tiene por qué ser la última revisión de un proxy de API. Si un proxy de API tiene 10 revisiones, es posible que la octava revisión esté desplegada. Además, una API puede tener varias revisiones implementadas siempre que tengan rutas base diferentes, tal como se describe en Implementar proxies. |
IP de cliente resuelta | ax_resolved_client_ip |
Dirección IP del cliente de origen. Se obtiene mediante la resolución de la dirección IP del cliente predeterminada o el algoritmo configurado en la resolución de la IP del cliente configurada. Con el comportamiento predeterminado, el valor de la dimensión Tenga en cuenta que, cuando se usan productos de enrutamiento como Akamai para capturar las direcciones IP reales de los clientes, la IP del cliente se envía a Apigee en el encabezado HTTP El valor de la dimensión
|
Código de estado de respuesta | response_status_code |
Código de estado de respuesta HTTP reenviado de Apigee al cliente, como 200 , 404 , 503 , etc. En Apigee, el código de estado de la respuesta del destino se puede sobrescribir con políticas como AssignMessage y RaiseFault, por lo que esta dimensión puede ser diferente de Código de respuesta del destino (target_response_code). |
Host virtual | virtual_host |
Nombre del host virtual al que se ha hecho la llamada a la API. Para obtener más información, consulta Acerca de los entornos y los grupos de entornos. |
Inbound/Client | ||
Dirección IP del cliente | client_ip |
Dirección IP del sistema que accede al router, como el cliente original (proxy_client_ip) o un balanceador de carga. Cuando hay varias IPs en el encabezado X-Forwarded-For , esta es la última IP que aparece. |
Categoría del dispositivo | ax_ua_device_category |
Tipo de dispositivo desde el que se ha hecho la llamada a la API, como Tablet o Smartphone . |
Familia del SO | ax_ua_os_family |
Familia del sistema operativo del dispositivo que realiza la llamada, como Android o iOS . |
Versión del SO | ax_ua_os_version |
Versión del sistema operativo del dispositivo que hace la llamada. Es útil usarla como segunda dimensión de desglose junto con Familia de SO (ax_ua_os_family) para ver las versiones de los sistemas operativos. |
IP de cliente proxy | proxy_client_ip |
Dirección IP del cliente que llama, almacenada en la |
IP de cliente referente | ax_true_client_ip |
Cuando se usan productos de enrutamiento, como Akamai, para registrar las direcciones IP reales de los clientes, las IPs de los clientes se transfieren a Apigee en el encabezado HTTP Para determinar la dirección IP del cliente original, a la que se accede a través de la dimensión |
Ruta de la solicitud | request_path |
Ruta de recurso (sin incluir el dominio) al servicio de destino, sin incluir los parámetros de consulta. Por ejemplo, el target de ejemplo de Apigee |
URI de solicitud | request_uri |
Ruta de recursos (sin incluir el dominio) al servicio de destino, incluidos los parámetros de consulta. Por ejemplo, el destino de muestra de Apigee |
Verbo de solicitud | request_verb |
Verbo de solicitud HTTP en las solicitudes de la API, como GET, POST, PUT o DELETE. |
User-agent | useragent |
Nombre del user-agent o del agente de software usado para hacer la llamada a la API. Ejemplos:
|
Familia de user-agents | ax_ua_agent_family |
Familia del user-agent, como Chrome Mobile o curl . |
Tipo de user-agent | ax_ua_agent_type |
El tipo de user-agent, como Browser , Mobile Browser , Library , etc. |
Versión de user-agent | ax_ua_agent_version |
Versión del user-agent. Es útil usarla como segunda dimensión de desglose con Familia de user-agent (ax_ua_agent_family) para obtener la versión de la familia del agente. |
Saliente/Destino | ||
Objetivo | target |
Punto final de destino que ha gestionado la solicitud. Por ejemplo, default . |
Target Base Path | target_basepath |
Ruta de recurso (sin incluir el dominio) al servicio de destino, sin incluir los parámetros de consulta, que se define en el Por ejemplo, supongamos que un proxy de API llama al siguiente destino: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> En este ejemplo, target_basepath es Si el objetivo fuera este: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net</URL> </HTTPTargetConnection> target_basepath sería nulo. En la herramienta de depuración, cuando
selecciona el icono AX al final del diagrama de flujo, la
|
Nombre del servicio gRPC | x_apigee_grpc_service_name |
Solo se aplica cuando el servicio de destino es gRPC. Nombre del servicio gRPC. Para obtener información sobre los proxies gRPC, consulta Crear proxies de API gRPC. |
Estado de gRPC | x_apigee_grpc_status |
Solo se aplica cuando el servicio de destino es gRPC. Estado de la solicitud gRPC. Para obtener información sobre los proxies gRPC, consulta Crear proxies de API gRPC. |
Host de destino | target_host |
Host del servicio de destino. Por ejemplo, si un proxy de API llama a
http://mocktarget.apigee.net/help , el target_host es
mocktarget.apigee.net . |
Dirección IP de destino | target_ip |
Dirección IP del servicio de destino que devuelve la respuesta al proxy de la API. |
Código de respuesta de destino | target_response_code |
Código de estado de respuesta HTTP devuelto por el servicio de destino al proxy de API, como El valor Es diferente de la dimensión Código de estado de respuesta (response_status_code). |
Nombre de RPC de gRPC | x_apigee_grpc_rpc_name |
Solo se aplica cuando el servicio de destino es gRPC. El nombre de la RPC. Para obtener información sobre los proxies gRPC, consulta Crear proxies de API gRPC. |
URL de destino | target_url |
URL completa del servicio de destino definido en el TargetEndpoint de un proxy de API. <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> En este ejemplo, la target_url es
Ten en cuenta que la URL también se puede anular durante el procesamiento del proxy de API con la
En el encadenamiento de proxies, la target_url del proxy de llamada es nula. |
IP X-Forwarded-For | x_forwarded_for_ip |
La lista de direcciones IP del encabezado Para determinar la dirección IP del cliente original, a la que se accede a través de la dimensión |
X-Forwarded-For Proto | x_forwarded_proto |
Protocolo que ha usado el cliente para conectarse al router. Los valores válidos son |
Hora | ||
Día de la semana | ax_day_of_week |
Abreviatura de tres letras del día de la semana en el que se hicieron las llamadas a la API. Por ejemplo, Lun, Mar, Mié. |
Mes | ax_month_of_year |
Mes numérico en el que se hicieron las llamadas a la API. Por ejemplo, 03 para marzo. |
Hora del día | ax_hour_of_day |
Hora de 2 dígitos en la que se hicieron las llamadas a la API, según un reloj de 24 horas. Por ejemplo, si se hacen llamadas a la API entre las 22:00 y las 23:00, el valor de ax_hour_of_day sería 22. El valor de tiempo está en UTC. |
Zona horaria | ax_geo_timezone |
Nombres comunes de las zonas horarias desde las que se hicieron las llamadas a la API, como America/New_York y Europe/Dublin . |
Semana del mes | ax_week_of_month |
Semana numérica del mes. Por ejemplo, en el caso de las llamadas a la API realizadas en la tercera semana de un mes, el valor de ax_week_of_month es 3. |
Ubicación | ||
Ciudad | ax_geo_city |
Ciudad desde la que se hicieron las llamadas a la API. |
Continente | ax_geo_continent |
Código de dos letras del continente desde el que se hicieron las llamadas a la API. Por ejemplo:
NA para Norteamérica. |
País | ax_geo_country |
Código de dos letras del país desde el que se hicieron las llamadas a la API. Por ejemplo, US
para Estados Unidos. |
Región geográfica | ax_geo_region |
Código con guion de la región geográfica, como STATE-COUNTRY . Por ejemplo,
WA-US para Washington (Estados Unidos). |
Región | ax_dn_region |
Nombre del centro de datos de Apigee en el que se implementan los proxies de API, como
us-east-1 . |
Monetización | ||
Creado | created |
Actualmente disponible en organizaciones de Apigee, no en organizaciones de Apigee Hybrid. Marca de tiempo UNIX en la que se añadió la programación de tarifas para el desarrollador de la aplicación y el producto de la API. |
Tipo de tarifa | fees_type |
Tipo de tarifa. Puede ser una tarifa de configuración, una tarifa periódica o una recarga prepago. Este valor solo se rellena si ha seleccionado la métrica Fees . |
Moneda de ingresos | x_apigee_mintng_currency |
|
ID de plan de tarifas | x_apigee_mintng_rate_plan_id |
Actualmente disponible en organizaciones de Apigee, no en organizaciones híbridas de Apigee. El plan de tarifas de monetización del desarrollador de la aplicación. |
Transacción correcta | x_apigee_mintng_tx_success |
El estado de monetización de la transacción se define con el valor de la variable de monetización transactionSuccess registrada en su política DataCapture. |
Filtros
Los filtros le permiten limitar los resultados a métricas con características específicas. A continuación, se muestran algunos filtros de ejemplo. Use nombres de métricas y dimensiones con formato de API al definir filtros.
Devuelve métricas de los proxies de API con el nombre books o music:
filter=(apiproxy in 'books','music')
Devuelve las métricas de los proxies de API cuyos nombres empiezan por m
:
filter=(apiproxy like 'm%')
Devuelve métricas de proxies de API cuyos nombres no empiezan por m
:
filter=(apiproxy not like 'm%')
Devuelve métricas de las llamadas a la API con códigos de estado de respuesta entre 400
y 599
:
filter=(response_status_code ge 400 and response_status_code le 599)
Devuelve métricas de las llamadas a la API con el código de estado de respuesta 200
y el código de respuesta de destino 404
:
filter=(response_status_code eq 200 and target_response_code eq 404)
Devuelve métricas de las llamadas a la API con el código de estado de respuesta 500
:
filter=(response_status_code eq 500)
Devuelve métricas de las llamadas a la API que no han provocado errores:
filter=(is_error eq 0)
Devuelve métricas de las llamadas a la API que no han generado respuestas null
:
filter=(response_status_code isnot null)
A continuación, se indican los operadores que puede usar para crear filtros de informes.
Operador | Descripción |
---|---|
in |
Incluir en la lista |
notin |
Excluir de la lista |
is |
Usa response_status_code is null para filtrar las respuestas cuyo código de estado sea null . |
isnot |
Usa response_status_code isnot null para filtrar las respuestas cuyo código de estado no sea null . |
eq |
Igual a == |
ne |
No es igual a != |
gt |
Mayor que > |
lt |
Menor que < |
ge |
Mayor o igual que >= |
le |
Menor o igual que <= |
like |
Devuelve "true" si el patrón de cadena coincide con el patrón proporcionado. |
not like |
Devuelve false si el patrón de cadena coincide con el patrón proporcionado. |
similar to |
Devuelve true o false en función de si su patrón coincide con la cadena dada. Es similar a like , pero interpreta el patrón usando la definición de expresión regular del estándar SQL. |
not similar to |
Devuelve false o true en función de si su patrón coincide con la cadena dada. Es similar a not like , pero interpreta el patrón usando la definición de expresión regular del estándar SQL. |
and |
Te permite usar la lógica AND para incluir más de una expresión de filtro. El filtro
incluye los datos que cumplen todas las condiciones. |
or |
Te permite usar la lógica OR para evaluar diferentes expresiones de filtro posibles. El filtro
incluye los datos que cumplen al menos una de las condiciones. |