é uma ferramenta para gerar automaticamente 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 , 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. smart-doc API Java Markdown HTML5 , OpenAPI 3.0 e 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 scripts no versão , os desenvolvedores podem realizar essas duas tarefas de maneira mais conveniente. teste de performance smart-doc 3.0.1 Este artigo apresentará como usar o smart-doc e o JMeter para testes de desempenho eficazes. JMeter Gerar scripts Usando para gerar 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 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. smart-doc JMeter smart-doc Primeiro, certifique-se de que o foi adicionado ao seu projeto. Em seguida, configure os parâmetros relevantes do plugin smart-doc no arquivo do projeto, por exemplo: smart-doc-maven-plugin pom.xml <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 . 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. mvn -Dfile.encoding=UTF-8 smart-doc:jmeter 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 " " -> " ", selecione o arquivo de script JMeter gerado na primeira etapa e clique no botão " ". O JMeter começará então a realizar testes de desempenho de acordo com o script. Arquivo Abrir Iniciar Configurar o Prometheus é 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. Prometeu Etapa 1: Instale o plug-in JMeter Prometheus Primeiro, você precisa instalar o plugin Prometheus no diretório do JMeter. Você pode baixar o plugin do JMeter Plugins Manager ou do . Também pode ser baixado em . Para este caso, baixe a versão mais recente 0.7.1 do GitHub. lib/ext website oficial GitHub O endereço IP de escuta padrão do JMeter é , o que, por padrão, impedirá que o Prometheus se conecte à porta de escuta do JMeter Prometheus. Portanto, é necessário adicionar em . Nota: 127.0.0.1 prometheus.ip=0.0.0.0 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 ( suporta configuração e adição de geração de ouvinte Prometheus): smart-doc 3.0.4 Etapa 3: configurar o Prometheus Scrape No arquivo de configuração do Prometheus ( ), adicione um novo para buscar dados do plugin JMeter Prometheus. Por exemplo: prometheus.yml scrape_config scrape_configs: - job_name: 'jmeter' scrape_interval: 15s static_configs: - targets: ['<Your JMeter machine IP>:9270'] Aqui, é o endereço IP da máquina que executa o teste JMeter e é a porta de escuta padrão para o plug-in JMeter Prometheus. <Your JMeter machine IP> 9270 Etapa 4: execute o plano de teste Para facilitar a verificação neste artigo, o grupo de threads é definido como " " durante o teste de estresse, que pode ser ajustado de acordo com as necessidades reais. loop infinito Após iniciar com sucesso, o JMeter Prometheus irá, por padrão, criar um serviço na porta local . 9270 Acesse a URL e se você vir o conteúdo a seguir, significa que foi bem-sucedido. , http://localhost:9270/metrics Etapa 5: iniciar o Prometheus Após iniciar , 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 Prometheus Etapa 6: configurar o Grafana No site oficial , encontre o painel de monitoramento prometheus-jmeter fornecido pelo site oficial. Aqui selecionamos o template com ID para importar para o Grafana. Grafana 14927 Após clicar em , selecione a fonte de dados . Carregar Prometheus Durante os testes, descobriu-se que o modelo original apresentava alguns erros. Eles foram corrigidos durante o processo de redação deste artigo. Importe o modelo corrigido baixado de . Nota: 14927 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 selecionou e forneceu um modelo que pode ser iniciado com um único comando usando . Para aqueles que desejam experimentar por meio da implantação , as ferramentas de IA podem ser utilizadas para converter diretamente o modelo em um modelo de implantação . smart-doc docker-compose Kubernetes docker-compose 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 e JMeter para testes de estresse de desempenho oferece diversas vantagens: 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. Automação: smart-doc Os scripts de teste de desempenho JMeter gerados pelo são totalmente consistentes com as definições da API no código-fonte, evitando erros que podem ocorrer ao escrever scripts manualmente. Precisão: 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. Flexibilidade: smart-doc também continuará a melhorar e otimizar o suporte ao JMeter. Por favor, fique atento ao . smart-doc desenvolvimento contínuo do projeto de código aberto smart-doc Conclusão Ao combinar 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. smart-doc 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.
