Esta página se aplica a Apigee y Apigee Hybrid.
Consulta la documentación de Apigee Edge.
Este tema es una referencia para las métricas, las dimensiones y los filtros de estadísticas. Para obtener más contexto sobre su uso, consulta la descripción general de las estadísticas de API.
En este tema, se muestran los nombres de las métricas y las dimensiones a medida que aparecen en la IU y que debes usarlas en las llamadas a la API.
- Verá los nombres de IU cuando crees y administres informes personalizados.
- Usa nombres específicos de la API cuando obtengas métricas, crees un informe o actualices la definición de un informe.
Métricas
A continuación, se muestran las métricas de la API que puedes recuperar en los informes personalizados y las llamadas a la API de Apigee.
Métrica | Nombre para usar en la API de Apigee | Funciones | Descripción |
---|---|---|---|
Transacciones promedio por segundo | tps |
Ninguno |
Cantidad promedio de transacciones, es decir las solicitudes de proxy de API, que se realizan por segundo. Ten en cuenta que si tienes una cantidad relativamente baja de transacciones durante el período, la cantidad promedio de transacciones por segundo podría parecer de cero en los informes personalizados de la IU si la cantidad es inferior a dos decimales. Sintaxis de la API: |
Acierto de caché | cache_hit |
suma |
Cantidad de solicitudes a la API correctas que usan Sintaxis de la API: |
Recuento de elementos de la caché L1 | ax_cache_l1_count |
promedio, mínimo, máximo |
Cantidad de elementos en caché L1 (en memoria) por transacción durante un período determinado. Por ejemplo, si eliges Sintaxis de la API: |
Errores de política | policy_error |
suma |
La cantidad total de errores de políticas durante el período especificado. Por lo general, los errores de políticas suceden de forma intrínseca. Por ejemplo, la política Se registra un error de política en las estadísticas solo si genera un error en el proxy de API.
Por ejemplo, si el atributo La dimensión del nombre de la política del error ( Una falla en el destino (como Sintaxis de la API: |
Errores del proxy | is_error |
suma |
La cantidad total de veces que los proxies de API fallaron durante el período especificado. El error de proxy puede ocurrir cuando falla una política o cuando se produce una falla en el entorno de ejecución, como La dimensión de proxy ( Sintaxis de la API: |
Latencia de procesamiento de solicitudes | request_processing_latency |
promedio, mínimo, máximo |
La cantidad de tiempo (promedio, mínimo o máximo) en milisegundos que tarda Apigee en procesar las solicitudes entrantes. El tiempo comienza cuando la solicitud llega a Apigee y finaliza cuando Apigee la reenvía al servicio de destino. Si usas dimensiones diferentes, puedes examinar las latencias de procesamiento de solicitudes por proxy de API, app de desarrollador y región, entre otros. Sintaxis de la API: |
Tamaño de la solicitud | request_size |
suma, promedio, mínimo, máximo |
El tamaño de la carga útil de la solicitud que recibió Apigee, en bytes. Sintaxis de la API: |
Ejecuciones de la caché de respuesta | ax_cache_executed |
suma |
Cantidad total de veces que se ejecutó una política Debido a que la política Sin embargo, la ejecución de la caché de respuesta es 0 si el elemento En la Herramienta de depuración, puedes hacer clic en el ícono Sintaxis de la API: |
Latencia de procesamiento de respuestas | response_processing_latency |
promedio, mínimo, máximo |
La cantidad de tiempo (promedio, mínimo o máximo) en milisegundos que tarda Apigee en procesar las respuestas de API. El tiempo comienza cuando el proxy de API recibe la respuesta del servicio de destino y finaliza cuando Apigee reenvía la respuesta al emisor original. Si usas diferentes dimensiones, puedes examinar las latencias de procesamiento de respuesta por proxy de API y región, entre otros. Sintaxis de la API: |
Tamaño de la respuesta | response_size |
suma, promedio, mínimo, máximo |
El tamaño de la carga útil de la respuesta que se muestra al cliente, en bytes. Sintaxis de la API: |
Errores del destino | target_error |
suma |
Cantidad total de respuestas Sintaxis de la API: |
Tiempo de respuesta del destino | target_response_time |
suma, promedio, mínimo, máximo |
La cantidad de tiempo (suma, promedio, mínimo o máximo) en milisegundos que el servidor de destino tarda en responder a una llamada. Esta métrica te indica el rendimiento de los servidores de destino. El tiempo comienza cuando Apigee reenvía una solicitud al servicio de destino y finaliza cuando Apigee recibe la respuesta. Ten en cuenta que si una llamada a la API muestra una respuesta de la caché (por ejemplo, con la política Sintaxis de la API: |
Tiempo total de respuesta | total_response_time |
suma, promedio, mínimo, máximo |
La cantidad de tiempo (suma, promedio, 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. En el tiempo, se incluye la sobrecarga de red (como el tiempo que tardan los balanceadores de cargas y los routers para realizar su trabajo) y solicitar la latencia de procesamiento, la latencia de procesamiento de respuestas y el tiempo límite del destino (si la respuesta se entrega desde el servicio de destino, en lugar de desde la caché). Si usas dimensiones diferentes, puedes examinar las latencias de procesamiento por proxy de API, app de desarrollador y región, entre otros. Sintaxis de la API: |
Tráfico | message_count |
suma |
La cantidad total de llamadas a la API que procesa Apigee en el período especificado. Usa dimensiones para agrupar recuentos de tráfico de formas que sean más significativas para ti. Sintaxis de la API: |
Monetización | |||
Tarifas | fees |
suma, promedio, mínimo, máximo |
Importe que representa la tarifa de configuración, las tarifas recurrentes o las recargas de prepago. Sintaxis de la API: |
Porcentaje de ingresos del desarrollador | x_apigee_mintng_dev_share |
suma, promedio, mínimo, máximo |
Porcentaje del desarrollador en los ingresos de una transacción. Apigee calcula el porcentaje del desarrollador solo si habilitaste el porcentaje de ingresos en tu plan de tarifas. El porcentaje del desarrollador se calcula con la siguiente fórmula: x_apigee_mintng_dev_share = revShareGrossPrice * (share percentage)
El valor del porcentaje compartido se obtiene de tu plan de tarifas. Sintaxis de la API: |
Precio de la monetización | x_apigee_mintng_price |
suma, promedio, mínimo, máximo |
Los ingresos totales de una transacción.
Los ingresos de una transacción se establecen en el valor de la variable de monetización Sintaxis de la API: |
Multiplicador de precios de la API | x_apigee_mintng_price_multiplier |
suma, promedio, mínimo, máximo |
El factor (multiplicador) por el que se multiplica el costo por transacción. El costo por transacción se especifica en los precios de las tarifas basadas en el consumo del plan de tarifas. Sintaxis de la API: |
Tasas de monetización | x_apigee_mintng_rate |
suma, promedio, mínimo, máximo |
Tarifa cobrada por una transacción. La tarifa que se cobra por una transacción se calcula con la siguiente fórmula: x_apigee_mintng_rate = (consumption-based pricing rate) * perUnitPriceMultiplier value
El valor de la tarifa según el consumo se obtiene de tu plan de tarifas y el valor Sintaxis de la API: |
Dimensiones
Las dimensiones te permiten ver las métricas en agrupaciones significativas. Por ejemplo, ver los recuentos totales de tráfico tiene mucho más impacto cuando los visualizas para cada app de desarrollador o proxy de API.
A continuación, se muestran las dimensiones listas para usar que proporciona Apigee.
Dimensión | Nombre para usar en la API de Apigee | Descripción |
---|---|---|
Token de acceso | access_token |
El token de acceso de OAuth del usuario final de la app. |
Producto de API | api_product |
|
Clave de caché | ax_cache_key |
Clave que contiene el valor En la herramienta de depuración, cuando seleccionas una política de |
Nombre de la caché | ax_cache_name |
Nombre de la caché que contiene las claves o los valores usados por la política En la herramienta de depuración, cuando seleccionas una política de |
Origen de la caché | ax_cache_source |
Nivel de caché (en la memoria de L1 o de la base de datos de L2) desde la que se recuperó En la herramienta de depuración, cuando seleccionas la política de Para obtener más información sobre los niveles de la caché, consulta Aspectos internos de la caché. |
ID de cliente | client_id |
La clave de consumidor (clave de API) de la aplicación de desarrollador que realiza las llamadas a la API, ya sea que se pasen en la solicitud como claves de API o que se incluyan en los tokens de OAuth. A fin de obtener esta dimensión, los proxies que reciben llamadas se deben configurar para buscar una clave de API o un token de OAuth válidos. Las apps de desarrollador obtienen claves de API, que se pueden usar para generar tokens de OAuth, cuando las apps se registran en Apigee. Para obtener más información, consulta ¿Cómo puedo generar datos de estadísticas completos?. Si no se cumplen los criterios anteriores, verás el valor |
App de desarrollador | developer_app |
La aplicación para desarrollador registrada en Apigee que realiza llamadas a la API. Para obtener esta dimensión, las apps deben estar asociadas con uno o más productos de API que contengan los proxies de API a los que se llama y los proxies deben verificar que se envíe una clave de API o un token de OAuth con la llamada a la API. La clave o el token identifican la app de desarrollador. Para obtener más información, consulta ¿Cómo puedo generar datos de estadísticas completos?. Si no se cumplen los criterios anteriores, verás el valor |
Correo electrónico del desarrollador | developer_email |
|
ID de desarrollador | developer |
ID único de desarrollador que genera Apigee en el formato de Para obtener esta dimensión, los desarrolladores deben tener apps asociadas con uno o más productos de API que contengan los proxies de API a los que se llama y los proxies deben verificar que se envíe una clave de API o un token de OAuth con las llamadas a la API. La clave o el token identifican el desarrollador. Para obtener más información, consulta ¿Cómo puedo generar datos de estadísticas completos?. Si no se cumplen los criterios anteriores, verás el valor |
Entorno | environment |
El entorno de Apigee en el que se implementan los proxies de API. Por ejemplo, test o prod . |
Código de falla del error | ax_edge_execution_fault_code |
El código de falla del error. Por ejemplo: |
Nombre del flujo en el error | ax_execution_fault |
El flujo con nombre en un proxy de API que generó un error. Por ejemplo, Ten en cuenta que el nombre completo que se debe usar en la API de Apigee es Si no ocurrió ningún error, verás el valor |
Recurso de flujo | flow_resource |
Solo para su uso con Apigee. Si te interesa, consulta cómo usar la dimensión "Flujo de recursos" en Analytics. |
Estado del flujo que generó errores | ax_execution_fault |
El nombre del flujo de proxy de la API indica que se produjeron errores, como Ten en cuenta que el nombre completo que se debe usar en la API de Apigee es |
ID del flujo de la puerta de enlace | gateway_flow_id |
A medida que las llamadas a la API se mueven a través de Apigee, cada llamada obtiene su propio ID del flujo de la puerta de enlace. Ejemplo: rrt329ea-12575-114653952-1. El ID del flujo de la puerta de enlace 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 las llamadas. |
Organización | organization |
La organización de Apigee en la que se implementan los proxies de API. |
Nombre de política que genera errores | ax_execution_fault |
El nombre de la política que muestra un error y provocó un error en la llamada a la API. 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 |
El nombre de la máquina (no el nombre visible) de un proxy de API. |
Ruta base del proxy | proxy_basepath |
La BasePath configurada en el ProxyEndpoint del proxy de API. En la ruta base no se incluye la porción del dominio y el puerto de la URL del proxy de 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 para proxies implementados. Especificar un tipo de proxy limita los resultados a ese tipo de proxy. Esta dimensión se aplica solo a los usuarios de Pago por uso y Suscripción 2024, que usan tipos de proxy. Los valores posibles son |
Sufijo de la ruta del proxy | proxy_pathsuffix |
La ruta del recurso agregada a la ruta base del proxy de API. Por ejemplo, si la URL base de un proxy de API es Si no se usa un El valor también se almacena en la variable de flujo |
Revisión del proxy | apiproxy_revision |
El número de revisión del proxy de API que manejó las llamadas a la API. Esto no necesariamente significa que es la última revisión de un proxy de API. Si un proxy de API tiene 10 revisiones, puede que la octava revisión se esté implementando en el momento. Además, una API puede tener varias revisiones implementadas siempre que las revisiones tengan diferentes rutas base, como se describe en Implementa proxies. |
IP de cliente resuelta | ax_resolved_client_ip |
Es la dirección IP de cliente de origen. El valor de la dimensión Ten en cuenta que, cuando se usan productos de enrutamiento como Akamai con el fin de capturar las direcciones IP reales de clientes, la IP de cliente se pasa a Apigee en el encabezado HTTP El valor de la dimensión
|
Código de estado de la respuesta | response_status_code |
Código de estado de respuesta HTTP reenviado desde Apigee al cliente, como 200 , 404 , 503 , etcétera. En Apigee, el código de estado de respuesta de destino se puede reemplazar por políticas como Política AssignMessage y Política RaiseFault, por lo que esta dimensión puede diferir del Código de respuesta de destino (target_response_code). |
Host virtual | virtual_host |
El nombre del host virtual al que se realizó la llamada a la API. Para obtener más información, consulta Información acerca de los entornos y grupos de entornos. |
Entrada/cliente | ||
Dirección IP de cliente | client_ip |
La dirección IP del sistema que accede al router, como el cliente original (proxy_client_ip) o un balanceador de cargas. Cuando hay varias IP en el encabezado X-Forwarded-For , esta es la última IP que aparece en la lista. |
Categoría del dispositivo | ax_ua_device_category |
Tipo de dispositivo desde el que se realizó la llamada a la API, como Tablet o Smartphone . |
Familia del SO | ax_ua_os_family |
La familia del sistema operativo del dispositivo que realiza la llamada, como Android o iOS . |
Versión del SO | ax_ua_os_version |
La versión del sistema operativo del dispositivo que realiza la llamada. Es útil usar esto como una segunda dimensión de desglose de la familia del SO (ax_ua_os_family) para ver las versiones de los sistemas operativos. |
IP de cliente del proxy | proxy_client_ip |
Dirección IP del cliente que realiza la llamada, almacenada en la variable de flujo |
IP de cliente referida | ax_true_client_ip |
Cuando se usan productos de enrutamiento como Akamai con el fin de capturar las direcciones IP reales de clientes, las IP de cliente se pasan a Apigee en el encabezado HTTP Para determinar la dirección IP de cliente original, a la que se accede a través de la dimensión |
Ruta de la solicitud | request_path |
La ruta del recurso (sin incluir el dominio) al servicio de destino, sin incluir los parámetros de consulta. Por ejemplo, en la dirección |
URI de solicitud | request_uri |
La ruta del recurso (sin incluir el dominio) al servicio de destino, incluidos los parámetros de consulta. Por ejemplo, en la dirección |
Verbo de la solicitud | request_verb |
El verbo de la solicitud HTTP en las solicitudes a la API, como GET, POST, PUT y DELETE. |
Usuario-agente | useragent |
Nombre del usuario-agente, o agente de software, que se usa para realizar la llamada a la API. Ejemplos:
|
Familia del usuario-agente | ax_ua_agent_family |
Familia del usuario-agente, como Chrome Mobile o curl . |
Tipo del usuario-agente | ax_ua_agent_type |
El tipo de usuario-agente, como Browser , Mobile Browser , Library , etcétera. |
Versión del usuario-agente | ax_ua_agent_version |
Versión del usuario-agente. Es útil usarla como una segunda dimensión de desglose con la familia usuario-agente (ax_ua_agent_family) para obtener la versión de la familia del agente. |
Salida/Destino | ||
Target | target |
Extremo de destino que manejó la solicitud. Por ejemplo, default . |
Ruta base del destino | target_basepath |
La ruta del 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, la target_basepath es Si el objetivo fuera el siguiente: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net</URL> </HTTPTargetConnection> target_basepath sería nulo. En la herramienta de depuración, cuando seleccionas el ícono de AX al final del diagrama de flujo, la variable de flujo |
Nombre del servicio de gRPC | x_apigee_grpc_service_name |
Solo se aplica cuando el servicio de destino es gRPC. El nombre del servicio de gRPC. Para obtener información sobre los proxies de gRPC, consulta Crea proxies de API de gRPC. |
Estado de gRPC | x_apigee_grpc_status |
Solo se aplica cuando el servicio de destino es gRPC. El estado de la solicitud de gRPC. Para obtener información sobre los proxies de gRPC, consulta Crea proxies de API de gRPC. |
Host del 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 del destino | target_ip |
La dirección IP del servicio de destino que reenvía la respuesta al proxy de API. |
Código de respuesta del destino | target_response_code |
Código de estado de respuesta HTTP que muestra el servicio de destino al proxy de API, como Un valor de Es diferente a la dimensión de 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 de gRPC, consulta Crea proxies de API de gRPC. |
URL del destino | target_url |
La URL completa del servicio de destino que se definió 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 mediante la variable de flujo En el encadenamiento de proxy, la target_url del proxy que realiza la llamada es nula. |
IP de X-Forwarded-For | x_forwarded_for_ip |
La lista de direcciones IP en el encabezado Para determinar la dirección IP de cliente original, a la que se accede a través de la dimensión |
Protocolo de X-Forwarded-For | x_forwarded_proto |
El protocolo que el cliente usó para conectarse al router. Entre los valores válidos, se incluyen |
Hora | ||
Día de la semana | ax_day_of_week |
La abreviatura de tres letras del día de la semana en la que se realizaron las llamadas a la API. Por ejemplo, lun, mar o mié. |
Mes | ax_month_of_year |
El numero del mes en el que se realizaron las llamadas a la API. Por ejemplo, 03 para marzo. |
Hora del día | ax_hour_of_day |
En función de un reloj de 24 horas, es la hora de 2 dígitos en que se realizaron las llamadas a la API. Por ejemplo, para las llamadas a la API realizadas entre las 10 p.m. y las 11 p.m., la x_hour_of_day sería 22. El valor de la hora está en UTC. |
Zona horaria | ax_geo_timezone |
Nombres comunes de las zonas horarias desde las que se realizaron 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, para las llamadas a la API realizadas durante la tercera semana de un mes, ax_week_of_month es 3. |
Ubicación | ||
Ciudad | ax_geo_city |
La ciudad desde la que se realizaron las llamadas a la API. |
Continente | ax_geo_continent |
El código de dos letras del continente desde el cual se hicieron las llamadas a la API. Por ejemplo, NA para Norteamérica. |
País | ax_geo_country |
El código de dos letras del país desde el cual se hicieron las llamadas a la API. Por ejemplo, US para Estados Unidos. |
Región geográfica | ax_geo_region |
El código con guiones 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 | ||
Creada | created |
Actualmente, está disponible en organizaciones de Apigee, no en organizaciones híbridas de Apigee. Marca de tiempo de Unix cuando se agregó la lista de tarifas para el desarrollador de apps y el producto de la API. |
Tipo de tarifa | fees_type |
Tipo de tarifa. Puede ser una tarifa de configuración, una tarifa recurrente o una recarga de prepago. Este valor solo se propaga si seleccionaste la métrica Fees . |
Moneda de los ingresos | x_apigee_mintng_currency |
|
ID de plan de tarifa | x_apigee_mintng_rate_plan_id |
Actualmente, está disponible en organizaciones de Apigee, no en organizaciones de Apigee Hybrid. El plan de tasa de monetización del desarrollador de apps. |
Éxito de la transacción | x_apigee_mintng_tx_success |
El estado de monetización de la transacción se establece en el valor de la variable de monetización transactionSuccess que se captura en tu política de DataCapture. |
Filtros
Los filtros te permiten limitar los resultados a las métricas con características específicas. A continuación, se muestran algunos filtros de ejemplo. Usa nombres de métricas y dimensiones con el estilo de API cuando definas filtros.
Muestra métricas para los proxies de API con nombres de libros o música:
filter=(apiproxy in 'books','music')
Muestra métricas para proxies de API con nombres que comienzan con m
:
filter=(apiproxy like 'm%')
Muestra métricas para proxies de API con nombres que no comienzan con m
:
filter=(apiproxy not like 'm%')
Muestra métricas para 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)
Muestra métricas para las llamadas a la API con un código de estado de respuesta de 200
y un código de respuesta de destino de 404
:
filter=(response_status_code eq 200 and target_response_code eq 404)
Muestra métricas para las llamadas a la API con un código de estado de respuesta de 500
:
filter=(response_status_code eq 500)
Muestra métricas para las llamadas a la API que no generaron errores:
filter=(is_error eq 0)
Muestra métricas para las llamadas a la API que no generaron respuestas null
:
filter=(response_status_code isnot null)
A continuación, se enumeran los operadores que puedes usar para compilar filtros de informe.
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 es null . |
isnot |
Usa response_status_code isnot null para filtrar las respuestas cuyo código de estado no sea null . |
eq |
Es igual a == |
ne |
No es igual, != |
gt |
Es mayor, > |
lt |
Es menor, < |
ge |
Es mayor o igual, >= |
le |
Es menor o igual, <= |
like |
Muestra verdadero si el patrón de string coincide con el patrón proporcionado. |
not like |
Muestra falso si el patrón de string coincide con el patrón proporcionado. |
similar to |
Muestra verdadero o falso en función de si su patrón coincide con la string proporcionada. Es similar a like , excepto que interpreta el patrón mediante la definición de una expresión regular del estándar de SQL. |
not similar to |
Muestra falso o verdadero en función de si su patrón coincide con la string proporcionada. Es similar a not like , excepto que interpreta el patrón mediante la definición de una expresión regular del estándar de 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 con 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 con al menos una de las condiciones. |