smart-doc 자동으로 생성하는 도구입니다. 자바 API 선적 서류 비치. 소스 코드의 인터페이스와 주석을 분석하여 문서를 생성하고 Markdown , HTML5 , OpenAPI 3.0 등 을 포함한 다양한 문서 출력 형식을 지원합니다. smart-doc의 디자인 목표는 문서 작성 과정을 단순화하고, 개발 효율성을 높이며, 문서의 정확성과 적시성을 보장하는 것입니다.

소프트웨어 개발 라이프사이클에서 API 문서의 자동 생성과 인터페이스 성능 테스트는 개발 효율성을 향상하고 제품 품질을 보장하는 핵심 단계입니다. JMeter 생성 기능 추가 성능 시험 smart-doc 버전 3.0.1 의 스크립트를 사용하면 개발자는 이 두 가지 작업을 보다 편리하게 수행할 수 있습니다.

이 기사에서는 효과적인 성능 테스트를 위해 smart-doc 및 JMeter를 사용하는 방법을 소개합니다.

JMeter 스크립트 생성

smart-doc 사용하여 생성 JMeter 성능 테스트 스크립트를 사용하면 성능 테스트 스크립트 작성에 소요되는 시간을 크게 줄여 테스트 효율성을 높일 수 있습니다. smart-doc 에 의해 자동으로 생성된 JMeter 스크립트는 복잡한 구성 및 디버깅 없이 JMeter에서 직접 실행할 수 있으므로 성능 테스트가 훨씬 간단하고 빨라집니다.

먼저 smart-doc-maven-plugin 프로젝트에 추가되었는지 확인하세요. 그런 다음 프로젝트의 pom.xml 파일에서 smart-doc 플러그인의 관련 매개변수를 구성합니다. 예를 들면 다음과 같습니다.

 <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 플러그인 설치

먼저 JMeter의 lib/ext 디렉터리에 Prometheus 플러그인을 설치해야 합니다. JMeter 플러그인 관리자 또는 공식 웹 사이트 . 다음에서 다운로드할 수도 있습니다. GitHub . 이 경우 GitHub에서 최신 버전 0.7.1을 다운로드하세요.

• 참고: JMeter의 기본 수신 IP 주소는 127.0.0.1 입니다. 이는 기본적으로 Prometheus가 JMeter Prometheus 수신 포트에 연결하는 것을 방지합니다. 따라서 jmeter.properties 에 prometheus.ip=0.0.0.0 추가해야 합니다.

2단계: Prometheus 리스너 추가

JMeter를 열고 Prometheus Listener를 테스트 계획에 추가하세요. 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> JMeter 테스트를 실행하는 시스템의 IP 주소이고, 9270 JMeter Prometheus 플러그인의 기본 수신 포트입니다.

4단계: 테스트 계획 실행

이 기사에서는 쉽게 확인할 수 있도록 스트레스 테스트 중에 스레드 그룹을 " 무한 루프 "로 설정했으며 이는 실제 필요에 따라 조정될 수 있습니다.

성공적으로 시작된 후 JMeter Prometheus는 기본적으로 로컬 포트 9270 에 서비스를 생성합니다.

URL에 액세스 http://localhost:9270/metrics , 그리고 아래와 같은 내용이 보인다면 성공한 것입니다.

5단계: 프로메테우스 시작

Prometheus 시작한 후 JMeter Prometheus 플러그인에서 데이터를 가져오기 시작합니다. 다음 구성과 같이 성공적으로 시작되면 Prometheus 에서 설정된 대상을 볼 수 있습니다.

6단계: Grafana 구성

Grafana 공식 홈페이지에서 공식 사이트에서 제공하는 prometheus-jmeter 모니터링 패널을 찾아보세요. 여기서는 Grafana로 가져올 ID가 14927 인 템플릿을 선택합니다.

로드를 클릭한 후 Prometheus 데이터 소스를 선택합니다.

• 참고: 테스트 중에 원본 템플릿 14927 일부 오류가 있는 것으로 나타났습니다. 이러한 문제는 이 기사를 작성하는 과정에서 수정되었습니다. 다음에서 다운로드한 수정된 템플릿을 가져옵니다. GitHub .

템플릿을 성공적으로 가져오면 Grafana 에서 전체 성능 테스트 모니터링 데이터를 볼 수 있습니다.

전체 성능 테스트 프로세스의 신속한 경험을 촉진하기 위해 smart-doc 커뮤니티는 docker-compose 사용하여 단일 명령으로 시작할 수 있는 템플릿을 선별하고 제공했습니다. Kubernetes 배포를 통해 경험하려는 사람들은 AI 도구를 활용하여 docker-compose 템플릿을 Kubernetes 배포 템플릿으로 직접 변환할 수 있습니다.

체험 프로젝트에는 사용 지침도 포함되어 있습니다.

이 기사의 예제 코드를 찾을 수 있습니다. 여기 .

JMeter 성능 테스트에서 Smart-Doc의 지원

성능 스트레스 테스트를 위한 smart-doc 와 JMeter의 조합은 다음과 같은 몇 가지 장점을 제공합니다.

• 자동화: smart-doc 소스 코드에서 API 정보를 자동으로 추출하고 수동으로 작성할 필요 없이 JMeter 성능 테스트 스크립트를 생성하여 효율성을 크게 향상시킬 수 있습니다.

• 정밀도: smart-doc 에 의해 생성된 JMeter 성능 테스트 스크립트는 소스 코드의 API 정의와 완전히 일치하여 스크립트를 수동으로 작성할 때 발생할 수 있는 오류를 방지합니다.

• 유연성: smart-doc 다양한 구성 옵션을 지원하므로 생성된 JMeter 스크립트를 테스트 요구 사항에 따라 사용자 정의할 수 있습니다.

smart-doc 또한 JMeter에 대한 지원을 지속적으로 개선하고 최적화할 것입니다. 계속해서 지켜봐 주시기 바랍니다. smart-doc 오픈 소스 프로젝트의 지속적인 개발 .

결론

smart-doc 와 JMeter를 결합하면 API 문서 생성을 자동화할 수 있을 뿐만 아니라 신속하게 성능 테스트 스크립트를 생성하고 스트레스 테스트를 수행할 수 있습니다. 이 자동화 도구는 개발 및 테스트 효율성을 크게 향상시키는 동시에 팀이 소프트웨어 시스템의 성능을 보다 쉽게 유지 관리하고 최적화하도록 돕습니다.

이 기사가 일상 업무에 이러한 도구를 보다 효율적으로 적용하는 데 도움이 되는 실용적인 참고 자료가 되었기를 바랍니다.

또한 smart-doc 오픈 소스 커뮤니티를 계속해서 팔로우하고 지원하는 모든 분들을 환영합니다. 앞으로는 더 많은 개발자를 지원하기 위해 추가 언어 지원을 모색하고 있습니다.