smart-doc là một công cụ để tự động tạo ra API Java tài liệu. Nó tạo tài liệu bằng cách phân tích các giao diện và nhận xét trong mã nguồn, đồng thời hỗ trợ nhiều định dạng đầu ra tài liệu khác nhau, bao gồm Markdown , HTML5 , OpenAPI 3.0 , v.v. Mục tiêu thiết kế của smart-doc là đơn giản hóa quá trình viết tài liệu, nâng cao hiệu quả phát triển và đảm bảo tính chính xác và kịp thời của tài liệu.

Trong vòng đời phát triển phần mềm, việc tạo tài liệu API tự động và kiểm tra hiệu suất của giao diện là những bước quan trọng để nâng cao hiệu quả phát triển và đảm bảo chất lượng sản phẩm. Với việc bổ sung khả năng tạo JMeter kiểm tra năng suất trong phiên bản smart-doc 3.0.1 , các nhà phát triển có thể thực hiện hai tác vụ này một cách thuận tiện hơn.

Bài viết này sẽ giới thiệu cách sử dụng smart-doc và JMeter để kiểm tra hiệu suất hiệu quả.

Tạo tập lệnh JMeter

Sử dụng smart-doc để tạo JMeter các kịch bản kiểm tra hiệu suất có thể giảm đáng kể thời gian viết các kịch bản kiểm tra hiệu suất, từ đó nâng cao hiệu quả kiểm tra. Các tập lệnh JMeter được smart-doc tạo tự động có thể chạy trực tiếp trong JMeter mà không cần cấu hình và gỡ lỗi phức tạp, giúp việc kiểm tra hiệu suất đơn giản và nhanh hơn nhiều.

Trước tiên, hãy đảm bảo rằng smart-doc-maven-plugin đã được thêm vào dự án của bạn. Sau đó, cấu hình các tham số liên quan của plugin smart-doc trong tệp pom.xml của dự án, ví dụ:

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

Chạy lệnh mvn -Dfile.encoding=UTF-8 smart-doc:jmeter . Smart-doc sẽ quét mã nguồn dự án, trích xuất thông tin chú thích và tự động tạo tập lệnh kiểm tra hiệu suất JMeter tương ứng.

Những ai chưa biết cách sử dụng có thể tham khảo chính thức tài liệu tài liệu thông minh .

Nhập vào JMeter

Mở JMeter, nhấp vào " File " -> " Open ", chọn tệp script JMeter được tạo ở bước đầu tiên và nhấp vào nút " Start ". JMeter sau đó sẽ bắt đầu thực hiện các bài kiểm tra hiệu suất theo kịch bản.

Định cấu hình Prometheus

Prometheus là một công cụ cảnh báo và giám sát nguồn mở để xử lý dữ liệu chuỗi thời gian. Chúng tôi có thể sử dụng nó để thực hiện giám sát thời gian thực trong quá trình kiểm tra căng thẳng JMeter, từ đó nâng cao khả năng quan sát của kiểm tra hiệu suất.

Bước 1: Cài đặt Plugin JMeter Prometheus

Đầu tiên bạn cần cài đặt plugin Prometheus trong thư mục lib/ext của JMeter. Bạn có thể tải xuống plugin từ Trình quản lý plugin JMeter hoặc Trang web chính thức . Nó cũng có thể được tải xuống từ GitHub . Trong trường hợp này, hãy tải xuống phiên bản 0.7.1 mới nhất từ GitHub.

• Lưu ý: Địa chỉ IP nghe mặc định của JMeter là 127.0.0.1 , theo mặc định, địa chỉ này sẽ ngăn Prometheus kết nối với cổng nghe JMeter Prometheus. Vì vậy, cần phải thêm prometheus.ip=0.0.0.0 vào jmeter.properties .

Bước 2: Thêm trình nghe Prometheus

Mở JMeter và thêm Prometheus Listener vào kế hoạch kiểm tra của bạn. Điều này có thể được thực hiện bằng cách nhấp chuột phải vào Test Plan -> Add -> Listener -> Prometheus Listener .

Cấu hình của trình nghe có thể tham khảo các cài đặt chính thức, với tham chiếu như sau ( smart-doc 3.0.4 hỗ trợ định cấu hình và thêm thế hệ Prometheus Listener):

Bước 3: Định cấu hình Prometheus Scrape

Trong tệp cấu hình của Prometheus ( prometheus.yml ), thêm một scrape_config mới để tìm nạp dữ liệu từ plugin JMeter Prometheus. Ví dụ:

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

Ở đây, <Your JMeter machine IP> là địa chỉ IP của máy đang chạy thử nghiệm JMeter và 9270 là cổng nghe mặc định cho plugin JMeter Prometheus.

Bước 4: Chạy kế hoạch kiểm tra

Với mục đích xác minh dễ dàng trong bài viết này, nhóm luồng được đặt thành " vòng lặp vô hạn " trong quá trình kiểm tra sức chịu đựng, có thể điều chỉnh theo nhu cầu thực tế.

Sau khi khởi động thành công, theo mặc định, JMeter Prometheus sẽ tạo một dịch vụ trên cổng cục bộ 9270 .

Truy cập URL http://localhost:9270/metrics , và nếu bạn nhìn thấy nội dung như sau thì có nghĩa là đã thành công.

Bước 5: Khởi động Prometheus

Sau khi khởi động Prometheus , nó sẽ bắt đầu tìm nạp dữ liệu từ plugin JMeter Prometheus. Như được hiển thị trong cấu hình sau, sau khi khởi động thành công, bạn có thể thấy các mục tiêu đã đặt trong Prometheus .

Bước 6: Định cấu hình Grafana

Trên trang web chính thức Grafana , hãy tìm bảng giám sát prometheus-jmeter do trang web chính thức cung cấp. Ở đây, chúng tôi chọn mẫu có ID 14927 để nhập vào Grafana.

Sau khi nhấn Load , chọn nguồn dữ liệu Prometheus .

• Lưu ý: Trong quá trình thử nghiệm, chúng tôi nhận thấy mẫu gốc 14927 có một số lỗi. Những điều này đã được khắc phục trong quá trình viết bài viết này. Nhập mẫu đã sửa được tải xuống từ GitHub .

Sau khi mẫu được nhập thành công, chúng ta sẽ có thể xem toàn bộ dữ liệu giám sát kiểm tra hiệu suất trong Grafana .

Để tạo điều kiện trải nghiệm nhanh chóng toàn bộ quá trình kiểm tra hiệu suất, cộng đồng smart-doc đã tuyển chọn và cung cấp một mẫu có thể được khởi chạy bằng một lệnh duy nhất bằng cách sử dụng docker-compose . Đối với những người muốn trải nghiệm thông qua triển khai Kubernetes , các công cụ AI có thể được sử dụng để chuyển đổi trực tiếp mẫu docker-compose thành mẫu triển khai Kubernetes .

Dự án trải nghiệm cũng bao gồm hướng dẫn sử dụng.

Mã ví dụ cho bài viết này có thể được tìm thấy đây .

Sự hỗ trợ của Smart-Doc trong kiểm tra hiệu suất JMeter

Sự kết hợp giữa smart-doc và JMeter để kiểm tra hiệu suất hoạt động mang lại một số lợi ích:

• Tự động hóa: smart-doc có thể tự động trích xuất thông tin API từ mã nguồn và tạo tập lệnh kiểm tra hiệu suất JMeter mà không cần viết thủ công, cải thiện đáng kể hiệu quả.

• Độ chính xác: Các tập lệnh kiểm tra hiệu năng JMeter do smart-doc tạo ra hoàn toàn phù hợp với định nghĩa API trong mã nguồn, tránh các lỗi có thể xảy ra khi viết tập lệnh theo cách thủ công.

• Tính linh hoạt: smart-doc hỗ trợ nhiều tùy chọn cấu hình khác nhau, cho phép tùy chỉnh các tập lệnh JMeter được tạo theo yêu cầu thử nghiệm.

smart-doc cũng sẽ tiếp tục cải thiện và tối ưu hóa hỗ trợ cho JMeter. Hãy theo dõi để biết sự phát triển liên tục của dự án nguồn mở thông minh-doc .

Phần kết luận

Bằng cách kết hợp smart-doc và JMeter, chúng tôi không chỉ có thể tự động hóa việc tạo tài liệu API mà còn nhanh chóng tạo các tập lệnh kiểm tra hiệu suất và tiến hành kiểm tra căng thẳng. Công cụ tự động hóa này nâng cao đáng kể hiệu quả phát triển và thử nghiệm, đồng thời giúp các nhóm dễ dàng duy trì và tối ưu hóa hiệu suất của hệ thống phần mềm hơn.

Chúng tôi hy vọng bài viết này đã cung cấp những tài liệu tham khảo thiết thực để bạn có thể áp dụng những công cụ này hiệu quả hơn trong công việc hàng ngày.

Chúng tôi cũng hoan nghênh mọi người tiếp tục theo dõi và hỗ trợ cộng đồng nguồn mở smart-doc. Trong tương lai, chúng tôi đang khám phá khả năng hỗ trợ cho các ngôn ngữ bổ sung để hỗ trợ nhiều nhà phát triển hơn.