Quais são as 12 métricas que devem ser monitoradas para uma estratégia de API bem-sucedida

Andrew Stiefel

À medida que as empresas adotam práticas de design API-first para criar aplicações modernas, medir o desempenho operacional e o valor dessas APIs se torna uma prioridade. Estabelecer uma estrutura que defina claramente e conecte as métricas de API aos principais indicadores de desempenho (KPIs) é uma das etapas mais importantes para garantir uma estratégia de API bem-sucedida.

Normalmente, os KPIs estão vinculados a objetivos específicos. Eles têm um prazo definido e estão alinhados aos resultados que sua estratégia de API precisa alcançar. Já as métricas de API são pontos de dados relevantes. Nem toda métrica é um KPI, mas todo KPI começa como uma métrica.

Então, por onde começar? Primeiro, você precisa definir claramente, desde o início, o objetivo da sua estratégia de API e, em seguida, escolher as métricas alinhadas a esse objetivo. Lembre-se de que cada equipe precisa medir e acompanhar métricas diferentes, dependendo do que é importante para ela e do que é essencial para o negócio.

De modo geral, há três grandes tipos de métricas de API que as empresas podem acompanhar, e cada tipo responde a uma pergunta diferente:

• Métricas operacionais – As APIs estão oferecendo a estabilidade, a confiabilidade e o desempenho de que você precisa?
• Métricas de adoção – Os desenvolvedores estão adotando e usando suas APIs?
• Métricas de produto – Como as APIs estão contribuindo para seus objetivos de negócios?

Imagine essas métricas abrangentes como uma pirâmide. Na base, as métricas operacionais medem o desempenho tático de APIs individuais e da infraestrutura que lhes dá suporte. No topo, as métricas de produto medem o valor de negócio gerado por suas APIs. As duas são conectadas pelas métricas de adoção, que acompanham o crescimento do programa de APIs entre os usuários finais (desenvolvedores). Em geral, as métricas de produto e de adoção estão alinhadas aos resultados de negócio que você precisa medir, enquanto as métricas operacionais estão alinhadas aos padrões técnicos que você precisa manter.

Neste artigo, detalhamos 12 métricas específicas que são essenciais para a mensuração, discutimos como elas capacitam as equipes de infraestrutura e de aplicações e explicamos como essas métricas se relacionam com os KPIs.

Métricas operacionais

Quando você está começando, as métricas operacionais geralmente são a primeira coisa a ser medida. Elas são táticas e fornecem insights sobre o funcionamento das APIs. Em geral, as métricas operacionais não são KPIs por si só. Em vez disso, elas ajudam a medir a qualidade e o desempenho do software que suas equipes estão desenvolvendo. Elas podem fornecer indícios iniciais de problemas emergentes ou ajudar você a se aprofundar e identificar questões que possam estar afetando seus KPIs críticos.

As métricas operacionais que você acompanha variam de acordo com a equipe e as responsabilidades.

Equipes de Infraestrutura

Operações de Plataforma é a equipe responsável por manter, conectar e proteger o conjunto de infraestruturas e tecnologias usadas por diferentes equipes para disponibilizar aplicações. Em programas de APIs, isso geralmente inclui gateways de API e portais de desenvolvedores de APIs.

As principais métricas para equipes de infraestrutura, como a Platform Ops, incluem:

1. Tempo de atividade – Mesmo sendo uma das métricas mais básicas, o tempo de atividade é o padrão de referência para medir a disponibilidade de um serviço. Geralmente, ele está vinculado a um acordo de nível de serviço (SLA).
2. Uso de CPU e memória – Monitorar a utilização de recursos no gateway de API é fundamental para identificar quando pode ser necessário aumentar o número de instâncias. Isso também serve como um alerta antecipado quando algo começa a apresentar falhas ou quando o uso aumenta repentinamente devido a erros.
3. Taxas totais de sucesso e erro – Medir a frequência com que as APIs acionam códigos de status de erro HTTP (diferentes de 200) ajuda a entender o quanto suas APIs podem estar sujeitas a erros. Essa métrica agregada fornece informações que ajudam a avaliar a qualidade geral das APIs que suas equipes estão colocando em produção.

Equipes de Aplicações

As equipes de aplicações, formadas por desenvolvedores de APIs e responsáveis por serviços, são encarregadas de criar e operar serviços ou aplicações individuais. Eles podem ser usados como parte de um produto maior, para integração com um parceiro ou ao fornecer APIs como serviço para desenvolvedores.

As métricas a seguir são importantes para as equipes de aplicações monitorarem:

1. Requisições por minuto – Essa métrica de desempenho mede o número de requisições processadas pela sua API. Embora esse número varie ao longo do tempo, geralmente é recomendável mantê-lo sob controle e reduzi-lo para garantir a melhor experiência aos usuários da API.
2. Latência média e máxima – É fundamental monitorar o tempo médio que sua API leva para receber uma solicitação e retornar uma resposta. Uma única API lenta pode prejudicar a experiência do usuário e, consequentemente, os negócios.
3. Erros por minuto – Como tudo, nenhuma API é perfeita. Falhas não são uma questão de “se”, mas de “quando”. É preciso monitorar os erros e ter um plano de ação para corrigi-los antes que comecem a aumentar repentinamente.

Aprofunde-se nas operações de API e descubra quais KPIs e métricas são essenciais do ponto de vista dos negócios nos capítulos 3 a 5 do eBook Dominando a arquitetura de APIs da O’Reilly, cortesia da NGINX.

Métricas de adoção

Para uma empresa que prioriza APIs, é essencial ir além das métricas de engenharia e entender como os desenvolvedores estão interagindo com suas APIs. Você também precisa medir e monitorar a experiência do desenvolvedor com APIs para garantir que os desenvolvedores estejam adotando suas APIs e obtendo valor com elas.

Alguns exemplos de métricas de adoção incluem:

1. Consumidores únicos da API – Geralmente delimitada por um período mensal, essa métrica mede quantos desenvolvedores estão adotando e usando suas APIs. O ideal é que ela cresça ao longo do tempo, à medida que mais desenvolvedores integram sua API aos próprios aplicativos.
2. Crescimento do uso da API – Essa métrica também mede a adoção da API e costuma ser a métrica preferida para essa finalidade. O ideal é que o tráfego da API cresça mensalmente à medida que também aumenta o número de aplicações e desenvolvedores que a utilizam.
3. Tempo até a primeira chamada – Essa métrica mede quanto tempo um desenvolvedor leva para criar uma conta, gerar credenciais de API e executar a primeira chamada de API. Permitir que os desenvolvedores comecem a trabalhar o mais rápido possível é uma prioridade, o que torna essa métrica a mais importante para avaliar a experiência geral dos desenvolvedores com a API.

Observação: Recomendamos que pelo menos um dos seus KPIs tenha como objetivo medir a adoção da API. Isso ajuda a calcular o crescimento geral do seu programa de API. Por exemplo, você pode definir um KPI para aumentar o número de desenvolvedores que criaram uma integração contínua ou um aplicativo usando sua API.

Métricas do produto

As métricas de produto de APIs desempenham um papel fundamental na compreensão do valor de uma API. Embora apenas um pequeno subconjunto de APIs possa contribuir diretamente para a receita, toda API precisa gerar valor para a empresa.

As principais métricas de produto a serem medidas incluem:

1. Receita direta e indireta – Essas métricas abrangem as diferentes formas pelas quais as APIs contribuem para a receita. Enquanto algumas APIs são monetizadas diretamente, outras viabilizam integrações com parceiros de negócios ou são integrações de terceiros valorizadas pelos clientes. Assim como ocorre com a taxa de adoção das suas APIs, acompanhar a receita indireta ajuda os desenvolvedores a criar aplicativos que geram receita para os parceiros.
2. Aplicações por API – As APIs precisam ser reutilizáveis. Essa métrica mede quantas aplicações são integradas a uma API para identificar quais APIs oferecem mais valor.
3. Número de parceiros – As APIs muitas vezes viabilizam relações comerciais. Acompanhar o número de integrações de API com parceiros ajuda a impulsionar a adoção e demonstrar valor para outras unidades de negócios.

Observação: Essas métricas de produto estão estreitamente alinhadas ao impacto nos negócios, e você pode optar por transformar algumas delas em KPIs, dependendo dos seus objetivos de negócio. Por exemplo, se o objetivo de negócio da sua estratégia de APIs for alcançar mais clientes por meio de provedores terceirizados, é importante acompanhar tanto o número de parceiros que usam suas APIs quanto a receita indireta gerada por essas integrações.

Explore mais a fundo o ciclo de vida de produtos de API — incluindo KPIs de negócios e operacionais — nos capítulos 3 a 5 de Mastering API Architecture.

Conclusão

Alinhar as métricas de API aos KPIs de negócios é uma das principais maneiras de tomar decisões baseadas em dados e garantir que sua estratégia de API gere o valor de que sua organização precisa. E não é só isso: obter visibilidade sobre suas APIs também permite que as equipes de infraestrutura e aplicações meçam as métricas operacionais mais relevantes para elas.

Na NGINX, oferecemos visibilidade de dezenas de métricas importantes de API. Você pode visualizar métricas históricas e em tempo real, além de exportá-las facilmente para sua solução preferida de monitoramento de desempenho de aplicações (APM) ou análise de dados.

Comece hoje mesmo com uma avaliação gratuita de 30 dias do NGINX Management Suite, que inclui acesso ao API Connectivity Manager, ao NGINX Plus como gateway de API e ao NGINX App Protect para proteger suas APIs.

Sobre o autor

Andrew Stiefel

Mais publicações de Andrew Stiefel