👨🏿‍🌾 🎖️ 🐤 स्प्रिंग बूट व्यवस्थापक ट्यूटोरियल 🤴 🕐 🌯

स्प्रिंग बूट एक्ट्यूएटर एंडपॉइंट्स के शीर्ष पर एक अच्छा उपयोगकर्ता इंटरफ़ेस के साथ अपने स्प्रिंग बूट एप्लिकेशन को नियंत्रित और प्रबंधित करें।

स्प्रिंग बूट एक्चुएटर

Actuator एक स्प्रिंग बूट मॉड्यूल है जो आपके एप्लिकेशन में REST / JMX समापन बिंदु जोड़ता है ताकि आप इसे आसानी से ट्रैक कर सकें और इसे उत्पादन परिवेश में प्रबंधित कर सकें। समापन बिंदु स्वास्थ्य जांच, मीट्रिक निगरानी, लॉग तक पहुंच, थ्रेड डंप, ढेर डंप, पर्यावरण संबंधी जानकारी और बहुत कुछ प्रदान करते हैं। लेखक ने निम्नलिखित लेख में एक्चुएटर के बारे में विस्तार से बात की है:

एक्चुएटर: स्प्रिंग बूट उत्पादन निगरानी और प्रबंधन
स्प्रिंग बूट एक्टुएटर 2.x के साथ अपने रनिंग एप्लिकेशन को मॉनिटर और प्रबंधित करें। मैट्रिक्स एकत्र करें या एप्लिकेशन के स्वास्थ्य की जांच करें।

अनुवादक द्वारा ध्यान दें। Habré पर एक समान लेख है:
स्प्रिंग बूट एक्ट्यूएटर का परिचय

स्प्रिंग बूट व्यवस्थापक

एक्चुएटर एक महान और शक्तिशाली उपकरण है, इसके अलावा, इसके एंडपॉइंट किसी अन्य एप्लिकेशन के साथ उपयोग करने के लिए आसान और सुविधाजनक हैं - आप सिर्फ REST सेवा कॉल का उपयोग करते हैं। हालांकि, एक्चुएटर का उपयोग करना किसी व्यक्ति के लिए बहुत सुविधाजनक नहीं है। उपयोगकर्ता के लिए एक अच्छा उपयोगकर्ता इंटरफ़ेस रखना बहुत आसान है जिसका उपयोग आप सभी मॉनिटरिंग डेटा को देखने और अपने एप्लिकेशन को प्रबंधित करने के लिए कर सकते हैं। यह ठीक वही है जो स्प्रिंग बूट एडमिन कार्य करता है। यह आपको एक्चुएटर एंडपॉइंट्स के शीर्ष पर एक सुविधाजनक यूजर इंटरफेस लेयर प्रदान करता है, जिसमें कुछ अतिरिक्त फीचर्स हैं।

स्प्रिंग बूट एडमिन स्प्रिंग टीम द्वारा प्रदान किया जाने वाला मॉड्यूल नहीं है, इसे एक कंपनी द्वारा बनाया गया था जिसे कोडेकेंट्रिक कहा जाता है। हालाँकि, इसका कोड सार्वजनिक रूप से जीथब पर उपलब्ध है और यह मुफ़्त है।

क्लाइंट और सर्वर

एक्चुएटर के विपरीत, स्प्रिंग बूट एडमिन में वास्तव में दो भाग होते हैं - क्लाइंट और सर्वर।

सर्वर भाग में व्यवस्थापक उपयोगकर्ता इंटरफ़ेस होता है और मॉनिटर किए गए अनुप्रयोगों के स्वतंत्र रूप से काम करता है। क्लाइंट भाग मॉनिटर किए गए एप्लिकेशन में स्थित है, जो सर्वर भाग में पंजीकृत है।

इस प्रकार, भले ही हमारा एप्लिकेशन काम नहीं करता है या ठीक से काम नहीं करता है, मॉनिटरिंग सर्वर अभी भी काम कर रहा है। अब कल्पना करें कि आपके पास कई एप्लिकेशन हैं (जैसे कि स्प्रिंग बूट माइक्रोसर्विस), और उनमें से प्रत्येक कई उदाहरणों में काम कर सकता है। पारंपरिक एक्ट्यूएटर मॉनिटरिंग के साथ, यह मुश्किल है, क्योंकि आपको उनमें से प्रत्येक को व्यक्तिगत रूप से एक्सेस करने की आवश्यकता है, और आपको कितने इंस्टेंस और कहां चल रहा है, इस पर नज़र रखने की आवश्यकता है।

स्प्रिंग बूट व्यवस्थापक का उपयोग करते समय, मॉनिटर किए गए एप्लिकेशन (क्लाइंट) का प्रत्येक उदाहरण लॉन्च होने के बाद सर्वर पर पंजीकृत होता है। फिर आपके पास एक एकल बिंदु (व्यवस्थापक सर्वर) है जहां आप उन सभी की जांच कर सकते हैं।

स्रोत कोड

समाप्त आवेदन के लिए स्रोत कोड इस Github भंडार में पाया जा सकता है ।

सर्वर सेटअप

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

प्रोजेक्ट बनाने के बाद, हमें जो पहली चीज़ चाहिए वह है स्प्रिंग बूट एडमिन सर्वर निर्भरता जोड़ना:

<dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-server</artifactId> <version>2.1.0</version> </dependency>

ध्यान दें कि हालांकि यह परियोजना Pivotal द्वारा नहीं बनाई गई थी, लेकिन आप स्प्रिंग आरंभिक व्यवस्थापक में स्प्रिंग बूट व्यवस्थापक के लिए क्लाइंट और सर्वर मॉड्यूल पा सकते हैं। अगला, हमें @EnableAdminServer एनोटेशन का उपयोग करके अपने मुख्य एप्लिकेशन वर्ग को एनोटेट करके एडमिन सर्वर को सक्षम करने की आवश्यकता है:

वह सब है। अब आप अपना आवेदन शुरू कर सकते हैं और पेज खोलने के बाद आपको इस तरह की स्क्रीन देखनी चाहिए:

सर्वर चल रहा है, लेकिन क्लाइंट अभी तक पंजीकृत नहीं हैं। चलो इसे ठीक करते हैं।

क्लाइंट सेटअप

सर्वर सेटअप के साथ के रूप में, पहला कदम मौजूदा अनुप्रयोग के लिए सही निर्भरता जोड़ना है:

 <dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-client</artifactId> <version>2.1.0</version> </dependency>

फिर आपको उस URL को निर्धारित करना होगा जहां आपका व्यवस्थापक सर्वर चल रहा है। इस लाइन को अपने एप्लिकेशन में जोड़ें।

 spring.boot.admin.client.url=http://localhost:8080

Actuator जोड़ना

अब आपको क्लाइंट और सर्वर दोनों को शुरू करने में सक्षम होना चाहिए। बस यह सुनिश्चित करें कि कोई पोर्ट संघर्ष नहीं है, क्योंकि दोनों अनुप्रयोग डिफ़ॉल्ट रूप से 8080 का उपयोग करते हैं। परीक्षण प्रयोजनों के लिए, आप अपने application.properties में server.port = 0 सेट कर सकते हैं ताकि आपका क्लाइंट स्टार्टअप पर एक यादृच्छिक पोर्ट का उपयोग करे। इस प्रकार, आप विभिन्न बंदरगाहों पर चल रहे कई उदाहरणों के प्रक्षेपण का परीक्षण कर सकते हैं।

जब आप व्यवस्थापक सर्वर उपयोगकर्ता इंटरफ़ेस खोलते हैं, तो आपको अपना आवेदन देखना चाहिए। जब आप एप्लिकेशन के नाम पर क्लिक करते हैं, तो आवेदन के बारे में जानकारी वाला एक पृष्ठ दिखाई देना चाहिए।

यदि आप कम से कम जानकारी के साथ ऊपर के समान स्क्रीन देखते हैं, तो इसका मतलब है कि आपके प्रोजेक्ट में एक्चुएटर नहीं है। याद रखें कि स्प्रिंग बूट एडमिन हुड के नीचे एक्चुएटर एंडपॉइंट्स का उपयोग करता है। सौभाग्य से, आपको बस एक साधारण निर्भरता जोड़ने की आवश्यकता है, और ऑटो-कॉन्फ़िगरेशन बाकी का ख्याल रखता है।

 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>

हालाँकि, अधिकांश एंडपॉइंट्स एक्ट्यूएटर में डिफ़ॉल्ट रूप से प्रदर्शित नहीं होते हैं। आपको उन्हें प्रकट करने के लिए अपने कॉन्फ़िगरेशन को application.properties में बदलना होगा:

 management.endpoints.web.exposure.include=*

Actuator समापन बिंदु प्रदान करने के बाद, आपको व्यवस्थापक इंटरफ़ेस में बहुत अधिक जानकारी देखनी चाहिए:

इस आलेख में स्प्रिंग बूट एक्ट्यूएटर को कॉन्फ़िगर करने के तरीके के बारे में एक विस्तृत गाइड पाया जा सकता है।
अनुवादक द्वारा ध्यान दें। और हैबे पर एक लेख में ।

सुरक्षा

अब जब सब कुछ काम कर रहा है, तो हमें यह सुनिश्चित करने की आवश्यकता है कि हमारे एक्ट्यूएटर एंडपॉइंट और व्यवस्थापक इंटरफ़ेस सभी के लिए सुलभ नहीं हैं।

ग्राहक सुरक्षा

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

 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency>

परीक्षण उद्देश्यों के लिए, आप अस्थायी रूप से प्रबंधन के साथ Actuator समापन बिंदु सुरक्षा को अक्षम कर सकते हैं। सुरक्षा = अक्षम = गलत । हालाँकि, हम चाहते हैं कि सुरक्षा सक्षम हो। यदि आप मूल प्रमाणीकरण का उपयोग करते हैं, तो आप केवल गुण फ़ाइल में उपयोगकर्ता नाम और पासवर्ड निर्दिष्ट कर सकते हैं। इन क्रेडेंशियल्स का उपयोग क्लाइंट ड्राइव के अंतिम बिंदु पर प्रमाणीकरण के लिए व्यवस्थापक सर्वर द्वारा किया जाएगा:

 spring.boot.admin.client.instance.metadata.user.name=joe spring.boot.admin.client.instance.metadata.user.password=my-secret-password

डिफ़ॉल्ट रूप से, जब तक अन्यथा कॉन्फ़िगर नहीं किया जाता है, डिफ़ॉल्ट रूप से स्प्रिंग बूट उपयोगकर्ता उपयोगकर्ता का उपयोग करता है और एप्लिकेशन शुरू होने पर हर बार स्वचालित रूप से उत्पन्न पासवर्ड। आप स्टार्टअप के दौरान कंसोल में पासवर्ड सत्यापित कर सकते हैं। यदि आप अपने एप्लिकेशन के लिए आवश्यक उपयोगकर्ता नाम और पासवर्ड स्पष्ट रूप से निर्दिष्ट करना चाहते हैं, तो आप उन्हें अपने गुणों में निर्दिष्ट कर सकते हैं:

 spring.security.user.name=joe spring.security.user.password=my-secret-password

सर्वर सुरक्षा

ग्राहक के साथ के रूप में, हमें एक स्प्रिंग सुरक्षा निर्भरता जोड़ने की आवश्यकता है:

 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency>

अब अपने एप्लिकेशन में लॉग इन करने के लिए आवश्यक उपयोगकर्ता नाम और पासवर्ड को कॉन्फ़िगर करें।

 spring.security.user.name=admin spring.security.user.password=admin-password

अब आपके क्लाइंट पर आपको इन क्रेडेंशियल्स को जोड़ने की आवश्यकता है, अन्यथा वह सर्वर पर पंजीकरण नहीं कर पाएगा:

 spring.boot.admin.client.username=admin spring.boot.admin.client.password=admin-password

अब वापस सर्वर की तरफ। व्यवस्थापक उपयोगकर्ता इंटरफ़ेस की सुरक्षा के लिए स्प्रिंग सुरक्षा कॉन्फ़िगरेशन को जोड़ने के लिए हमें आखिरी चीज़ चाहिए:

 @Configuration public class SecurityConfig extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler(); successHandler.setTargetUrlParameter("redirectTo"); successHandler.setDefaultTargetUrl("/"); http.authorizeRequests() .antMatchers("/assets/**").permitAll() .antMatchers("/login").permitAll() .anyRequest().authenticated().and() .formLogin().loginPage("/login") .successHandler(successHandler).and() .logout().logoutUrl("/logout").and() .httpBasic().and() .csrf() .csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse()) .ignoringAntMatchers( "/instances", "/actuator/**" ); } }

यह केवल लॉग इन करने के लिए मूल HTTP प्रमाणीकरण का उपयोग करके प्रमाणित उपयोगकर्ताओं के लिए व्यवस्थापक इंटरफ़ेस तक पहुंच प्रदान करेगा। स्वयं लॉगिन पृष्ठ और जावास्क्रिप्ट, HTML और CSS सहित स्थैतिक उपयोगकर्ता इंटरफ़ेस संसाधन खुले हैं। अन्यथा, आप लॉग इन नहीं कर पाएंगे। फिर कुकीज़ पर आधारित क्रॉस-साइट अनुरोधों (सीएसआरएफ, क्रॉस-साइट रिक्वेस्ट फॉरगिरी) के मिथ्याकरण के खिलाफ सुरक्षा है। आप देख सकते हैं कि CSRF सुरक्षा में कुछ रास्तों को नजरअंदाज किया जाता है - ऐसा इसलिए है क्योंकि व्यवस्थापन सर्वर के पास वर्तमान में उचित समर्थन नहीं है ।

अब रिबूट करने के बाद आपको अपने व्यवस्थापक सर्वर की सुरक्षा के लिए एक सुंदर लॉगिन स्क्रीन देखनी चाहिए:

बादल की खोज

स्प्रिंग बूट एडमिन क्लाइंट आपके एप्लिकेशन को सर्वर पर रजिस्टर करने का एकमात्र तरीका नहीं है। व्यवस्थापक सर्वर स्प्रिंग क्लाउड सर्विस डिस्कवरी का भी समर्थन करता है। आप आधिकारिक दस्तावेज में या " स्प्रिंग बूट एडमिन के साथ स्प्रिंग क्लाउड डिस्कवरी " लेख में अधिक पढ़ सकते हैं।

नोटिस

जैसे ही आपने निगरानी शुरू की है, आप चाहते हैं कि कुछ गलत होने पर आपको सूचित किया जाए। अच्छी खबर यह है कि स्प्रिंग एडमिन अधिसूचना विकल्पों की एक विस्तृत श्रृंखला प्रदान करता है।

यदि यह आपका पहली बार व्यवस्थापक सर्वर पृष्ठ पर जा रहा है, तो यह आपके कंप्यूटर पर पुश सूचनाओं को प्रदर्शित करने की अनुमति मांगता है। जब भी कोई समस्या होती है, तो आपको एक पॉप-अप संदेश प्राप्त होगा।

अन्य सूचनाओं को आसान सेटअप की आवश्यकता है। इसका मतलब आमतौर पर आपके आवेदन में कुछ प्रविष्टियां प्रदान करना होता है । वर्तमान में निम्नलिखित सेवाएं समर्थित हैं:

ईमेल सूचनाएँ सेट करें

यदि आप ईमेल सूचनाओं को सक्षम करना चाहते हैं, तो आपको अपने सर्वर पक्ष में स्प्रिंग ईमेल निर्भरता जोड़ने की आवश्यकता है:

 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency>

फिर आपको अपने एसएमटीपी सर्वर को निर्धारित करने की आवश्यकता है, जिसका उपयोग ईमेल द्वारा सूचनाएं और प्रमाण भेजने के लिए किया जाएगा। अपने व्‍यवस्‍थापक सर्वर के अप्‍लीकेशन अपडेट करें।

 spring.mail.host=smtp.foo.com spring.mail.username=smtp-server-user spring.mail.password=smtp-server-password

फिर आपको प्राप्तकर्ताओं और प्रेषकों की पहचान करने की आवश्यकता है।

 # Sender email address spring.boot.admin.notify.mail.from="Spring Boot Admin <noreply@foo.com>" # Comma-delimited list of recipient email addresses spring.boot.admin.notify.mail.to=alice@foo.com,bob@bar.com # Comma-delimited list of carbon copy recipient email addresses spring.boot.admin.notify.mail.cc=joe@foo.com

निष्कर्ष

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

स्प्रिंग बूट व्यवस्थापक ट्यूटोरियल