smart-docは、自動的に生成するツールです。 Java APIドキュメント。ソースコード内のインターフェースとコメントを分析してドキュメントを作成し、 Markdown 、 HTML5 、 OpenAPI 3.0など、さまざまなドキュメント出力形式をサポートしています。smart-docの設計目標は、ドキュメント作成プロセスを簡素化し、開発効率を向上させ、ドキュメントの正確性と適時性を確保することです。

ソフトウェア開発ライフサイクルにおいて、APIドキュメントの自動生成とインターフェースのパフォーマンステストは、開発効率の向上と製品品質の確保に重要なステップです。JMeterを生成する機能の追加により、性能試験smart-docバージョン3.0.1のスクリプトを使用すると、開発者はこれら 2 つのタスクをより簡単に実行できます。

この記事では、効果的なパフォーマンス テストのために smart-doc と JMeter を使用する方法を紹介します。

JMeter スクリプトを生成する

smart-docを使用して生成するJメーターパフォーマンス テスト スクリプトを使用すると、パフォーマンス テスト スクリプトの作成にかかる時間を大幅に短縮できるため、テストの効率が向上します。smart 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 はスクリプトに従ってパフォーマンス テストの実行を開始します。

Prometheus を設定する

プロメテウス時系列データを処理するためのオープンソースの監視およびアラート ツールです。これを使用して、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 リスナーを追加します。これは、テスト プラン->追加->リスナー-> Prometheus リスナーを右クリックして実行できます。

リスナーの設定は、次の公式設定を参照できます ( smart-doc 3.0.4 Prometheus リスナー生成の設定と追加をサポートしています)。

ステップ3: Prometheus Scrapeを構成する

Prometheus の設定ファイル ( prometheus.yml ) に、JMeter Prometheus プラグインからデータを取得するための新しいscrape_configを追加します。例:

 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を起動する

Prometheusを起動すると、JMeter Prometheus プラグインからデータの取得が開始されます。次の構成に示すように、正常に起動すると、 Prometheusで設定されたターゲットを確認できます。

ステップ6: Grafanaを構成する

Grafana公式サイトで、公式サイトが提供する prometheus-jmeter 監視パネルを見つけます。ここでは、ID 14927のテンプレートを選択して Grafana にインポートします。

「ロード」をクリックした後、 Prometheusデータ ソースを選択します。

• 注:テスト中に、元のテンプレート14927にいくつかのエラーがあることがわかりました。これらはこの記事の執筆中に修正されました。修正されたテンプレートをダウンロードしてインポートしてください。 GitHub 。

テンプレートが正常にインポートされると、 Grafanaでパフォーマンス テストの監視データ全体を確認できるようになります。

パフォーマンス テスト プロセス全体を迅速に体験できるように、 smart-docコミュニティはdocker-composeを使用して 1 つのコマンドで起動できるテンプレートをキュレートして提供しています。Kubernetes デプロイメントを通じてこれを体験したい場合は、AI ツールを使用して、 docker-composeテンプレートKubernetes Kubernetesデプロイメント テンプレートに直接変換できます。

体験用プロジェクトには使用方法の説明も含まれています。

この記事のサンプルコードは以下にあります。ここ。

JMeter パフォーマンス テストにおける Smart-Doc の支援

パフォーマンス ストレス テストにsmart-docと JMeter を組み合わせると、次のようないくつかの利点があります。

• 自動化: smart-doc 、ソース コードから API 情報を自動的に抽出し、手動で記述することなく JMeter パフォーマンス テスト スクリプトを生成するため、効率が大幅に向上します。

• 精度: smart-docによって生成される JMeter パフォーマンス テスト スクリプトは、ソース コード内の API 定義と完全に一致しているため、手動でスクリプトを記述するときに発生する可能性のあるエラーを回避できます。

• 柔軟性: smart-docさまざまな構成オプションをサポートしており、生成された JMeter スクリプトをテスト要件に応じてカスタマイズできます。

smart-doc JMeterのサポートも改善し、最適化していきます。スマートドキュメントオープンソースプロジェクトの継続的な開発。

結論

smart-docと JMeter を組み合わせることで、API ドキュメントの生成を自動化できるだけでなく、パフォーマンス テスト スクリプトを迅速に作成し、ストレス テストを実施することもできます。この自動化ツールは、開発とテストの効率を大幅に向上させるとともに、チームがソフトウェア システムのパフォーマンスをより簡単に維持および最適化できるようにします。

この記事が、日々の業務でこれらのツールをより効率的に適用するための実用的な参考資料となったことを願っています。

また、皆様が今後も smart-doc オープンソース コミュニティをフォローし、サポートしていただくことを歓迎いたします。今後は、より多くの開発者を支援するために、追加の言語のサポートを検討しています。