Quais 12 métricas monitorar para uma estratégia de API bem-sucedida

À medida que as empresas adotam práticas de design que priorizam APIs para criar aplicativos modernos, medir o desempenho operacional e o valor dessas APIs se torna uma prioridade máxima. Estabelecer uma estrutura que defina e conecte claramente as métricas de API com os 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 metas específicas. Eles têm um prazo definido e estão alinhados aos resultados que sua estratégia de API precisa entregar. As métricas de API, por outro lado, são pontos de dados significativos. Nem toda métrica é um KPI, mas todo KPI começa como uma métrica.

Então, como você começa? Primeiro, você precisa ter clareza – desde o início – sobre o objetivo da sua estratégia de API e, então, escolher as métricas que se alinham com esse objetivo. Lembre-se de que cada equipe precisa medir e monitorar métricas diferentes, dependendo do que é importante para ela e do que é essencial para o negócio.

Em termos gerais, existem três tipos abrangentes de métricas de API que as empresas podem monitorar, e cada tipo responde a uma pergunta diferente:

• Métricas operacionais – As APIs estão fornecendo a estabilidade, confiabilidade e 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 apoiando seus objetivos de negócios?

Imagine essas métricas abrangentes como uma pirâmide. Na parte inferior, as métricas operacionais medem o desempenho tático de APIs individuais e da infraestrutura que as suporta. Na parte superior, as métricas do produto medem o valor comercial criado pelas suas APIs. Os dois estão conectados por métricas de adoção, que rastreiam o crescimento do programa de API com usuários finais (desenvolvedores). Geralmente, as métricas de produto e de adoção se alinham aos resultados comerciais que você precisa medir, enquanto as métricas operacionais se alinham aos padrões técnicos que você precisa manter.

Nesta publicação, detalhamos 12 métricas específicas que são essenciais para medir, discutimos como elas capacitam equipes de infraestrutura e aplicativos e explicamos as maneiras como as métricas se relacionam com os KPIs.

Métricas Operacionais

Quando você está apenas começando, as métricas operacionais geralmente são a primeira coisa a ser medida. Eles são táticos e fornecem insights sobre como as APIs estão funcionando. Métricas operacionais geralmente não são KPIs em si. Em vez disso, eles ajudam você a medir a qualidade e o desempenho do software que suas equipes estão criando. Eles podem fornecer indicadores iniciais de problemas emergentes ou ajudar você a se aprofundar e descobrir problemas que podem estar afetando seus KPIs críticos.

As métricas operacionais que você monitora variam de acordo com a equipe e a responsabilidade.

Equipes de Infraestrutura

Platform Ops é a equipe responsável por manter, conectar e proteger o conjunto de infraestrutura e tecnologias usadas por diferentes equipes para entregar aplicativos. Para programas de API, isso geralmente inclui gateways de API e portais de desenvolvedores de API.

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 ouro para medir a disponibilidade de um serviço. Isso geralmente está vinculado a um acordo de nível de serviço (SLA).
2. Uso de CPU e memória – Rastrear a utilização de recursos no gateway de API é essencial para identificar quando você pode precisar dimensionar suas instâncias. Ele também funciona como um alerta precoce quando algo está começando a quebrar ou o uso está aumentando devido a erros.
3. Taxas totais de aprovação e erro – Medindo a frequência com que as APIs acionam erros HTTP (não200 ) códigos de status ajudam você a entender o quão propensas a erros suas APIs podem ser. Essa medida agregada fornece informações para ajudar a avaliar a qualidade geral das APIs que suas equipes estão colocando em produção.

Equipes de Aplicação

As equipes de aplicativos, compostas por desenvolvedores de API e proprietários de serviços, são responsáveis por criar e operar serviços ou aplicativos individuais. Eles podem ser usados como parte de um produto maior, para integração com um parceiro ou ao fornecer APIs como um serviço para desenvolvedores.

As seguintes métricas são importantes para as equipes de aplicativos avaliarem:

4. Solicitações por minuto – Esta métrica de desempenho mede o número de solicitações que sua API está manipulando. Embora varie ao longo do tempo, normalmente você deseja gerenciá-lo de forma descendente para garantir a melhor experiência para os usuários da API.
5. Latência média e máxima – É crucial monitorar o tempo médio que sua API leva para receber uma solicitação e retornar uma resposta. Uma única API lenta pode impactar negativamente a experiência do usuário e, portanto, impactar negativamente o negócio.
6. Erros por minuto – Como tudo, nenhuma API é perfeita. Os fracassos são uma questão de quando, não se. Você precisa monitorar os erros e ter um plano de ação para corrigi-los antes que eles comecem a aparecer de repente.

Aprofunde-se nas operações de API e aprenda quais KPIs e métricas são essenciais de uma perspectiva de negócios nos capítulos 3 a 5 do e-book Mastering API Architecture da O'Reilly, cortesia da NGINX.

Métricas de adoção

Para um negócio que prioriza APIs, é essencial olhar 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 de API para garantir que os desenvolvedores estejam adotando e obtendo valor de suas APIs.

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

7. Consumidores exclusivos de API – Muitas vezes limitados ao tempo em usuários mensais, essa métrica mede quantos desenvolvedores estão adotando e usando suas APIs. O ideal é que essa métrica cresça com o tempo, à medida que mais desenvolvedores integram sua API em seus aplicativos.
8. Crescimento do uso da API – Esta métrica também mede a adoção da API e geralmente é a métrica preferida para isso. O ideal é que o tráfego da API cresça mensalmente à medida que o número de aplicativos e desenvolvedores que os utilizam também aumenta.
9. Tempo para a primeira chamada – Esta métrica mede quanto tempo leva para um desenvolvedor 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 alta prioridade, tornando essa métrica a mais importante para medir a experiência geral do desenvolvedor de API.

Observação:  Recomendamos que pelo menos um dos seus KPIs busque 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 ou aplicativo contínuo usando sua API.

Métricas do produto

Métricas de produtos de API desempenham um papel importante na compreensão do valor de uma API. Embora apenas um pequeno subconjunto de APIs possa contribuir diretamente para a receita, cada API precisa fornecer valor ao negócio.

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

10. Receita direta e indireta – Essas métricas têm como alvo as diferentes maneiras pelas quais as APIs contribuem para a receita. Enquanto algumas APIs são monetizadas diretamente, outras oferecem suporte a integrações com parceiros de negócios ou são integrações de terceiros valorizadas pelos clientes. Assim como acontece com a taxa de adoção de suas APIs, o rastreamento da receita indireta ajuda os desenvolvedores a criar aplicativos geradores de receita para parceiros.
11. Aplicações por API – As APIs precisam ser reutilizáveis. Esta métrica mede quantos aplicativos se integram a uma API para ver quais APIs fornecem mais valor.
12. Número de parceiros – As APIs geralmente permitem relacionamentos comerciais. Acompanhar o número de integrações de API de 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 intimamente alinhadas ao impacto comercial, e você pode optar por transformar algumas em KPIs, dependendo dos seus objetivos comerciais. Por exemplo, se o objetivo comercial da sua estratégia de API é alcançar mais clientes por meio de provedores terceirizados, você deseja rastrear o número de parceiros que usam suas APIs e a receita indireta gerada por meio dessas integrações.

Explore o ciclo de vida do produto de API – incluindo KPIs operacionais e de negócios – com mais detalhes nos capítulos 3 a 5 de Mastering API Architecture .

Conclusão

Alinhar métricas de API e KPIs de negócios é uma das principais maneiras de tomar decisões baseadas em dados e garantir que sua estratégia de API forneça o valor que sua organização exige. E não apenas isso: obter visibilidade sobre suas APIs também pode capacitar equipes de infraestrutura e aplicativos a medir as métricas operacionais que mais importam para elas.

Na NGINX, fornecemos visibilidade de dezenas de métricas importantes de API. Você pode visualizar métricas históricas e em tempo real e exportá-las facilmente para sua solução preferida de monitoramento de desempenho de aplicativos (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 um gateway de API e ao NGINX App Protect para proteger suas APIs.