smart-doc ist ein Tool zur automatischen Generierung Java-API Dokumentation. Es erstellt Dokumentationen durch die Analyse von Schnittstellen und Kommentaren im Quellcode und unterstützt eine Vielzahl von Dokumentausgabeformaten, darunter Markdown , HTML5 , OpenAPI 3.0 und mehr. Das Designziel von smart-doc besteht darin, den Dokumenterstellungsprozess zu vereinfachen, die Entwicklungseffizienz zu verbessern und die Genauigkeit und Aktualität der Dokumentation sicherzustellen.

Im Lebenszyklus der Softwareentwicklung sind die automatische Generierung von API-Dokumentation und die Leistungstests von Schnittstellen wichtige Schritte zur Verbesserung der Entwicklungseffizienz und zur Sicherstellung der Produktqualität. Mit der zusätzlichen Möglichkeit zur Generierung von JMeter Leistungstest Skripte in smart-doc Version 3.0.1 können Entwickler diese beiden Aufgaben bequemer erledigen.

Dieser Artikel stellt die Verwendung von Smart-Doc und JMeter für effektive Leistungstests vor.

JMeter- Skripte generieren

Verwenden von smart-doc zum Generieren JMeter Leistungstestskripte können den Zeitaufwand zum Schreiben von Leistungstestskripten erheblich reduzieren und so die Testeffizienz verbessern. Die von smart-doc automatisch generierten JMeter-Skripte können direkt in JMeter ausgeführt werden, ohne dass eine komplexe Konfiguration und Fehlerbehebung erforderlich ist, was Leistungstests viel einfacher und schneller macht.

Stellen Sie zunächst sicher, dass das smart-doc-maven-plugin zu Ihrem Projekt hinzugefügt wurde. Konfigurieren Sie dann die relevanten Parameter des Smart-Doc-Plugins in der pom.xml Datei des Projekts, zum Beispiel:

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

Führen Sie den Befehl mvn -Dfile.encoding=UTF-8 smart-doc:jmeter aus. Smart-doc scannt den Quellcode des Projekts, extrahiert Annotationsinformationen und generiert automatisch die entsprechenden JMeter-Leistungstestskripte.

Diejenigen, die mit der Verwendung nicht vertraut sind, können sich an die offizielle Smart-Doc-Dokumentation .

In JMeter importieren

Öffnen Sie JMeter, klicken Sie auf „ Datei “ -> „ Öffnen “, wählen Sie die im ersten Schritt generierte JMeter-Skriptdatei aus und klicken Sie auf die Schaltfläche „ Start “. JMeter beginnt dann mit der Durchführung von Leistungstests gemäß dem Skript.

Konfigurieren Sie Prometheus

Prometheus ist ein Open-Source-Überwachungs- und Warntool für die Verarbeitung von Zeitreihendaten. Wir können es verwenden, um während des JMeter-Stresstests eine Echtzeitüberwachung durchzuführen und so die Beobachtbarkeit von Leistungstests zu verbessern.

Schritt 1: Installieren Sie das JMeter Prometheus Plugin

Zuerst müssen Sie das Prometheus-Plugin im lib/ext -Verzeichnis von JMeter installieren. Sie können das Plugin aus dem JMeter Plugins Manager oder dem offizielle Website Es kann auch heruntergeladen werden von GitHub . Laden Sie für diese Instanz die neueste Version 0.7.1 von GitHub herunter.

• Hinweis: Die standardmäßige Abhör-IP-Adresse von JMeter ist 127.0.0.1 . Dies verhindert standardmäßig, dass Prometheus eine Verbindung zum Abhörport von JMeter Prometheus herstellt. Daher ist es notwendig, prometheus.ip=0.0.0.0 in jmeter.properties hinzuzufügen.

Schritt 2: Prometheus Listener hinzufügen

Öffnen Sie JMeter und fügen Sie den Prometheus Listener zu Ihrem Testplan hinzu. Klicken Sie dazu mit der rechten Maustaste auf Testplan -> Hinzufügen -> Listener -> Prometheus Listener .

Die Konfiguration des Listeners kann auf die offiziellen Einstellungen mit den folgenden Referenzen verweisen ( smart-doc 3.0.4 unterstützt das Konfigurieren und Hinzufügen der Prometheus-Listener-Generierung):

Schritt 3: Prometheus Scrape konfigurieren

Fügen Sie in der Konfigurationsdatei von Prometheus ( prometheus.yml ) eine neue scrape_config hinzu, um Daten vom JMeter Prometheus-Plugin abzurufen. Beispiel:

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

Hier ist <Your JMeter machine IP> die IP-Adresse des Computers, auf dem der JMeter-Test ausgeführt wird, und 9270 ist der Standard-Abhörport für das JMeter-Prometheus-Plugin.

Schritt 4: Ausführen des Testplans

Zur einfachen Überprüfung wird in diesem Artikel die Thread-Gruppe während des Stresstests auf „ Endlosschleife “ eingestellt, die entsprechend den tatsächlichen Anforderungen angepasst werden kann.

Nach dem erfolgreichen Start erstellt JMeter Prometheus standardmäßig einen Dienst auf dem lokalen Port 9270 .

Zugriff auf die URL http://localhost:9270/metrics , und wenn Sie den folgenden Inhalt sehen, bedeutet dies, dass es erfolgreich war.

Schritt 5: Starten Sie Prometheus

Nach dem Start von Prometheus beginnt es, Daten vom JMeter Prometheus-Plugin abzurufen. Wie in der folgenden Konfiguration gezeigt, können Sie nach dem erfolgreichen Start die festgelegten Ziele in Prometheus sehen.

Schritt 6: Grafana konfigurieren

Auf der offiziellen Grafana -Website finden Sie das von der offiziellen Website bereitgestellte Prometheus-JMeter-Überwachungspanel. Hier wählen wir die Vorlage mit der ID 14927 aus, um sie in Grafana zu importieren.

Wählen Sie nach dem Klicken auf „Laden“ die Prometheus -Datenquelle aus.

• Hinweis: Beim Testen wurde festgestellt, dass die ursprüngliche Vorlage 14927 einige Fehler enthielt. Diese wurden während des Schreibprozesses dieses Artikels behoben. Importieren Sie die korrigierte Vorlage, die Sie heruntergeladen haben von GitHub .

Nachdem die Vorlage erfolgreich importiert wurde, können wir die gesamten Leistungstest-Überwachungsdaten in Grafana sehen.

Um den gesamten Leistungstestprozess schnell durchlaufen zu können, hat die smart-doc Community eine Vorlage zusammengestellt und bereitgestellt, die mit einem einzigen Befehl mithilfe von docker-compose gestartet werden kann. Für diejenigen, die dies über Kubernetes Bereitstellung erleben möchten, können KI-Tools verwendet werden, um die docker-compose Vorlage direkt in eine Kubernetes Bereitstellungsvorlage umzuwandeln.

Zum Erlebnisprojekt gehört auch eine Gebrauchsanleitung.

Den Beispielcode für diesen Artikel finden Sie Hier .

Die Unterstützung von Smart-Doc beim JMeter-Leistungstest

Die Kombination von smart-doc und JMeter für Leistungsstresstests bietet mehrere Vorteile:

• Automatisierung: smart-doc kann automatisch API-Informationen aus dem Quellcode extrahieren und JMeter-Leistungstestskripte generieren, ohne dass diese manuell geschrieben werden müssen, was die Effizienz erheblich verbessert.

• Präzision: Die von smart-doc generierten JMeter-Leistungstestskripte stimmen vollständig mit den API-Definitionen im Quellcode überein und vermeiden so Fehler, die beim manuellen Schreiben von Skripten auftreten können.

• Flexibilität: smart-doc unterstützt eine Vielzahl von Konfigurationsoptionen, sodass die generierten JMeter-Skripte entsprechend den Testanforderungen angepasst werden können.

smart-doc wird auch weiterhin die Unterstützung für JMeter verbessern und optimieren. Bitte bleiben Sie dran für die Weiterentwicklung des Open-Source-Projektes smart-doc .

Abschluss

Durch die Kombination von smart-doc und JMeter können wir nicht nur die Generierung von API-Dokumentationen automatisieren, sondern auch schnell Leistungstestskripte erstellen und Stresstests durchführen. Dieses Automatisierungstool steigert die Entwicklungs- und Testeffizienz erheblich und hilft Teams dabei, die Leistung von Softwaresystemen einfacher zu warten und zu optimieren.

Wir hoffen, dass dieser Artikel Ihnen praktische Hinweise gegeben hat, damit Sie diese Tools in Ihrer täglichen Arbeit effizienter einsetzen können.

Wir begrüßen auch alle, die Open-Source-Community von smart-doc weiterhin zu verfolgen und zu unterstützen. In Zukunft prüfen wir die Unterstützung weiterer Sprachen, um mehr Entwicklern zu helfen.