smart-doc — инструмент для автоматического создания Java API документация. Он создает документацию путем анализа интерфейсов и комментариев в исходном коде и поддерживает различные форматы вывода документов, включая Markdown , HTML5 , OpenAPI 3.0 и другие. Целью разработки smart-doc является упрощение процесса написания документов, повышение эффективности разработки, а также обеспечение точности и своевременности документации.

В жизненном цикле разработки программного обеспечения автоматическое создание документации API и тестирование производительности интерфейсов являются ключевыми шагами в повышении эффективности разработки и обеспечении качества продукта. С добавлением возможности генерировать JMeter тестирование производительности скриптов в smart-doc версии 3.0.1 разработчикам будет удобнее выполнять эти две задачи.

В этой статье рассказывается, как использовать smart-doc и JMeter для эффективного тестирования производительности.

Создание сценариев JMeter

Использование smart-doc для создания JMeter Сценарии тестирования производительности могут значительно сократить время, затрачиваемое на написание сценариев тестирования производительности, тем самым повышая эффективность тестирования. Скрипты JMeter, автоматически генерируемые с помощью smart-doc можно запускать непосредственно в JMeter без необходимости сложной настройки и отладки, что значительно упрощает и ускоряет тестирование производительности.

Сначала убедитесь, что smart-doc-maven-plugin добавлен в ваш проект. Затем настройте соответствующие параметры плагина smart-doc в файле 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>

Запустите команду mvn -Dfile.encoding=UTF-8 smart-doc:jmeter . Smart-doc просканирует исходный код проекта, извлечет информацию аннотаций и автоматически сгенерирует соответствующие сценарии тестирования производительности JMeter.

Те, кто не знаком с тем, как им пользоваться, могут обратиться к официальному документация смарт-док .

Импортировать в JMeter

Откройте JMeter, нажмите « Файл » -> « Открыть », выберите файл сценария JMeter, созданный на первом этапе, и нажмите кнопку « Пуск ». Затем JMeter начнет выполнять тесты производительности в соответствии со сценарием.

Настроить Прометей

Прометей — это инструмент мониторинга и оповещения с открытым исходным кодом для обработки данных временных рядов. Мы можем использовать его для мониторинга в реальном времени во время процесса стресс-тестирования JMeter, тем самым повышая наблюдаемость тестирования производительности.

Шаг 1. Установите плагин JMeter Prometheus.

Во-первых, вам нужно установить плагин Prometheus в каталог lib/ext JMeter. Вы можете загрузить плагин из менеджера плагинов JMeter или Официальный веб-сайт . Его также можно скачать с GitHub . В этом случае загрузите последнюю версию 0.7.1 с GitHub.

• Примечание. IP-адрес прослушивания JMeter по умолчанию — 127.0.0.1 , что по умолчанию не позволяет Prometheus подключаться к порту прослушивания JMeter Prometheus. Поэтому необходимо добавить prometheus.ip=0.0.0.0 в jmeter.properties .

Шаг 2. Добавьте прослушиватель Prometheus

Откройте JMeter и добавьте прослушиватель Prometheus в свой план тестирования. Это можно сделать, щелкнув правой кнопкой мыши Test Plan -> Add -> Listener -> Prometheus Listener .

Конфигурацию прослушивателя можно найти в официальных настройках со следующей ссылкой ( smart-doc 3.0.4 поддерживает настройку и добавление генерации прослушивателя Prometheus):

Шаг 3. Настройте очистку Prometheus

В файле конфигурации Prometheus ( prometheus.yml ) добавьте новый scrape_config для получения данных из плагина JMeter Prometheus. Например:

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

Здесь <Your JMeter machine IP> — это IP-адрес компьютера, на котором выполняется тест JMeter, а 9270 — это порт прослушивания по умолчанию для плагина JMeter Prometheus.

Шаг 4. Запустите план тестирования

Для облегчения проверки в этой статье во время стресс-тестирования для группы потоков задан режим « бесконечный цикл », который можно настроить в соответствии с фактическими потребностями.

После успешного запуска JMeter Prometheus по умолчанию создаст службу на локальном порту 9270 .

Доступ к URL-адресу http://localhost:9270/метрики , и если вы увидите следующее содержимое, это означает, что оно прошло успешно.

Шаг 5: Запустите Прометей

После запуска Prometheus он начнет получать данные из плагина JMeter Prometheus. Как показано в следующей конфигурации, после успешного запуска вы сможете увидеть установленные цели в Prometheus .

Шаг 6: Настройте Графану

На официальном сайте Grafana найдите панель мониторинга prometheus-jmeter, предоставленную официальным сайтом. Здесь мы выбираем шаблон с идентификатором 14927 для импорта в Grafana.

После нажатия кнопки «Загрузить» выберите источник данных Prometheus .

• Примечание. В ходе тестирования было обнаружено, что исходный шаблон 14927 содержит некоторые ошибки. Они были исправлены в процессе написания статьи. Импортируйте исправленный шаблон, скачанный с GitHub .

После успешного импорта шаблона мы сможем увидеть все данные мониторинга тестирования производительности в Grafana .

Чтобы облегчить быстрый процесс всего процесса тестирования производительности, сообщество smart-doc разработало и предоставило шаблон, который можно запустить с помощью одной команды с помощью docker-compose . Те, кто хочет испытать это при развертывании Kubernetes , могут использовать инструменты искусственного интеллекта для прямого преобразования шаблона docker-compose в шаблон развертывания Kubernetes .

Проект для опыта также включает инструкции по использованию.

Пример кода для этой статьи можно найти здесь .

Помощь Smart-Doc в тестировании производительности JMeter

Комбинация smart-doc и JMeter для нагрузочного тестирования производительности дает несколько преимуществ:

• Автоматизация: smart-doc может автоматически извлекать информацию API из исходного кода и генерировать сценарии тестирования производительности JMeter без необходимости написания вручную, что значительно повышает эффективность.

• Точность: сценарии тестирования производительности JMeter, созданные с помощью smart-doc полностью соответствуют определениям API в исходном коде, что позволяет избежать ошибок, которые могут возникнуть при написании сценариев вручную.

• Гибкость: smart-doc поддерживает множество вариантов конфигурации, позволяя настраивать сгенерированные сценарии JMeter в соответствии с требованиями тестирования.

smart-doc также продолжит улучшать и оптимизировать поддержку JMeter. Пожалуйста, следите за обновлениями продолжающееся развитие проекта с открытым исходным кодом smart-doc .

Заключение

Объединив smart-doc и JMeter, мы можем не только автоматизировать создание документации API, но также быстро создавать сценарии тестирования производительности и проводить стресс-тестирование. Этот инструмент автоматизации значительно повышает эффективность разработки и тестирования, помогая командам легче поддерживать и оптимизировать производительность программных систем.

Мы надеемся, что эта статья предоставила вам практические рекомендации, которые помогут вам более эффективно применять эти инструменты в повседневной работе.

Мы также приглашаем всех продолжать следить за сообществом смарт-документов с открытым исходным кодом и поддерживать его. В будущем мы изучаем возможность поддержки дополнительных языков, чтобы помочь большему числу разработчиков.