smart-doc es una herramienta para generar automáticamente API de Java documentación. Crea documentación analizando interfaces y comentarios en el código fuente y admite una variedad de formatos de salida de documentos, incluidos Markdown , HTML5 , OpenAPI 3.0 y más. El objetivo del diseño de smart-doc es simplificar el proceso de redacción de documentos, mejorar la eficiencia del desarrollo y garantizar la precisión y puntualidad de la documentación.

En el ciclo de vida del desarrollo de software, la generación automática de documentación API y las pruebas de rendimiento de las interfaces son pasos clave para mejorar la eficiencia del desarrollo y garantizar la calidad del producto. Con la adición de la capacidad de generar JMeter. pruebas de rendimiento scripts en la versión 3.0.1 smart-doc , los desarrolladores pueden realizar estas dos tareas de manera más conveniente.

Este artículo presentará cómo utilizar smart-doc y JMeter para realizar pruebas de rendimiento efectivas.

Generar scripts JMeter

Usando smart-doc para generar JMetro Los scripts de prueba de rendimiento pueden reducir significativamente el tiempo necesario para escribir scripts de prueba de rendimiento, mejorando así la eficiencia de las pruebas. Los scripts de JMeter que genera automáticamente smart-doc se pueden ejecutar directamente en JMeter sin la necesidad de una configuración y depuración complejas, lo que hace que las pruebas de rendimiento sean mucho más simples y rápidas.

Primero, asegúrese de que el smart-doc-maven-plugin se haya agregado a su proyecto. Luego, configure los parámetros relevantes del complemento smart-doc en el archivo pom.xml del proyecto, por ejemplo:

 <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>

Ejecute el comando mvn -Dfile.encoding=UTF-8 smart-doc:jmeter . Smart-doc escaneará el código fuente del proyecto, extraerá información de anotaciones y generará automáticamente los scripts de prueba de rendimiento de JMeter correspondientes.

Aquellos que no estén familiarizados con su uso pueden consultar el sitio oficial. documentación de documento inteligente .

Importar a JMeter

Abra JMeter, haga clic en " Archivo " -> " Abrir ", seleccione el archivo de script JMeter generado en el primer paso y haga clic en el botón " Inicio ". Luego, JMeter comenzará a realizar pruebas de rendimiento de acuerdo con el script.

Configurar Prometeo

Prometeo es una herramienta de monitoreo y alertas de código abierto para manejar datos de series temporales. Podemos usarlo para realizar monitoreo en tiempo real durante el proceso de prueba de estrés de JMeter, mejorando así la observabilidad de las pruebas de rendimiento.

Paso 1: instale el complemento JMeter Prometheus

Primero, debe instalar el complemento Prometheus en el directorio lib/ext de JMeter. Puede descargar el complemento desde JMeter Plugins Manager o desde página web oficial . También se puede descargar desde GitHub . Para este caso, descargue la última versión 0.7.1 de GitHub.

• Nota: La dirección IP de escucha predeterminada de JMeter es 127.0.0.1 , lo que, de forma predeterminada, evitará que Prometheus se conecte al puerto de escucha de JMeter Prometheus. Por lo tanto, es necesario agregar prometheus.ip=0.0.0.0 en jmeter.properties .

Paso 2: agregue el oyente Prometheus

Abra JMeter y agregue Prometheus Listener a su plan de prueba. Esto se puede hacer haciendo clic derecho en Plan de prueba -> Agregar -> Oyente -> Prometheus Listener .

La configuración del oyente puede hacer referencia a la configuración oficial, con la siguiente referencia ( smart-doc 3.0.4 admite la configuración y adición de la generación de oyentes Prometheus):

Paso 3: configurar Prometheus Scrape

En el archivo de configuración de Prometheus ( prometheus.yml ), agregue un nuevo scrape_config para recuperar datos del complemento JMeter Prometheus. Por ejemplo:

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

Aquí, <Your JMeter machine IP> es la dirección IP de la máquina que ejecuta la prueba de JMeter y 9270 es el puerto de escucha predeterminado para el complemento JMeter Prometheus.

Paso 4: ejecutar el plan de prueba

Para facilitar la verificación en este artículo, el grupo de hilos se establece en " bucle infinito " durante la prueba de estrés, que se puede ajustar según las necesidades reales.

Después de iniciarse exitosamente, JMeter Prometheus creará, de forma predeterminada, un servicio en el puerto local 9270 .

Accede a la URL http://localhost:9270/métricas , y si ve el siguiente contenido, significa que ha sido exitoso.

Paso 5: inicie Prometheus

Después de iniciar Prometheus , comenzará a recuperar datos del complemento JMeter Prometheus. Como se muestra en la siguiente configuración, una vez iniciado correctamente, podrá ver los objetivos establecidos en Prometheus .

Paso 6: configurar Grafana

En el sitio web oficial Grafana , busque el panel de monitoreo prometheus-jmeter proporcionado por el sitio oficial. Aquí, seleccionamos la plantilla con el ID 14927 para importar a Grafana.

Después de hacer clic en Cargar , seleccione la fuente de datos Prometheus .

• Nota: Durante las pruebas, se encontró que la plantilla original 14927 tenía algunos errores. Estos se solucionaron durante el proceso de redacción de este artículo. Importe la plantilla corregida descargada de GitHub .

Una vez que la plantilla se importe correctamente, podremos ver todos los datos de monitoreo de las pruebas de rendimiento en Grafana .

Para facilitar una experiencia rápida de todo el proceso de prueba de rendimiento, la comunidad de smart-doc ha seleccionado y proporcionado una plantilla que se puede iniciar con un solo comando usando docker-compose . Para aquellos que deseen experimentarlo a través de la implementación Kubernetes , se pueden utilizar herramientas de inteligencia artificial para convertir directamente la plantilla docker-compose en una plantilla de implementación de Kubernetes .

El proyecto de la experiencia también incluye instrucciones de uso.

El código de ejemplo para este artículo se puede encontrar aquí .

La asistencia de Smart-Doc en las pruebas de rendimiento de JMeter

La combinación de smart-doc y JMeter para pruebas de estrés de rendimiento ofrece varias ventajas:

• Automatización: smart-doc puede extraer automáticamente información API del código fuente y generar scripts de prueba de rendimiento JMeter sin necesidad de escritura manual, lo que mejora enormemente la eficiencia.

• Precisión: los scripts de prueba de rendimiento de JMeter generados por smart-doc son completamente consistentes con las definiciones de API en el código fuente, lo que evita errores que pueden ocurrir al escribir scripts manualmente.

• Flexibilidad: smart-doc admite una variedad de opciones de configuración, lo que permite personalizar los scripts JMeter generados según los requisitos de prueba.

smart-doc también continuará mejorando y optimizando el soporte para JMeter. Por favor permanezcan atentos a las desarrollo continuo del proyecto de código abierto smart-doc .

Conclusión

Al combinar smart-doc y JMeter, no solo podemos automatizar la generación de documentación API sino también crear rápidamente scripts de prueba de rendimiento y realizar pruebas de estrés. Esta herramienta de automatización mejora significativamente la eficiencia del desarrollo y las pruebas al tiempo que ayuda a los equipos a mantener y optimizar más fácilmente el rendimiento de los sistemas de software.

Esperamos que este artículo le haya proporcionado referencias prácticas para que pueda aplicar estas herramientas de manera más eficiente en su trabajo diario.

También invitamos a todos a seguir y apoyar a la comunidad de código abierto de smart-doc. En el futuro, estamos explorando la compatibilidad con idiomas adicionales para ayudar a más desarrolladores.