Sua API é realmente em tempo real? Teste a latência dela com a ferramenta rtapi da NGINX

Alessandro Fael GarciaEngenheiro de Marketing Técnico

[Editor – Esta publicação foi atualizada com informações sobre os relatórios revisados introduzidos no rtapi versão 0.2.0.]

As APIs estão no centro das aplicações modernas e das arquiteturas digitais em constante evolução, e as chamadas de API representam 83% de todo o tráfego da Web, de acordo com o Relatório sobre o Estado da Segurança da Internet da Akamai. No cenário atual, em que é tão fácil para os consumidores migrarem para um concorrente digital, é fundamental que eles tenham uma experiência positiva com seu site ou aplicativo. A velocidade é muito valorizada e, em última análise, depende de APIs responsivas, robustas e adaptáveis. Se você fizer isso direito — ou seja, se sua API for mais rápida que a do concorrente — os desenvolvedores escolherão você.

De acordo com o relatório da IDC APIs — Os fatores determinantes para o sucesso ou o fracasso dos negócios digitais, mais de 90% das organizações esperam uma latência inferior a 50 milissegundos (ms), enquanto quase 60% esperam uma latência de 20 ms ou menos. (A latência é definida como o tempo que a infraestrutura da sua API leva para responder a uma chamada de API — desde o momento em que uma solicitação chega ao gateway de API até o retorno do primeiro byte da resposta ao cliente.)

Usamos esses dados, juntamente com uma análise de ponta a ponta do ciclo de vida das APIs, para definir uma API em tempo real como aquela que apresenta latência de 30 ms ou menos. Além disso, o limite de latência de 30 ms deve ser mantido até o 99º percentil das solicitações processadas (o que significa que, em média, apenas 1 em cada 100 solicitações leva mais de 30 ms). Para obter detalhes, consulte nosso blog sobre benchmarking de desempenho de soluções de gerenciamento de APIs.

Para a maioria das empresas, processar chamadas de API o mais próximo possível do tempo real é um grande desafio, especialmente quando gateways de API com arquiteturas complexas são usados como pontos de entrada para os endpoints das APIs. Então, qual é o desempenho das suas APIs? Elas já são rápidas o suficiente para serem consideradas em tempo real ou precisam melhorar? Seu produto parece um pouco lento, mas você não consegue identificar exatamente o motivo? Talvez você não saiba ao certo qual é a latência das suas APIs?

Conheça o rtapi – uma ferramenta de benchmarking de latência de APIs em tempo real criada pela NGINX, que testa a capacidade de resposta dos seus gateways e endpoints de API e gera relatórios que você pode distribuir e compartilhar facilmente com seus colegas. Há dois formatos de relatório disponíveis: um PDF com um gráfico resumido e uma tabela de métricas detalhadas formatada em ASCII.

Executando rtapi

1. Baixe o binário rtapi do GitHub usando um destes dois métodos:
   • Se você tiver o Golang instalado, execute este comando:

$ go get github.com/nginxinc/rtapi

• Se você não tiver o Golang instalado, acesse github.com/nginxinc/rtapi/releases, baixe o arquivo binário para sua plataforma e torne-o executável.

1. Especifique um ou mais endpoints de API (destinos) que você deseja consultar, no formato JSON ou YAML, como nos exemplos a seguir. Recomendamos salvar o JSON ou YAML em um arquivo chamado endpoints.json ou endpoints.yml. (No caso de JSON, você também pode incluir os dados na linha de comando do rtapi na próxima etapa, como parâmetro da opção --data.) Os únicos parâmetros obrigatórios para cada endpoint são target.url e target.method. Se você não especificar target.body e target.header, eles permanecerão vazios. Se você não especificar um parâmetro no objeto query_parameters, o rtapi usará o valor (padrão) mostrado para ele nos exemplos a seguir. Exemplo de entrada JSON

[
  {
    "target": {
      "url": "https://www.example.com",
      "method": "POST",
      "body": "{\"id\":\"0\"}",
      "header": {
        "Content-Type": [
          "application/json"
        ]
      }
    },
    "query_parameters": {
      "threads": 2,
      "max_threads": 2,
      "connections": 10,
      "duration": "10s",
      "request_rate": 500
    }
  }
]

1. Exemplo de entrada YAML

- target:    url: https://example.com/api/id
    method: POST
    body: '{"id":"0"}'
    header:
      Content-Type:
        - application/json
  query_parameters:
    threads: 2
    max_threads: 2
    connections: 12
    duration: 10s
    request_rate: 500

1. Execute o comando a seguir, em que --file especifica o arquivo que contém a lista de endpoints de API formatada em JSON/YAML e --output especifica o relatório em PDF a ser gerado pelo rtapi. (Conforme observado na Etapa 2, você pode fornecer a entrada JSON na linha de comando: substitua --file endpoints.json por --data seguido da string JSON.)

$ rtapi --file endpoints.json --output report.pdf

1. Para exibir a tabela de métricas formatada em ASCII no terminal, inclua a opção --print em vez da opção --output (ou além dela).

$ rtapi --file endpoints.json --print

Interpretando o relatório em PDF

O relatório em PDF gerado pelo rtapi contém um histograma HDR da latência de resposta semelhante ao apresentado a seguir (de um gateway de API NGINX Plus configurado usando o Módulo de Gerenciamento de APIs do NGINX Controller). O eixo Y mostra a latência em milissegundos, e o eixo X mostra a proporção de chamadas processadas em menos de uma determinada latência, expressa como percentil. (No exemplo a seguir, comprimimos o eixo Y para economizar espaço.)

Para destacar os resultados da sua API, as linhas tracejadas paralelas aos eixos se cruzam para mostrar a latência medida da sua API no 99º percentil (99% no gráfico). Para que sua API seja considerada em tempo real, a latência no ponto de interseção deve ser inferior a 30 ms.

Como o NGINX pode ajudar?

A latência da sua API é inferior a 30 ms?

Se a sua empresa for como muitas das empresas com as quais conversamos, provavelmente não. Com muitas soluções de gateway de API e gerenciamento de APIs, uma latência de 100 ms é comum, e até mesmo 500 ms não é tão incomum.

Podemos ajudar você a melhorar o desempenho das suas APIs – o NGINX e o NGINX Plus são o gateway de API mais rápido do setor e, em conjunto com o NGINX Controller, podem ajudar você a rotear, autenticar, proteger, controlar e armazenar em cache chamadas de API em menos de 30 ms. Saiba mais, fale com um especialista em NGINX e descubra como o NGINX pode ajudar você em sua jornada rumo a APIs em tempo real em nginx.com/real-time-api.

Sobre o autor

Alessandro Fael GarciaEngenheiro de Marketing Técnico

Mais publicações de Alessandro Fael Garcia