Página de análisis en Jitterbit API Manager

Introducción

La página de Análisis en API Manager muestra métricas de consumo y rendimiento para APIs personalizadas, APIs OData y APIs proxy. Los datos aparecen en múltiples gráficos.

Para obtener más información sobre cómo configurar y ejecutar una API, consulta estos recursos:

• APIs personalizadas
• APIs OData
• APIs proxy

Acceder a la página de análisis

Para acceder a la página de Análisis, utiliza el menú del portal Harmony para seleccionar API Manager > Análisis.

Controles de la página de análisis

La página de Análisis tiene controles para filtrar los datos mostrados en los gráficos, establecer el período de tiempo y gestionar el diseño del gráfico.

Puedes ajustar los datos que cada gráfico muestra, así como el marco temporal y la escala del gráfico, utilizando los menús desplegables de filtro y el selector de período de tiempo.

Filtros desplegables

Los filtros desplegables permiten mostrar criterios específicos en cualquier combinación de entornos, APIs, perfiles, códigos de estado y versiones según sea necesario.

Cada filtro muestra una lista desplegable de criterios de los cuales puedes seleccionar uno o varios utilizando casillas de verificación. Cuando se aplican filtros a un desplegable, aparece una insignia de conteo junto a la etiqueta del desplegable que indica el número de filtros activos.

Estos son los criterios disponibles para filtrar:

• Entorno: Utiliza el desplegable para seleccionar los entornos donde se encuentran las APIs. Cuando no se seleccionan filtros, se muestran todas las APIs en los entornos dentro de la organización a la que tienes acceso.

• APIs: Utiliza el desplegable para seleccionar las APIs publicadas dentro de la organización. Cuando no se seleccionan filtros, se muestran todas las APIs en la organización a la que tienes acceso.

  Nota

  Las APIs publicadas anteriormente que se vuelven no publicadas no aparecerán en el desplegable de APIs. Los registros de API para estas APIs estarán presentes en la página de API Logs, pero no se pueden filtrar.

• Versión: Utiliza el desplegable para seleccionar el número de versión de las APIs. Cuando no se seleccionan filtros, se muestran todas las versiones de las APIs en la organización a la que tienes acceso.

• Métodos: Utiliza el desplegable para seleccionar métodos HTTP. Cuando no se seleccionan filtros, se muestran todos los métodos HTTP para las APIs en la organización a la que tienes acceso.

• Códigos de Estado: Utiliza el desplegable para seleccionar los grupos de códigos de estado de respuesta HTTP, seleccionando entre Éxito (2xx), Redirecciones (3xx), Errores del Cliente (4xx) y Errores del Servidor (5xx). Cuando no se seleccionan filtros, se muestran todos los códigos de estado de respuesta HTTP para las APIs en los entornos a los que tienes acceso. Para más información sobre los códigos de estado, consulta las definiciones de códigos de estado de w3.org.

• Perfiles: Utiliza el desplegable para seleccionar los perfiles de seguridad para filtrar los registros. El desplegable muestra los perfiles de seguridad creados dentro de la organización.

• Limpiar filtros: Haz clic para eliminar todos los filtros aplicados en todos los menús desplegables. Para agregar o quitar elementos de filtro individuales, haz clic en la casilla de verificación junto al nombre del elemento dentro del menú desplegable. Para limpiar todas las selecciones de un menú desplegable de filtro específico, haz clic en junto al distintivo de conteo de filtros.

• Actualizar: Haz clic en el ícono de actualizar para recargar los datos analíticos basados en los filtros aplicados y los criterios de búsqueda.

Selector de período de tiempo

El selector de período de tiempo muestra el rango de tiempo actualmente seleccionado (por ejemplo, Última 1 semana) y te permite ajustar el marco temporal de los datos analíticos:

Haz clic en el selector de período de tiempo para abrir un diálogo con dos pestañas: Relativo y Absoluto.

Pestaña Relativa

La pestaña Relativa proporciona rangos de tiempo preestablecidos y un selector de período de tiempo relativo personalizado:

Selecciona uno de los rangos de tiempo preestablecidos:

• Última 1 hora: Muestra datos analíticos de la última hora.

• Último 1 día: Muestra datos analíticos del último día.

• Última 1 semana: Muestra datos analíticos de la última semana.

• Último 1 mes: Muestra datos analíticos del último mes.

Para crear un período de tiempo relativo personalizado, utiliza los controles en la parte inferior del diálogo:

• Campo numérico: Ingresa el número de unidades de tiempo (por ejemplo, 1, 7, 30).

• Menú desplegable de unidades: Selecciona la unidad de tiempo de Minutos, Horas, Días, Semanas o Meses.

• Cancelar: Cierra el diálogo sin aplicar cambios.

• Aplicar: Aplica el rango de tiempo seleccionado y cierra el diálogo.

Pestaña Absoluta

La pestaña Absoluta te permite seleccionar un rango de fecha y hora específico dentro de los últimos 30 días:

El rango de fechas seleccionado se muestra en la parte superior del diálogo en el formato MM/DD/YYYY, HH:mm am/pm - MM/DD/YYYY, HH:mm am/pm.

Configura el rango de fecha y hora utilizando los siguientes controles:

• Campo de hora de inicio: Muestra la hora de inicio para el rango. Haz clic en para borrar, o haz clic en para ajustar la hora.

• Campo de hora de fin: Muestra la hora de fin para el rango. Haz clic en para borrar, o haz clic en para ajustar la hora.

• Selector de calendario: Usa el calendario para seleccionar las fechas de inicio y fin. Navega entre meses utilizando las flechas izquierda y derecha.

• Cancelar: Cierra el diálogo sin aplicar cambios.

• Aplicar: Aplica el rango de fecha y hora seleccionado y cierra el diálogo.

Controles de período de tiempo adicionales

Cuando se selecciona un período de tiempo y se muestra en el encabezado:

• Haz clic en junto a la visualización del período de tiempo para borrar el período de tiempo seleccionado y volver al valor predeterminado.

• Haz clic en el ícono de calendario junto a la visualización del período de tiempo para reabrir el diálogo del selector de período de tiempo.

Monitoreo de salud de la API

La tabla de monitoreo de salud de la API muestra una lista de llamadas a API personalizadas que están tardando en ejecutarse o que están activas (ocurriendo dentro de un marco de tiempo establecido) y sus tiempos de respuesta:

• Umbral de respuesta: Ingresa el umbral de respuesta (en segundos) para mostrar las llamadas a API personalizadas con un tiempo de respuesta igual a o mayor que el umbral proporcionado. El valor predeterminado es 5 segundos y el valor mínimo permitido es 1 segundo. El número proporcionado debe ser un entero.

• Todas las APIs activas: Haz clic para alternar la visualización dentro del marco de tiempo proporcionado. Cuando se desactiva, la tabla muestra solo las APIs personalizadas cuyo Tiempo de Respuesta es igual a o mayor que el Umbral de Respuesta proporcionado. Cuando se activa, la tabla muestra todas las APIs personalizadas activas, y el campo Umbral de Respuesta está deshabilitado.

• Nombre de la API: El nombre de la API personalizada. Para cambiar el orden de clasificación de descendente (predeterminado) a ascendente, haz clic en las flechas junto al nombre de la columna.

• Versión: La versión de la API personalizada (si se proporciona).

• Nombre del Servicio: El nombre del servicio de la API.

• Método: El método de solicitud del servicio de la API.

• URL del Servicio de la API: La URL del servicio de la API.

• Llamadas a la API: El número total de llamadas a la API personalizada dentro del período de tiempo proporcionado.

• Tiempo de Respuesta Promedio (Seg): El tiempo de respuesta promedio (en segundos) para la llamada a la API personalizada.

• Tiempo de Respuesta Mínimo: El tiempo de respuesta mínimo (en segundos) registrado para la llamada a la API personalizada.

• Tiempo de Respuesta Máximo: El tiempo de respuesta máximo (en segundos) registrado para la llamada a la API personalizada.

• Entorno: El entorno de la API.

• Descargar como CSV: Haz clic para descargar los datos analíticos actuales basados en los filtros y criterios de búsqueda aplicados.

  Nota

  El campo de fecha dentro del archivo CSV es un timestamp UNIX que requerirá conversión si deseas usar un formato de fecha y hora diferente.

• Filtrar columnas: Haz clic para cambiar la visibilidad y el orden de las columnas. Se abre el panel lateral de Columnas.

  • Buscar: Ingresa parte o la totalidad del nombre de una columna para reducir la lista a aquellas que coincidan con el texto.

  • Mostrar Todo: Hacer visibles todas las columnas.

  • Mover: Arrastra y suelta para cambiar la posición de la columna en relación con las demás.

  • Ocultar: La columna es visible. Haz clic para ocultarla.

  • Mostrar: La columna está oculta. Haz clic para mostrarla.

  • Guardar: Guarda cualquier cambio en las columnas.

  • Cancelar y Cerrar: Cierra el editor de columnas sin guardar cambios.

Controles de visualización del gráfico

Cada gráfico descrito en las secciones siguientes incluye dos íconos en la esquina superior derecha que controlan su visualización:

• Expandir/colapsar: Haz clic para expandir el gráfico a una vista más grande o colapsarlo de nuevo a su tamaño predeterminado.

• Arrastrar: Haz clic y arrastra para reposicionar el gráfico en la página.

Métricas de llamadas

Métricas de llamadas es una sección colapsable que muestra múltiples gráficos que indican el rendimiento y los datos de uso de la API. Haz clic en el encabezado de la sección para expandir o colapsar la visualización.

La sección incluye los siguientes gráficos:

• Hits
• Tiempo de respuesta (ms)
• Códigos de estado
• Total de llamadas
• Análisis de errores
• Utilización del límite de tasa a nivel de organización
• Violaciones de políticas
• Perspectivas a nivel de método

Hits

El gráfico de Hits muestra el número de llamadas a la API a lo largo del tiempo.

Tres insignias de resumen aparecen sobre el gráfico, cada una mostrando un valor métrico para el período de tiempo seleccionado:

• Min: El número mínimo de llamadas registradas en cualquier período de tiempo.
• Promedio: El número promedio de llamadas a través de todos los períodos de tiempo.
• Max: El número máximo de llamadas registradas en cualquier período de tiempo.

Cada punto final de la API está representado por una línea de color separada, con la URL del punto final mostrada en la leyenda. Si se trazan más puntos finales de los que la leyenda puede mostrar, aparece un indicador +N; pasa el cursor sobre él para ver las URL de los puntos finales restantes.

Pasa el cursor sobre cualquier punto de datos para mostrar un tooltip que indique la fecha y el número de llamadas para ese punto final en ese momento.

Tiempo de respuesta (ms)

El gráfico de Tiempo de respuesta (ms) muestra los tiempos de respuesta en milisegundos para las APIs a lo largo del tiempo.

El gráfico muestra tres métricas presentadas como insignias sobre el gráfico:

• Min: El tiempo de respuesta mínimo en milisegundos en cualquier período de tiempo.
• Promedio: El tiempo de respuesta promedio en milisegundos a través de todos los períodos de tiempo.
• Max: El tiempo de respuesta máximo en milisegundos en cualquier período de tiempo.

Cada punto final de la API está representado por una línea de color separada, con la URL del punto final mostrada en la leyenda. Si se trazan más puntos finales de los que la leyenda puede mostrar, aparece un indicador +N; pasa el cursor sobre él para ver las URL de los puntos finales restantes.

Pasa el cursor sobre cualquier punto de datos para mostrar el tiempo de respuesta en milisegundos para ese endpoint en ese momento específico.

Códigos de estado

El gráfico de Códigos de estado muestra la distribución de los códigos de estado HTTP devueltos por las APIs a lo largo del tiempo.

El gráfico muestra códigos de estado HTTP específicos para todas las categorías de respuesta: éxito (2xx), redirección (3xx), errores del cliente (4xx) y errores del servidor (5xx). Esto permite monitorear la distribución de los códigos de respuesta a lo largo del tiempo.

Pasa el cursor sobre cualquier punto de datos para mostrar un tooltip que muestra la fecha y el número de llamadas que devolvieron cada código de estado en ese momento.

Llamadas totales

El gráfico de Llamadas totales muestra las principales APIs por volumen de llamadas dentro del período seleccionado.

Utiliza el menú desplegable en la parte superior derecha para seleccionar qué APIs mostrar. Las opciones incluyen Top 5 APIs, Top 10 APIs, Top 25 APIs y Todas las APIs.

El gráfico muestra un gráfico de barras que muestra el volumen relativo de llamadas para cada API. Cada endpoint de API está representado por un color diferente en la leyenda. Si se trazan más endpoints de los que la leyenda puede mostrar, aparece un indicador +N; pasa el cursor sobre él para ver las URL de los endpoints restantes.

Pasa el cursor sobre cualquier barra para mostrar un tooltip que muestra la URL del endpoint y su conteo de llamadas.

Análisis de errores

El gráfico de Análisis de errores muestra el número de llamadas API exitosas en comparación con las llamadas no exitosas a lo largo del tiempo como un gráfico de área apilada.

El gráfico muestra dos categorías:

• Códigos de estado 200-299 (éxito): Llamadas API que devolvieron una respuesta de éxito (2xx) o redirección (3xx).
• Códigos de estado 400-599 (errores): Llamadas API que devolvieron un error del cliente (4xx) o un error del servidor (5xx).

Pasa el cursor sobre cualquier punto de datos para mostrar un tooltip que muestra la hora y el número de llamadas para esa categoría en ese momento.

Utilización del límite de tasa a nivel de organización

El gráfico de Utilización del límite de tasa a nivel de organización muestra el número promedio de llamadas por minuto para la organización durante cada período de tiempo.

Pasa el cursor sobre cualquier punto de datos para mostrar un tooltip que muestra la fecha y el límite de tasa promedio para ese período de tiempo.

Violaciones de políticas

El gráfico de Violaciones de políticas muestra el número de llamadas a la API que fallaron debido a violaciones de reglas de acceso a lo largo del tiempo.

Las violaciones de políticas se categorizan según el tipo de fallo:

• Autenticación fallida (401): Llamadas a la API que recibieron el código de estado HTTP 401 (Unauthorized), indicando que la solicitud carecía de credenciales de autenticación válidas.
• Violación del límite de tasa (429): Llamadas a la API que recibieron el código de estado HTTP 429 (Too Many Requests), indicando que se superó el umbral del límite de tasa.

Solo las categorías con datos registrados para el período de tiempo seleccionado aparecen en el gráfico. Si no ha habido violaciones de políticas durante el período de tiempo seleccionado, se muestra el mensaje "No se encontraron datos."

Pasa el cursor sobre cualquier punto de datos para mostrar un tooltip que indique la fecha y el número de violaciones para esa categoría en ese momento.

Perspectivas a nivel de método

El gráfico de Perspectivas a nivel de método muestra la descomposición de las llamadas a la API por método HTTP (GET, POST, PUT o DELETE) a lo largo del tiempo.

El gráfico muestra cada método HTTP con un color diferente en la leyenda. Esto permite analizar qué métodos se utilizan con mayor frecuencia para acceder a las APIs.

Pasa el cursor sobre cualquier punto de datos para mostrar el número de llamadas para ese método durante el período de tiempo.

Consumidores de API

Consumidores de API es una sección colapsable que muestra métricas de consumo para las APIs en tu organización. La sección incluye dos gráficos: Aplicaciones y Direcciones IP.

Aplicaciones

El gráfico de Aplicaciones muestra los principales consumidores de API (aplicaciones) por volumen de llamadas dentro del período seleccionado.

Utiliza el menú desplegable para seleccionar el número de aplicaciones a mostrar. Las opciones incluyen Las 5 principales aplicaciones, Las 10 principales aplicaciones, Las 25 principales aplicaciones y Todas las aplicaciones.

El gráfico muestra un gráfico de barras que indica el volumen relativo de llamadas para cada aplicación. Pasa el cursor sobre cualquier barra para mostrar el número exacto de llamadas y el nombre de la aplicación.

Direcciones IP

El gráfico de Direcciones IP muestra las principales direcciones IP por volumen de llamadas dentro del período seleccionado.

Utiliza el menú desplegable para seleccionar el número de direcciones IP a mostrar. Las opciones incluyen Las 5 principales direcciones IP, Las 10 principales direcciones IP, Las 25 principales direcciones IP y Todas las direcciones IP.

El gráfico muestra un gráfico de barras que indica el volumen de llamadas relativo para cada dirección IP. Pasa el cursor sobre cualquier barra para mostrar el número exacto de llamadas y la dirección IP.