Referencia sobre las métricas, las dimensiones y los filtros de Analytics

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: tps

Cantidad de solicitudes a la API correctas que usan ResponseCache en lugar de la respuesta del servicio de destino.

Sintaxis de la API: sum(cache_hit)

Cantidad de elementos en caché L1 (en memoria) por transacción durante un período determinado. Por ejemplo, si eliges max para el período de un día y durante ese día la cantidad más alta de elementos en la caché es de 12 para una transacción específica, entonces el conteo será 12. Para avg, si hay tres transacciones en el período que consultas y sus recuentos de caché son 5, 6 y 7, el promedio será 6. La caché de L1 es la caché en la memoria, en lugar de la caché de la base de datos de L2, como se describe en Aspectos internos de la caché.

Sintaxis de la API: avg(ax_cache_l1_count)

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 VerifyApiKey genera un error cuando se pasa una clave de API no válida en la solicitud y una política SpikeArrest muestra un error si la cantidad de llamadas a la API supera el límite definido en la política. Por lo tanto, esta métrica es útil para encontrar posibles problemas en las API. Por ejemplo, las métricas policy_error, que agrupa la dimensión developer_app, pueden ayudarte a descubrir que una clave de API o un token de OAuth venció para una app determinada o a descubrir que un proxy de API específico genera muchos errores de política SpikeArrest, lo que te ayuda a descubrir que el límite de aumento de tráfico del proxy no toma en cuenta un aumento del tráfico de un feriado.

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 continueOnError de una política se configura como true, el proxy de la API continuará procesando una solicitud, incluso si la política falla. En ese caso, no se registrará un error de política en las estadísticas.

La dimensión del nombre de la política del error (ax_execution_fault_policy_name) es útil para agrupar errores de políticas por nombre de política.

Una falla en el destino (como 404 o 503) no se cuenta como una falla en la política. Estas se cuentan como fallas en el proxy de la API (is_error).

Sintaxis de la API: sum(policy_error)

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 404 o 503 del servicio de destino.

La dimensión de proxy (apiproxy) es útil para agrupar fallas de proxy de API por proxy.

Sintaxis de la API: sum(is_error)

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: max(request_processing_latency)

El tamaño de la carga útil de la solicitud que recibió Apigee, en bytes.

Sintaxis de la API: avg(request_size)

Cantidad total de veces que se ejecutó una política ResponseCache durante el período determinado.

Debido a que la política ResponseCache se adjunta en dos lugares de un proxy de API (una vez en la solicitud y una vez en la respuesta), por lo general, se ejecuta dos veces en una llamada a la API. Un GET de caché y un PUT de caché se cuentan como una ejecución.

Sin embargo, la ejecución de la caché de respuesta es 0 si el elemento <SkipCacheLookup> de la política se evalúa como verdadero (en la solicitud) y 0 si el elemento <SkipCachePopulation> de la política se evalúa como verdadero (en la respuesta).

En la Herramienta de depuración, puedes hacer clic en el ícono ResponseCache en una llamada a la API ejecutada y ver la variable de flujo responsecache.executed para ver si hubo o no una ejecución de la caché (un valor de 1).

Sintaxis de la API: sum(ax_cache_executed)

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: min(response_processing_latency)

El tamaño de la carga útil de la respuesta que se muestra al cliente, en bytes.

Sintaxis de la API: max(response_size)

Cantidad total de respuestas 5xx del servicio de destino. Apigee no genera estos son errores del servicio de destino.

Sintaxis de la API: sum(target_error)

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 ResponseCache), la llamada nunca alcanzará el servicio de destino y no se registrarán métricas de tiempo de respuesta de destino.

Sintaxis de la API: avg(target_response_time)

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: avg(total_response_time)

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: sum(message_count)

Importe que representa la tarifa de configuración, las tarifas recurrentes o las recargas de prepago.

Sintaxis de la API: sum(fees)

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:

El valor del porcentaje compartido se obtiene de tu plan de tarifas.

Sintaxis de la API: sum(x_apigee_mintng_dev_share)

Los ingresos totales de una transacción. Los ingresos de una transacción se establecen en el valor de la variable de monetización revShareGrossPrice capturada en la política de DataCapture.

Sintaxis de la API: sum(x_apigee_mintng_price)

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: avg(x_apigee_mintng_price_multiplier)

Tarifa cobrada por una transacción. La tarifa que se cobra por una transacción se calcula con la siguiente fórmula:

El valor de la tarifa según el consumo se obtiene de tu plan de tarifas y el valor perUnitPriceMultiplier se multiplica solo si la política DataCapture captura la variable.

Sintaxis de la API: sum(x_apigee_mintng_rate)

• Nombre del producto de API que contiene los proxies de API a los que se llamará. Para obtener esta dimensión, las apps de desarrolladores que realizan las llamadas deben estar asociadas con uno o más productos de API que contengan los proxies de API y los proxies a los que se llama deben verificar que se haya enviado una clave de API o un token de OAuth con la llamada a la API. La clave o el token están asociados con un producto de API. 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 (not set). Consulta también ¿Qué significa un valor de entidad de las estadísticas “(no configurado)”?.

• En el contexto de la métrica de tarifas, será el producto de API que corresponda al plan de tarifas al que se debe aplicar la tarifa de configuración o la tarifa recurrente. El valor estará vacío para recargas de prepago.

Clave que contiene el valor ResponseCache al que se accedió. Si deseas obtener más información sobre cómo se construye la clave para la caché de respuestas, consulta Política ResponseCache.

En la herramienta de depuración, cuando seleccionas una política de ResponseCache que lee o escribe en la caché, puedes ver este valor en la variable de flujo responsecache.cachekey.

Nombre de la caché que contiene las claves o los valores usados por la política ResponseCache, con el prefijo orgName__envName__. Por ejemplo, si la organización es myorgf, el entorno es test y el nombre de la caché es myCache, ax_cache_name es foo__test__myCache.

En la herramienta de depuración, cuando seleccionas una política de ResponseCache, puedes ver este valor en la variable de flujo responsecache.cachename.

Nivel de caché (en la memoria de L1 o de la base de datos de L2) desde la que se recuperó ResponseCache. Esta dimensión también muestra CACHE_MISS cuando la respuesta se entregó desde el destino en lugar de la caché (y la caché de respuesta se actualizó con la respuesta de destino), o cuando una clave de caché en la solicitud no es válida. Las claves de caché tienen un límite de tamaño de 2 KB.

En la herramienta de depuración, cuando seleccionas la política de ResponseCache, puedes ver este valor en la variable de flujo responsecache.cachesource.

Para obtener más información sobre los niveles de la caché, consulta Aspectos internos de la caché.

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 (not set). Consulta también ¿Qué significa un valor de entidad de las estadísticas "(no configurado)"?.

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 (not set). Consulta también ¿Qué significa un valor de entidad de las estadísticas "(no configurado)"?.

• El correo electrónico de los desarrolladores registrados en Apigee cuya aplicación realizó las llamadas a la API. Este campo no se establece para las apps de AppGroup.

  Para obtener esta dimensión, los desarrolladores o AppGroups 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 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 (not set). Consulta también ¿Qué significa un valor de entidad de las estadísticas "(no configurado)"?.

• En el contexto de la métrica de tarifas, será el desarrollador al que se le debe cobrar una tarifa de configuración, tarifas recurrentes o recargas de prepago.

ID único de desarrollador que genera Apigee en el formato de org_name@@@unique_id. Para AppGroups, el unique_id es el nombre del AppGroup.

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 (not set). Consulta también ¿Qué significa un valor de entidad de las estadísticas "(no configurado)"?.

El código de falla del error. Por ejemplo: messaging.adaptors.http.flow.GatewayTimeout

El flujo con nombre en un proxy de API que generó un error. Por ejemplo, PreFlow, PostFlow o el nombre de un flujo condicional que creaste.

Ten en cuenta que el nombre completo que se debe usar en la API de Apigee es ax_execution_fault_flow_name, sin salto de línea.

Si no ocurrió ningún error, verás el valor (not set).

El nombre del flujo de proxy de la API indica que se produjeron errores, como PROXY_REQ_FLOW o TARGET_RESP_FLOW.

Ten en cuenta que el nombre completo que se debe usar en la API de Apigee es ax_execution_fault_flow_state, sin salto de línea.

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 ax_execution_fault_policy_name, sin salto de línea.

Si una política genera un error, pero el atributo raíz de la política continueOnError se configura como true, el flujo del proxy de API continúa sin fallas y la falla en la política no se cuenta en esta dimensión.

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 https://apigeedocs-test.apigee.net/releasenotes/, la ruta base es /releasenotes.

El valor también se almacena en la variable de flujo proxy.basepath.

El tipo de proxy de API para los proxies implementados. Especificar un tipo de proxy limita los resultados a ese tipo de proxy. Los valores posibles son STANDARD, EXTENSIBLE o sin configurar.

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 https://apigeedocs-test.apigee.net/hello/ y se hace una llamada a https://apigeedocs-test.apigee.net/hello/json, pathsuffix es /json.

Si no se usa un pathsuffix, el valor estará vacío.

El valor también se almacena en la variable de flujo proxy.pathsuffix.

Es la dirección IP de cliente de origen. El valor de la dimensión ax_resolved_client_ip se calcula a partir de los valores de las dimensiones ax_true_client_ip y x_forwarded_for_ip.

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 True-Client-IP, que luego se usa para configurar la dimensión ax_true_client_ip.

El valor de la dimensión ax_resolved_client_ip se calcula de la siguiente manera:

1. Si ax_true_client_ip no es nulo y no contiene una dirección IP local, configura ax_resolved_client_ip como ax_true_client_ip.
2. De lo contrario, configura ax_resolved_client_ip como la primera dirección IP que no sea local en x_forwarded_for_ip.
3. Si ax_true_client_ip y x_forwarded_for_ip contienen solo IP locales, configura ax_resolved_client_ip como la última IP local en x_forwarded_for_ip.
4. Si ax_true_client_ip y x_forwarded_for_ip son nulos, configura ax_resolved_client_ip como (not set).
5. Si ax_true_client_ip es una IP local y x_forwarded_for_ip es nulo, configura ax_resolved_client_ip como (not set).

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.

Dirección IP del cliente que realiza la llamada, almacenada en la variable de flujo proxy.client.ip. Por lo general, es la dirección X-Forwarded-For de la llamada entrante, que es la dirección IP que Apigee recibió del último protocolo de enlace de TCP externo. Puede ser el cliente que realiza la llamada 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.

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 True-Client-IP. Esta dimensión captura esas IP de cliente reales de ese encabezado.

Para determinar la dirección IP de cliente original, a la que se accede a través de la dimensión ax_resolved_client_ip, Apigee usa las dimensiones ax_true_client_ip y x_forwarded_for_ip.

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 http://mocktarget.apigee.net de destino de muestra de Apigee, se incluyen varios recursos, incluido /user, que muestra un saludo. Sin importar cómo el proxy de API llame a http://mocktarget.apigee.net/user, la ruta de la solicitud es /user.

La ruta del recurso (sin incluir el dominio) al servicio de destino, incluidos los parámetros de consulta.

Por ejemplo, en la dirección http://mocktarget.apigee.net de destino de muestra de Apigee, se incluyen varios recursos, incluido el recurso /user?user={name} y el parámetro de consulta con el fin de mostrar un saludo personalizado al nombre proporcionado. Sin importar cómo el proxy de API llame a http://mocktarget.apigee.net/user?user=Dude, el request_uri es /user?user=Dude.

Nombre del usuario-agente, o agente de software, que se usa para realizar la llamada a la API. Ejemplos:

• Un Pixel XL que realiza una llamada mediante Chrome: Mozilla/5.0 (Linux; Android 7.1.2; Pixel XL Build/NHG47N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.92 Mobile Safari/537.36
• Un iPad que realiza una llamada mediante Chrome: Mozilla/5.0 (iPad; CPU OS 10_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/54.0.2840.91 Mobile/14C92 Safari/602.1
• cURL desde una terminal: curl/7.51.0

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.

La ruta del recurso (sin incluir el dominio) al servicio de destino, sin incluir los parámetros de consulta, que se define en el <TargetEndpoint> del proxy.

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 /user.

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 target.basepath se mapea a la dimensión target_basepath.

Código de estado de respuesta HTTP que muestra el servicio de destino al proxy de API, como 200, 404, 503, etcétera.

Un valor de null significa que la solicitud nunca llegó al servicio de destino. Esto ocurre cuando la política ResponseCache entrega la respuesta o cuando existe una falla en el procesamiento de la solicitud.

Es diferente a la dimensión de código de estado de respuesta (response_status_code).

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 http://mocktarget.apigee.net/user?user=Dude.

Ten en cuenta que la URL también se puede anular durante el procesamiento del proxy de API mediante la variable de flujo target.url.

En el encadenamiento de proxy, la target_url del proxy que realiza la llamada es nula.

La lista de direcciones IP en el encabezado X-Forwarded-For.

Para determinar la dirección IP de cliente original, a la que se accede a través de la dimensión ax_resolved_client_ip, Apigee usa las dimensiones ax_true_client_ip y x_forwarded_for_ip.

El protocolo que el cliente usó para conectarse al router. Entre los valores válidos, se incluyen http o https.

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.

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.

• La moneda de los ingresos de la transacción se establece en el valor de la variable de monetización currency que se captura en tu política de DataCapture. Esta moneda está asociada con la moneda de revShareGrossPrice.
• En el contexto de la métrica de tarifas, será la moneda de la tarifa de configuración, la tarifa recurrente o la recarga de prepago.

Actualmente, está disponible en organizaciones de Apigee, no en organizaciones de Apigee Hybrid.

El plan de tasa de monetización del desarrollador de apps.