smart-doc é uma ferramenta para gerar automaticamente API Java documentação. Ele cria documentação analisando interfaces e comentários no código-fonte e suporta uma variedade de formatos de saída de documentos, incluindo Markdown , HTML5 , OpenAPI 3.0 e muito mais. O objetivo do design do smart-doc é simplificar o processo de redação de documentos, melhorar a eficiência do desenvolvimento e garantir a precisão e pontualidade da documentação.

No ciclo de vida de desenvolvimento de software, a geração automática de documentação de API e o teste de desempenho de interfaces são etapas fundamentais para melhorar a eficiência do desenvolvimento e garantir a qualidade do produto. Com a adição da capacidade de gerar JMeter teste de performance scripts no smart-doc versão 3.0.1 , os desenvolvedores podem realizar essas duas tarefas de maneira mais conveniente.

Este artigo apresentará como usar o smart-doc e o JMeter para testes de desempenho eficazes.

Gerar scripts JMeter

Usando smart-doc para gerar JMeter os scripts de teste de desempenho podem reduzir significativamente o tempo necessário para escrever scripts de teste de desempenho, melhorando assim a eficiência do teste. Os scripts JMeter gerados automaticamente pelo smart-doc podem ser executados diretamente no JMeter sem a necessidade de configuração e depuração complexas, tornando os testes de desempenho muito mais simples e rápidos.

Primeiro, certifique-se de que o smart-doc-maven-plugin foi adicionado ao seu projeto. Em seguida, configure os parâmetros relevantes do plugin smart-doc no arquivo pom.xml do projeto, por exemplo:

 <plugin> <groupId>com.ly.smart-doc</groupId> <artifactId>smart-doc-maven-plugin</artifactId> <version>[latest version]</version> <configuration> <configFile>./src/main/resources/smart-doc.json</configFile> <projectName>${project.description}</projectName> </configuration> </plugin>

Execute o comando mvn -Dfile.encoding=UTF-8 smart-doc:jmeter . O Smart-doc verificará o código-fonte do projeto, extrairá informações de anotação e gerará automaticamente os scripts de teste de desempenho JMeter correspondentes.

Aqueles que não estão familiarizados com seu uso podem consultar o oficial documentação do smart-doc .

Importar para JMeter

Abra o JMeter, clique em " Arquivo " -> " Abrir ", selecione o arquivo de script JMeter gerado na primeira etapa e clique no botão " Iniciar ". O JMeter começará então a realizar testes de desempenho de acordo com o script.

Configurar o Prometheus

Prometeu é uma ferramenta de monitoramento e alerta de código aberto para lidar com dados de séries temporais. Podemos usá-lo para realizar monitoramento em tempo real durante o processo de teste de estresse do JMeter, melhorando assim a observabilidade dos testes de desempenho.

Etapa 1: Instale o plug-in JMeter Prometheus

Primeiro, você precisa instalar o plugin Prometheus no diretório lib/ext do JMeter. Você pode baixar o plugin do JMeter Plugins Manager ou do website oficial . Também pode ser baixado em GitHub . Para este caso, baixe a versão mais recente 0.7.1 do GitHub.

• Nota: O endereço IP de escuta padrão do JMeter é 127.0.0.1 , o que, por padrão, impedirá que o Prometheus se conecte à porta de escuta do JMeter Prometheus. Portanto, é necessário adicionar prometheus.ip=0.0.0.0 em jmeter.properties .

Etapa 2: adicionar ouvinte do Prometheus

Abra o JMeter e adicione o Prometheus Listener ao seu plano de teste. Isso pode ser feito clicando com o botão direito em Test Plan -> Add -> Listener -> Prometheus Listener .

A configuração do ouvinte pode referir-se às configurações oficiais, com referência a seguir ( smart-doc 3.0.4 suporta configuração e adição de geração de ouvinte Prometheus):

Etapa 3: configurar o Prometheus Scrape

No arquivo de configuração do Prometheus ( prometheus.yml ), adicione um novo scrape_config para buscar dados do plugin JMeter Prometheus. Por exemplo:

 scrape_configs: - job_name: 'jmeter' scrape_interval: 15s static_configs: - targets: ['<Your JMeter machine IP>:9270']

Aqui, <Your JMeter machine IP> é o endereço IP da máquina que executa o teste JMeter e 9270 é a porta de escuta padrão para o plug-in JMeter Prometheus.

Etapa 4: execute o plano de teste

Para facilitar a verificação neste artigo, o grupo de threads é definido como " loop infinito " durante o teste de estresse, que pode ser ajustado de acordo com as necessidades reais.

Após iniciar com sucesso, o JMeter Prometheus irá, por padrão, criar um serviço na porta local 9270 .

Acesse a URL http://localhost:9270/metrics , e se você vir o conteúdo a seguir, significa que foi bem-sucedido.

Etapa 5: iniciar o Prometheus

Após iniciar Prometheus , ele começará a buscar dados do plugin JMeter Prometheus. Conforme mostrado na configuração a seguir, uma vez iniciado com sucesso, você pode ver os alvos definidos no Prometheus .

Etapa 6: configurar o Grafana

No site oficial Grafana , encontre o painel de monitoramento prometheus-jmeter fornecido pelo site oficial. Aqui selecionamos o template com ID 14927 para importar para o Grafana.

Após clicar em Carregar , selecione a fonte de dados Prometheus .

• Nota: Durante os testes, descobriu-se que o modelo original 14927 apresentava alguns erros. Eles foram corrigidos durante o processo de redação deste artigo. Importe o modelo corrigido baixado de GitHub .

Depois que o modelo for importado com sucesso, poderemos ver todos os dados de monitoramento dos testes de desempenho no Grafana .

Para facilitar uma experiência rápida de todo o processo de teste de desempenho, a comunidade smart-doc selecionou e forneceu um modelo que pode ser iniciado com um único comando usando docker-compose . Para aqueles que desejam experimentar por meio da implantação Kubernetes , as ferramentas de IA podem ser utilizadas para converter diretamente o modelo docker-compose em um modelo de implantação Kubernetes .

O projeto da experiência também inclui instruções de uso.

O código de exemplo para este artigo pode ser encontrado aqui .

A assistência do Smart-Doc nos testes de desempenho do JMeter

A combinação de smart-doc e JMeter para testes de estresse de desempenho oferece diversas vantagens:

• Automação: smart-doc pode extrair automaticamente informações da API do código-fonte e gerar scripts de teste de desempenho JMeter sem a necessidade de escrita manual, melhorando significativamente a eficiência.

• Precisão: Os scripts de teste de desempenho JMeter gerados pelo smart-doc são totalmente consistentes com as definições da API no código-fonte, evitando erros que podem ocorrer ao escrever scripts manualmente.

• Flexibilidade: smart-doc suporta uma variedade de opções de configuração, permitindo que os scripts JMeter gerados sejam customizados de acordo com os requisitos de teste.

smart-doc também continuará a melhorar e otimizar o suporte ao JMeter. Por favor, fique atento ao desenvolvimento contínuo do projeto de código aberto smart-doc .

Conclusão

Ao combinar smart-doc e JMeter, podemos não apenas automatizar a geração de documentação de API, mas também criar rapidamente scripts de teste de desempenho e realizar testes de estresse. Essa ferramenta de automação melhora significativamente a eficiência do desenvolvimento e dos testes, ao mesmo tempo que ajuda as equipes a manter e otimizar com mais facilidade o desempenho dos sistemas de software.

Esperamos que este artigo tenha fornecido referências práticas para você aplicar essas ferramentas de forma mais eficiente no seu dia a dia.

Também damos as boas-vindas a todos para continuarem a seguir e apoiar a comunidade de código aberto do smart-doc. No futuro, exploraremos o suporte para idiomas adicionais para ajudar mais desenvolvedores.