smart-doc otomatik olarak oluşturmak için bir araçtır Java API'si belgeler. Kaynak kodundaki arayüzleri ve yorumları analiz ederek belgeler oluşturur ve Markdown , HTML5 , OpenAPI 3.0 ve daha fazlasını içeren çeşitli belge çıktı formatlarını destekler. Smart-doc'un tasarım hedefi, belge yazma sürecini basitleştirmek, geliştirme verimliliğini artırmak ve belgelerin doğruluğunu ve güncelliğini sağlamaktır.

Yazılım geliştirme yaşam döngüsünde, API belgelerinin otomatik olarak oluşturulması ve arayüzlerin performans testi, geliştirme verimliliğinin artırılması ve ürün kalitesinin sağlanmasında önemli adımlardır. JMeter oluşturma yeteneğinin eklenmesiyle performans testi smart-doc sürüm 3.0.1 komut dosyaları sayesinde geliştiriciler bu iki görevi daha rahat bir şekilde gerçekleştirebilir.

Bu makale, etkili performans testi için smart-doc ve JMeter'ın nasıl kullanılacağını tanıtacaktır.

JMeter Komut Dosyaları Oluşturun

Oluşturmak için smart-doc kullanma JMeter performans testi komut dosyaları, performans testi komut dosyalarının yazılması için gereken süreyi önemli ölçüde azaltabilir ve böylece test verimliliğini artırabilir. smart-doc tarafından otomatik olarak oluşturulan JMeter komut dosyaları, karmaşık yapılandırma ve hata ayıklamaya gerek kalmadan doğrudan JMeter'de çalıştırılabilir, bu da performans testini çok daha basit ve hızlı hale getirir.

Öncelikle smart-doc-maven-plugin projenize eklendiğinden emin olun. Ardından projenin pom.xml dosyasındaki smart-doc eklentisinin ilgili parametrelerini yapılandırın, örneğin:

 <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 komutunu çalıştırın. Smart-doc, proje kaynak kodunu tarayacak, açıklama bilgilerini çıkaracak ve ilgili JMeter performans testi komut dosyalarını otomatik olarak oluşturacaktır.

Nasıl kullanılacağını bilmeyenler yetkiliye başvurabilir. akıllı belge belgeleri .

JMeter'a İçe Aktar

JMeter'ı açın, " Dosya " -> " Aç "a tıklayın, ilk adımda oluşturulan JMeter komut dosyasını seçin ve " Başlat " düğmesine tıklayın. JMeter daha sonra betiğe göre performans testleri gerçekleştirmeye başlayacaktır.

Prometheus'u yapılandırın

Prometheus zaman serisi verilerini işlemeye yönelik açık kaynaklı bir izleme ve uyarı aracıdır. Bunu JMeter stres testi süreci sırasında gerçek zamanlı izleme gerçekleştirmek için kullanabiliriz, böylece performans testinin gözlemlenebilirliğini artırabiliriz.

Adım 1: JMeter Prometheus Eklentisini Kurun

Öncelikle JMeter'in lib/ext dizinine Prometheus eklentisini kurmanız gerekiyor. Eklentiyi JMeter Eklenti Yöneticisinden veya resmi internet sitesi . Ayrıca şu adresten de indirilebilir: GitHub . Bu örnek için GitHub'dan en son sürüm 0.7.1'i indirin.

• Not: JMeter'in varsayılan dinleme IP adresi 127.0.0.1 ve bu, varsayılan olarak Prometheus'un JMeter Prometheus dinleme bağlantı noktasına bağlanmasını engelleyecektir. Bu nedenle jmeter.properties dosyasına prometheus.ip=0.0.0.0 eklemek gerekir.

Adım 2: Prometheus Dinleyiciyi Ekleyin

JMeter'ı açın ve Prometheus Dinleyiciyi test planınıza ekleyin. Bu, Test Planı -> Ekle -> Dinleyici -> Prometheus Dinleyici seçeneğine sağ tıklayarak yapılabilir.

Dinleyicinin yapılandırması, aşağıdaki referansla resmi ayarlara başvurabilir ( smart-doc 3.0.4 Prometheus Dinleyici oluşturmanın yapılandırılmasını ve eklenmesini destekler):

3. Adım: Prometheus Scrape'ı yapılandırın

Prometheus'un yapılandırma dosyasına ( prometheus.yml ), JMeter Prometheus eklentisinden veri almak için yeni bir scrape_config ekleyin. Örneğin:

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

Burada <Your JMeter machine IP> JMeter testini çalıştıran makinenin IP adresidir ve 9270 JMeter Prometheus eklentisi için varsayılan dinleme bağlantı noktasıdır.

4. Adım: Test Planını Çalıştırın

Bu makalede kolay doğrulama amacıyla, stres testi sırasında iş parçacığı grubu, gerçek ihtiyaçlara göre ayarlanabilen " sonsuz döngü " olarak ayarlanmıştır.

Başarılı bir şekilde başladıktan sonra, JMeter Prometheus varsayılan olarak 9270 yerel bağlantı noktasında bir hizmet oluşturacaktır.

URL'ye erişin http://localhost:9270/metrics , ve aşağıdaki içeriği görüyorsanız başarılı olmuş demektir.

Adım 5: Prometheus'u başlatın

Prometheus başlattıktan sonra JMeter Prometheus eklentisinden veri almaya başlayacaktır. Aşağıdaki konfigürasyonda gösterildiği gibi, başarıyla başlatıldığında Prometheus belirlenen hedefleri görebilirsiniz.

Adım 6: Grafana'yı yapılandırın

Grafana resmi web sitesinde, resmi site tarafından sağlanan prometheus-jmeter izleme panelini bulun. Burada Grafana’ya aktaracağımız ID 14927 şablonu seçiyoruz.

Yükle'ye tıkladıktan sonra Prometheus veri kaynağını seçin.

• Not: Test sırasında orijinal şablon 14927 bazı hatalar içerdiği tespit edildi. Bunlar bu makalenin yazılma sürecinde düzeltildi. İndirilen düzeltilmiş şablonu içe aktarın GitHub .

Şablon başarıyla içe aktarıldıktan sonra, performans testi izleme verilerinin tamamını Grafana görebileceğiz.

Tüm performans testi sürecinin hızlı bir şekilde deneyimlenmesini kolaylaştırmak için smart-doc topluluğu, docker-compose kullanılarak tek bir komutla başlatılabilen bir şablon hazırladı ve sağladı. Bunu Kubernetes dağıtımı aracılığıyla deneyimlemek isteyenler için, docker-compose şablonunu doğrudan bir Kubernetes dağıtım şablonuna dönüştürmek için yapay zeka araçlarından faydalanılabilir.

Deneyime yönelik proje aynı zamanda kullanım talimatlarını da içerir.

Bu makalenin örnek kodunu şu adreste bulabilirsiniz: Burada .

JMeter Performans Testinde Smart-Doc Yardımı

Performans stres testi için smart-doc ve JMeter kombinasyonu çeşitli avantajlar sunar:

• Otomasyon: smart-doc API bilgilerini kaynak kodundan otomatik olarak çıkarabilir ve manuel yazmaya gerek kalmadan JMeter performans testi komut dosyaları oluşturabilir, bu da verimliliği büyük ölçüde artırır.

• Hassasiyet: smart-doc tarafından oluşturulan JMeter performans testi komut dosyaları, kaynak koddaki API tanımlarıyla tamamen tutarlı olup, komut dosyalarını manuel olarak yazarken oluşabilecek hataları önler.

• Esneklik: smart-doc çeşitli yapılandırma seçeneklerini destekleyerek oluşturulan JMeter komut dosyalarının test gereksinimlerine göre özelleştirilmesine olanak tanır.

smart-doc ayrıca JMeter desteğini geliştirmeye ve optimize etmeye devam edecektir. Lütfen takipte kalın smart-doc açık kaynak projesinin devam eden gelişimi .

Çözüm

smart-doc ve JMeter'ı birleştirerek yalnızca API belgelerinin oluşturulmasını otomatikleştirmekle kalmıyoruz, aynı zamanda hızlı bir şekilde performans testi komut dosyaları oluşturabiliyor ve stres testi gerçekleştirebiliyoruz. Bu otomasyon aracı, geliştirme ve test verimliliğini önemli ölçüde artırırken ekiplerin yazılım sistemlerinin performansını daha kolay sürdürmesine ve optimize etmesine yardımcı olur.

Bu makalenin, bu araçları günlük çalışmalarınızda daha verimli bir şekilde uygulamanız için pratik referanslar sağladığını umuyoruz.

Ayrıca herkesin akıllı belge açık kaynak topluluğunu takip etmeye ve desteklemeye devam etmesini bekliyoruz. Gelecekte daha fazla geliştiriciye yardımcı olmak için ek dil desteği üzerinde çalışıyoruz.