12 métricas de monitoramento para garantir que sua estratégia de API seja bem-sucedida

A equipe da comunidade de código aberto da China fez sua primeira transmissão ao vivo, contando a história por trás da comunidade de código aberto da China em nome do compartilhamento."

Autor original: Andrew Stiefel da F5

Link original: 12 indicadores de monitoramento para garantir uma estratégia de API bem-sucedida

Fonte de reimpressão: comunidade de código aberto NGINX

A única comunidade chinesa oficial do NGINX, toda em nginx.org.cn

À 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 tornou-se imperativo. Construir uma estrutura que defina claramente as métricas da API e as vincule 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 intimamente ligados a objetivos específicos. Eles têm prazos claros e correspondem ao que a estratégia de API precisa entregar. Por outro lado, as métricas da API são pontos de dados importantes. Nem todas as métricas são KPIs, mas todo KPI é baseado em métricas.

Então, como você deve fazer isso? Primeiro, você precisa esclarecer o objetivo da sua estratégia de API desde o início e, em seguida, escolher as métricas que correspondem a esse objetivo. Lembre-se de que cada equipe precisa medir e acompanhar diferentes métricas com base no que é importante para ela e necessário para o negócio.

Em termos gerais, existem três grandes categorias de métricas de API que as empresas podem acompanhar, e diferentes categorias de métricas refletem diferentes questões:

Métricas operacionais – A API fornece a estabilidade, a confiabilidade e o desempenho que você precisa?
Métricas de adoção – Os desenvolvedores estão adotando sua API?
Métricas do produto – Como a API está apoiando seus objetivos de negócios?

Você pode pensar nessas três grandes categorias de indicadores como uma pirâmide. As métricas operacionais na parte inferior medem o desempenho tático de APIs individuais e sua infraestrutura de suporte. As principais métricas do produto medem o valor comercial criado pela API. Os dois estão interligados por meio de métricas de adoção, que acompanham o crescimento dos programas de API entre os usuários finais (desenvolvedores). De modo geral, as métricas de produto e de adoção estão relacionadas aos resultados de negócios que você precisa medir, enquanto as métricas operacionais estão relacionadas aos padrões técnicos que você precisa manter.

Este artigo detalha 12 métricas específicas que devem ser medidas, descreve como elas dão suporte às equipes de infraestrutura e aplicativos e explica como essas métricas se relacionam com os KPIs.

Indicadores de operação e manutenção

Nos estágios iniciais, as métricas operacionais são frequentemente as primeiras métricas a serem medidas. São métricas táticas que fornecem informações sobre o desempenho de sua API. Os indicadores operacionais geralmente não são KPIs. Mas eles podem ajudá-lo a medir a qualidade e o desempenho do software que sua equipe cria e fornecer indicadores antecipados de novos problemas, ou ajudá-lo a detalhar e descobrir problemas que podem impactar os principais KPIs.

Você pode acompanhar diferentes métricas operacionais com base na equipe e na responsabilidade.

Equipe de infraestrutura

A equipe de Operações da Plataforma mantém, conecta e protege a infraestrutura e o portfólio de tecnologia usados por diferentes equipes para entregar aplicativos. No caso de programas de API, isso normalmente inclui gateways de API e portais de desenvolvedores de API.

As principais métricas para equipes de infraestrutura, como operações de plataforma, incluem:

Tempo de atividade – Mesmo sendo uma das métricas mais básicas, o tempo de atividade é o padrão ouro para medir a disponibilidade do serviço. Muitas vezes está associado a um Acordo de Nível de Serviço (SLA).
Uso de CPU e memória – Rastrear o uso de recursos do seu API Gateway é fundamental para determinar quando você pode precisar ampliar sua instância. Também pode servir como um indicador de alerta precoce de uma falha iminente ou de um aumento no uso devido a erros.
Taxas gerais de aprovação e erro - Medir a frequência com que uma API aciona um código de status de erro HTTP (não 200) pode ajudar você a entender o quão propensa a erros sua API é. Essa métrica composta fornece informações que ajudam você a avaliar a qualidade geral das APIs que sua equipe coloca em produção.

equipe de aplicação

A equipe de aplicativos consiste em desenvolvedores de API e proprietários de serviços, responsáveis por construir e operar cada serviço ou aplicativo. Esses serviços ou aplicativos podem ser usados como parte de um produto maior, integrados a produtos de parceiros ou usados para fornecer APIs como um serviço aos desenvolvedores.

As equipes de aplicação precisam medir as seguintes métricas:

Solicitações por minuto – Esta métrica de desempenho mede o número de solicitações que sua API processa por minuto. Embora isso mude com o tempo, geralmente você deseja limitar o número de solicitações por minuto para garantir a melhor experiência para os usuários da API.
Latência Média e Máxima – É fundamental monitorar o tempo médio que leva para sua API receber uma solicitação e retornar uma resposta. APIs lentas podem ter um impacto negativo na experiência do usuário, o que pode afetar negativamente seus negócios.
Erros por minuto - A verdade geralmente é a mesma: não existe uma API perfeita. Os erros são inevitáveis, mais cedo ou mais tarde. Você precisa monitorar os erros e implementar um curso de ação bem planejado para corrigi-los o mais rápido possível, antes que aumentem repentinamente.

Consulte os capítulos 3 a 5 do e-book O'Reilly Mastering API Architecture by NGINX para uma compreensão mais profunda das operações de API e dos KPIs e métricas que são essenciais para o seu negócio.

métricas de adoção

As empresas que priorizam APIs devem olhar além das métricas de engenharia para 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 sua API e obtendo valor com ela.

Aqui estão alguns exemplos de uso de indicadores:

Consumidores exclusivos de API – Essa métrica normalmente mede quantos desenvolvedores estão usando sua API por meio do número de usuários ativos mensais. Idealmente, essa métrica crescerá à medida que mais desenvolvedores integrarem sua API em seus aplicativos.
Crescimento do uso de API – Essa métrica também mede a adoção de API e costuma ser a métrica preferida para medir a adoção de API. Idealmente, o tráfego da API crescerá mês a mês à medida que mais aplicativos e desenvolvedores usarem a API.
Tempo até a primeira chamada – esta métrica mede o tempo que um desenvolvedor leva para criar uma conta, gerar credenciais de API e executar a primeira chamada de API. Colocar os desenvolvedores em funcionamento o mais rápido possível é uma alta prioridade, portanto, essa métrica é a métrica mais importante para a experiência geral do desenvolvedor de API.

Observação: recomendamos ter pelo menos um KPI que mede a adoção de API. Isso ajuda você a estimar o crescimento geral do seu programa de API. Por exemplo, você pode configurar um KPI para acompanhar o crescimento no número de desenvolvedores que usam sua API para criar integrações ou aplicativos contínuos.

Indicadores de produto

As métricas do produto API desempenham um papel importante para ajudar a compreender o valor da sua API. Embora apenas um pequeno subconjunto de APIs possa trazer uma contribuição direta para a receita, cada API precisa criar valor para o negócio.

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

Receita direta e indireta – Essas métricas medem as diferentes maneiras pelas quais as APIs contribuem para a receita. Algumas dessas APIs são monetizáveis diretamente, outras oferecem suporte à integração com produtos de parceiros de negócios ou integrações de terceiros que são essenciais para os clientes. Assim como o rastreamento da adoção de APIs, o rastreamento da receita indireta ajuda os desenvolvedores a criar aplicativos geradores de receita para parceiros.
Número de aplicativos por API – as APIs precisam ser reutilizáveis. Essa métrica mede quantos aplicativos estão integrados à API para entender quais APIs criam mais valor.
Número de parceiros – as APIs geralmente permitem a construção de relacionamentos comerciais. Acompanhar o número de integrações de API de um parceiro pode ajudar a impulsionar a adoção e demonstrar valor para outras unidades de negócios.

Observação: esses indicadores de produto estão intimamente relacionados ao impacto nos negócios. Você pode optar por converter alguns indicadores de produtos em KPIs com base em suas metas de negócios. Por exemplo, se o objetivo comercial da sua estratégia de API for alcançar mais clientes por meio de um provedor terceirizado, você poderá acompanhar o número de parceiros que usam sua API e a receita indireta gerada por meio dessas integrações.

Consulte os capítulos 3 a 5 de "Dominando a arquitetura de API" para uma compreensão mais profunda do ciclo de vida dos produtos de API, incluindo KPIs de negócios e operação.

Conclusão

Correlacionar métricas de API com KPIs de negócios é uma das principais maneiras pelas quais as empresas podem tomar decisões baseadas em dados e garantir que sua estratégia de API forneça o valor de que precisam. Além disso, permitir a visibilidade da API ajuda as equipes de infraestrutura e aplicativos a medir as métricas operacionais mais importantes para cada uma.

O NGINX permite a visualização de dezenas de indicadores API importantes. 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 (ou APM) ou análise de dados.

A única comunidade chinesa oficial do NGINX, toda em nginx.org.cn

Mais informações técnicas relacionadas ao NGINX, perguntas e respostas interativas, série de cursos e recursos para eventos: Site oficial da comunidade de código aberto | Conta oficial do WeChat |