12 métricas de monitoreo para garantizar que su estrategia API sea exitosa

El equipo de la comunidad de código abierto de China realizó su primera transmisión en vivo, contando la historia detrás de la comunidad de código abierto de China en nombre de compartir".

Autor original: Andrew Stiefel de F5

Enlace original: 12 indicadores de seguimiento para garantizar una estrategia API exitosa

Fuente de reimpresión: comunidad de código abierto NGINX

La única comunidad china oficial de NGINX, toda en nginx.org.cn

A medida que las empresas adoptan prácticas de diseño que priorizan las API para crear aplicaciones modernas, medir el rendimiento operativo y el valor de estas API se ha vuelto imperativo. Crear un marco que defina claramente las métricas de API y las vincule con indicadores clave de rendimiento (KPI) es uno de los pasos más importantes para garantizar una estrategia de API exitosa.

Normalmente, los KPI están estrechamente vinculados a objetivos específicos. Tienen plazos claros y coinciden con lo que la estrategia API debe ofrecer. Por el contrario, las métricas API son puntos de datos importantes. No todas las métricas son KPI, pero cada KPI se basa en métricas.

Entonces, ¿cómo deberías hacerlo? Primero, debe aclarar el objetivo de su estrategia API desde el principio y luego elegir las métricas que coincidan con ese objetivo. Recuerde que cada equipo necesita medir y realizar un seguimiento de diferentes métricas en función de lo que es importante para ellos y necesario para el negocio.

En términos generales, existen tres categorías amplias de métricas API que las empresas pueden rastrear, y diferentes categorías de métricas reflejan diferentes cuestiones:

Métricas operativas : ¿la API proporciona la estabilidad, la confiabilidad y el rendimiento que necesita?
Métricas de adopción : ¿los desarrolladores están adoptando su API?
Métricas del producto : ¿Cómo respalda la API sus objetivos comerciales?

Puede pensar en estas tres categorías amplias de indicadores como una pirámide. Las métricas operativas en la parte inferior miden el desempeño táctico de las API individuales y su infraestructura de soporte. Las principales métricas del producto miden el valor comercial creado por la API. Los dos están unidos a través de métricas de adopción, que rastrean el crecimiento de los programas API entre los usuarios finales (desarrolladores). En términos generales, las métricas de productos y las métricas de adopción se relacionan con los resultados comerciales que necesita medir, mientras que las métricas operativas se relacionan con los estándares técnicos que necesita mantener.

Este artículo desglosa 12 métricas específicas que deben medirse, describe cómo respaldan a los equipos de infraestructura y aplicaciones, y explica cómo estas métricas se relacionan con los KPI.

Indicadores de operación y mantenimiento.

En las etapas iniciales, las métricas operativas suelen ser las primeras métricas que se miden. Son métricas tácticas que brindan información sobre el rendimiento de su API. Los indicadores operativos no suelen ser KPI. Pero pueden ayudarle a medir la calidad y el rendimiento del software que crea su equipo y proporcionar indicadores tempranos de nuevos problemas, o ayudarle a profundizar y descubrir problemas que pueden afectar los KPI clave.

Puede realizar un seguimiento de diferentes métricas operativas según el equipo y la responsabilidad.

equipo de infraestructura

El equipo de Operaciones de plataforma mantiene, conecta y protege la cartera de infraestructura y tecnología utilizada por diferentes equipos para entregar aplicaciones. En el caso de los programas API, esto normalmente incluye puertas de enlace API y portales de desarrolladores API.

Las métricas clave para los equipos de infraestructura, como las operaciones de plataforma, incluyen:

Tiempo de actividad : incluso una de las métricas más básicas, el tiempo de actividad es el estándar de oro para medir la disponibilidad del servicio. A menudo está asociado con un Acuerdo de Nivel de Servicio (SLA).
Uso de CPU y memoria : el seguimiento del uso de recursos de su API Gateway es fundamental para determinar cuándo es posible que necesite ampliar su instancia. También puede servir como indicador de alerta temprana de una falla inminente o un aumento en el uso debido a errores.
Tasas generales de aprobación y error : medir la frecuencia con la que una API activa un código de estado de error HTTP (no 200) puede ayudarle a comprender cuán propensa a errores es su API. Esta métrica compuesta proporciona información que le ayuda a juzgar la calidad general de las API que su equipo pone en producción.

equipo de aplicación

El equipo de aplicaciones está formado por desarrolladores de API y propietarios de servicios, que son responsables de crear y operar cada servicio o aplicación. Estos servicios o aplicaciones pueden usarse como parte de un producto más grande, integrarse con productos de socios o usarse para proporcionar API como un servicio a los desarrolladores.

Los equipos de aplicaciones deben medir las siguientes métricas:

Solicitudes por minuto : esta métrica de rendimiento mide la cantidad de solicitudes que su API maneja por minuto. Si bien cambia con el tiempo, generalmente desea limitar la cantidad de solicitudes por minuto para garantizar la mejor experiencia para los usuarios de su API.
Latencia promedio y máxima : es fundamental realizar un seguimiento del tiempo promedio que tarda su API en recibir una solicitud y devolver una respuesta. Las API lentas pueden tener un impacto negativo en la experiencia del usuario, lo que puede afectar negativamente a su negocio.
Errores por minuto : la verdad suele ser la misma: no existe una API perfecta. Los errores son inevitables, tarde o temprano. Debe monitorear los errores e implementar un curso de acción bien planificado para solucionarlos lo más rápido posible antes de que se agraven repentinamente.

Consulte los capítulos 3 a 5 del libro electrónico de O'Reilly Mastering API Architecture de NGINX para obtener una comprensión más profunda de las operaciones de API y los KPI y métricas que son fundamentales para su negocio.

métricas de adopción

Las empresas que priorizan las API deben mirar más allá de las métricas de ingeniería para comprender cómo interactúan los desarrolladores con sus API. También debe medir y monitorear la experiencia de los desarrolladores de API para garantizar que los desarrolladores adopten su API y obtengan valor de ella.

A continuación se muestran algunos ejemplos del uso de indicadores:

Consumidores de API únicos : esta métrica generalmente mide cuántos desarrolladores están usando su API a través de la cantidad de usuarios activos mensuales. Idealmente, esta métrica crecerá a medida que más desarrolladores integren su API en sus aplicaciones.
Crecimiento del uso de API : esta métrica también mide la adopción de API y, a menudo, es la métrica preferida para medir la adopción de API. Idealmente, el tráfico de API crecerá mes a mes a medida que más aplicaciones y desarrolladores utilicen la API.
Tiempo hasta la primera llamada : esta métrica mide el tiempo que le toma a un desarrollador crear una cuenta, generar credenciales API y ejecutar la primera llamada API. Lograr que los desarrolladores estén en funcionamiento lo más rápido posible es una alta prioridad, por lo que esta métrica es la métrica más importante para la experiencia general del desarrollador de API.

Nota: Recomendamos tener al menos un KPI que mida la adopción de API. Esto le ayuda a estimar el crecimiento general de su programa API. Por ejemplo, puede configurar un KPI para realizar un seguimiento del crecimiento en la cantidad de desarrolladores que utilizan su API para crear integraciones o aplicaciones continuas.

Indicadores de producto

Las métricas de productos API desempeñan un papel importante para ayudar a comprender el valor de su API. Si bien solo un pequeño subconjunto de API puede generar una contribución directa a los ingresos, cada API debe crear valor para el negocio.

Las métricas clave del producto a medir incluyen:

Ingresos directos e indirectos : estas métricas miden las diferentes formas en que las API contribuyen a los ingresos. Algunas de estas API se pueden monetizar directamente, otras admiten la integración con productos de socios comerciales o integraciones de terceros que son fundamentales para los clientes. Al igual que el seguimiento de la adopción de API, el seguimiento de los ingresos indirectos ayuda a los desarrolladores a crear aplicaciones que generen ingresos para los socios.
Número de aplicaciones por API : las API deben ser reutilizables. Esta métrica mide cuántas aplicaciones están integradas con la API para comprender qué API crean el mayor valor.
Número de socios : las API a menudo permiten establecer relaciones comerciales. El seguimiento del número de integraciones de API de un socio puede ayudar a impulsar la adopción y demostrar valor a otras unidades de negocio.

Nota: Estos indicadores de producto están estrechamente relacionados con el impacto comercial. Puede optar por convertir algunos indicadores de producto en KPI según sus objetivos comerciales. Por ejemplo, si el objetivo comercial de su estrategia API es llegar a más clientes a través de un proveedor externo, puede realizar un seguimiento de la cantidad de socios que utilizan su API y los ingresos indirectos generados a través de estas integraciones.

Consulte los Capítulos 3 a 5 de "Dominar la arquitectura API" para obtener una comprensión más profunda del ciclo de vida de los productos API, incluidos los KPI comerciales y operativos.

Conclusión

Correlacionar las métricas de API con los KPI comerciales es una de las principales formas en que las empresas pueden tomar decisiones basadas en datos y garantizar que su estrategia de API brinde el valor que necesitan. Además, habilitar la visibilidad de API ayuda a los equipos de infraestructura y aplicaciones a medir las métricas operativas que más les importan a cada uno.

NGINX permite la visualización de docenas de indicadores API importantes. Puede ver métricas históricas y en tiempo real y exportarlas fácilmente a su solución de análisis de datos o monitoreo del rendimiento de aplicaciones (o APM) preferida.

La única comunidad china oficial de NGINX, toda en nginx.org.cn

Más información técnica relacionada con NGINX, preguntas y respuestas interactivas, series de cursos y recursos para eventos: Sitio web oficial de la comunidad de código abierto | Cuenta oficial de WeChat