smart-doc स्वचालित रूप से उत्पन्न करने के लिए एक उपकरण है जावा एपीआई दस्तावेज़ीकरण। यह स्रोत कोड में इंटरफेस और टिप्पणियों का विश्लेषण करके दस्तावेज़ीकरण बनाता है और Markdown , HTML5 , OpenAPI 3.0 और अन्य सहित कई दस्तावेज़ आउटपुट प्रारूपों का समर्थन करता है। स्मार्ट-डॉक का डिज़ाइन लक्ष्य दस्तावेज़ लेखन प्रक्रिया को सरल बनाना, विकास दक्षता में सुधार करना और दस्तावेज़ीकरण की सटीकता और समयबद्धता सुनिश्चित करना है।

सॉफ़्टवेयर विकास जीवनचक्र में, API दस्तावेज़ों का स्वचालित निर्माण और इंटरफ़ेस का प्रदर्शन परीक्षण विकास दक्षता में सुधार और उत्पाद की गुणवत्ता सुनिश्चित करने में महत्वपूर्ण कदम हैं। JMeter उत्पन्न करने की क्षमता के साथ प्रदर्शन का परीक्षण smart-doc संस्करण 3.0.1 में स्क्रिप्ट के साथ, डेवलपर्स इन दो कार्यों को अधिक आसानी से पूरा कर सकते हैं।

यह आलेख प्रभावी प्रदर्शन परीक्षण के लिए स्मार्ट-डॉक और जेमीटर का उपयोग करने का तरीका बताएगा।

JMeter स्क्रिप्ट उत्पन्न करें

smart-doc उपयोग करके जेमीटर प्रदर्शन परीक्षण स्क्रिप्ट प्रदर्शन परीक्षण स्क्रिप्ट लिखने में लगने वाले समय को काफी हद तक कम कर सकती हैं, जिससे परीक्षण दक्षता में सुधार होता है। 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: प्रोमेथियस श्रोता जोड़ें

JMeter खोलें, और अपने टेस्ट प्लान में Prometheus श्रोता जोड़ें। यह Test Plan -> Add -> श्रोता -> Prometheus श्रोता पर राइट-क्लिक करके किया जा सकता है।

श्रोता का कॉन्फ़िगरेशन आधिकारिक सेटिंग्स को संदर्भित कर सकता है, संदर्भ इस प्रकार है ( smart-doc 3.0.4 प्रोमेथियस श्रोता पीढ़ी को कॉन्फ़िगर करने और जोड़ने का समर्थन करता है):

चरण 3: प्रोमेथियस स्क्रैप कॉन्फ़िगर करें

प्रोमेथियस ( 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 पर एक सेवा बनाएगा।

यूआरएल तक पहुंचें http://localhost:9270/मेट्रिक्स , और यदि आप निम्नलिखित सामग्री देखते हैं, तो इसका मतलब है कि यह सफल रहा है।

चरण 5: प्रोमेथियस प्रारंभ करें

Prometheus शुरू करने के बाद, यह JMeter Prometheus प्लगइन से डेटा प्राप्त करना शुरू कर देगा। जैसा कि निम्नलिखित कॉन्फ़िगरेशन में दिखाया गया है, एक बार सफलतापूर्वक शुरू होने के बाद, आप Prometheus में सेट किए गए लक्ष्यों को देख सकते हैं।

चरण 6: ग्राफ़ाना को कॉन्फ़िगर करें

Grafana की आधिकारिक वेबसाइट पर, आधिकारिक साइट द्वारा प्रदान किया गया प्रोमेथियस-जेमीटर मॉनिटरिंग पैनल खोजें। यहाँ, हम ग्राफ़ाना में आयात करने के लिए आईडी 14927 के साथ टेम्पलेट का चयन करते हैं।

लोड पर क्लिक करने के बाद, Prometheus डेटा स्रोत का चयन करें।

• नोट: परीक्षण के दौरान, यह पाया गया कि मूल टेम्पलेट 14927 में कुछ त्रुटियाँ थीं। इस लेख के लेखन की प्रक्रिया के दौरान इन्हें ठीक कर दिया गया। यहाँ से डाउनलोड किया गया सुधारा गया टेम्पलेट आयात करें GitHub .

टेम्पलेट सफलतापूर्वक आयात होने के बाद, हम Grafana में संपूर्ण प्रदर्शन परीक्षण निगरानी डेटा देख पाएंगे।

संपूर्ण प्रदर्शन परीक्षण प्रक्रिया के त्वरित अनुभव की सुविधा के लिए, smart-doc समुदाय ने एक टेम्पलेट तैयार किया है और प्रदान किया है जिसे docker-compose का उपयोग करके एक ही कमांड के साथ लॉन्च किया जा सकता है। जो लोग Kubernetes परिनियोजन के माध्यम से इसका अनुभव करना चाहते हैं, उनके लिए AI टूल का उपयोग docker-compose टेम्पलेट को सीधे Kubernetes परिनियोजन टेम्पलेट में बदलने के लिए किया जा सकता है।

अनुभव के लिए परियोजना में उपयोग के निर्देश भी शामिल हैं।

इस लेख के लिए उदाहरण कोड यहां पाया जा सकता है यहाँ .

JMeter प्रदर्शन परीक्षण में स्मार्ट-डॉक की सहायता

प्रदर्शन तनाव परीक्षण के लिए smart-doc और जेमीटर का संयोजन कई लाभ प्रदान करता है:

• स्वचालन: smart-doc स्वचालित रूप से स्रोत कोड से API जानकारी निकाल सकता है और मैन्युअल लेखन की आवश्यकता के बिना JMeter प्रदर्शन परीक्षण स्क्रिप्ट उत्पन्न कर सकता है, जिससे दक्षता में काफी सुधार होता है।

• परिशुद्धता: smart-doc द्वारा उत्पन्न JMeter प्रदर्शन परीक्षण स्क्रिप्ट स्रोत कोड में API परिभाषाओं के साथ पूरी तरह से सुसंगत हैं, जिससे स्क्रिप्ट को मैन्युअल रूप से लिखते समय होने वाली त्रुटियों से बचा जा सकता है।

• लचीलापन: smart-doc विभिन्न कॉन्फ़िगरेशन विकल्पों का समर्थन करता है, जिससे उत्पन्न JMeter स्क्रिप्ट को परीक्षण आवश्यकताओं के अनुसार अनुकूलित किया जा सकता है।

smart-doc JMeter के लिए समर्थन को बेहतर और अनुकूलित करना जारी रखेगा। कृपया हमारे साथ बने रहें स्मार्ट-डॉक ओपन-सोर्स परियोजना का निरंतर विकास .

निष्कर्ष

smart-doc और जेमीटर को मिलाकर, हम न केवल एपीआई दस्तावेज़ों के निर्माण को स्वचालित कर सकते हैं, बल्कि प्रदर्शन परीक्षण स्क्रिप्ट भी तेज़ी से बना सकते हैं और तनाव परीक्षण कर सकते हैं। यह स्वचालन उपकरण विकास और परीक्षण दक्षता को महत्वपूर्ण रूप से बढ़ाता है, जबकि टीमों को सॉफ़्टवेयर सिस्टम के प्रदर्शन को अधिक आसानी से बनाए रखने और अनुकूलित करने में मदद करता है।

हमें आशा है कि यह आलेख आपको अपने दैनिक कार्यों में इन उपकरणों को अधिक कुशलतापूर्वक लागू करने के लिए व्यावहारिक संदर्भ प्रदान करेगा।

हम सभी का स्मार्ट-डॉक ओपन-सोर्स समुदाय का अनुसरण और समर्थन जारी रखने के लिए भी स्वागत करते हैं। भविष्य में, हम अधिक डेवलपर्स की सहायता के लिए अतिरिक्त भाषाओं के लिए समर्थन की खोज कर रहे हैं।