🤸 🏟️ 👱 स्प्रिंग बूट एक्ट्यूएटर का परिचय 💘 👨‍🔬 👈🏾

सलाम, ख़बरों को! एक सप्ताह में, पाठ्यक्रम "डेवलपर ऑन द स्प्रिंग फ्रेमवर्क" के नए समूह में शुरू हो जाएगा। इस संबंध में, हम आपके साथ उपयोगी सामग्री साझा करते हैं जो बताती है कि स्प्रिंग एक्ट्यूएटर क्या है और यह कैसे उपयोगी हो सकता है।

स्प्रिंग एक्ट्यूएटर क्या है?
मावेन या ग्रैडल परियोजना में स्प्रिंग एक्ट्यूएटर कैसे जोड़ें?
स्प्रिंग एक्ट्यूएटर निर्भरता के साथ स्प्रिंग बूट प्रोजेक्ट बनाएं।
स्प्रिंग ऐक्ट्यूएटर एंडपॉइंट्स के साथ एप्लीकेशन मॉनिटरिंग।

स्प्रिंग एक्ट्यूएटर क्या है?

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

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

मावेन या ग्रैडल परियोजना में स्प्रिंग एक्ट्यूएटर कैसे जोड़ें?

Maven

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

Gradle

 dependencies { compile("org.springframework.boot:spring-boot-starter-actuator") }

स्प्रिंग एक्ट्यूएटर के साथ स्प्रिंग बूट प्रोजेक्ट बनाना

चलो आगे बढ़ते हैं और स्प्रिंग एक्ट्यूएटर का उपयोग करके स्प्रिंग एक्ट्यूएटर, वेब, और देवटूल निर्भरता के साथ एक स्प्रिंग बूट प्रोजेक्ट बनाते हैं।

कृपया ध्यान दें कि इस लेखन के समय, स्प्रिंग बूट संस्करण 2.1.0 था।

परियोजना को ग्रहण या किसी अन्य आईडीई में आयात करें और SpringActuatorApplication.java ।

कंसोल में, आप निम्न देखेंगे:

आप देख सकते हैं कि एम्बेडेड SpringActuatorApplication 8080 पोर्ट पर चल रहा है, और SpringActuatorApplication चल रहा है। आप यह भी देख सकते हैं कि एक्ट्यूएटर एंडपॉइंट /actuator. पर उपलब्ध हैं /actuator.

 018-11-09 20:00:29.346 INFO 8338 --- [ restartedMain] osbwembedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path '' 2018-11-09 20:00:29.354 INFO 8338 --- [ restartedMain] nbjsSpringActuatorApplication : Started SpringActuatorApplication in 9.273 seconds (JVM running for 11.823) 2018-11-09 20:00:29.190 INFO 8338 --- [ restartedMain] osbaeweb.EndpointLinksResolver : Exposing 2 endpoint(s) beneath base path '/actuator'.

स्प्रिंग ऐक्ट्यूएटर एंडपॉइंट्स के साथ एप्लीकेशन मॉनिटरिंग

जैसा कि हमने ऊपर कहा, स्प्रिंग एक्ट्यूएटर कई एंडपॉइंट्स प्रदान करता है जिनका उपयोग हम एप्लिकेशन स्वास्थ्य की निगरानी के लिए कर सकते हैं।

आईडी	विवरण
auditevents	घटना की जानकारी प्रदान करता है वर्तमान आवेदन के लिए ऑडिट।
फलियां	सभी की पूरी सूची प्रदर्शित करता है आवेदन में वसंत सेम।
कैश	कैश की जानकारी।
स्थिति	हालत दिखाता है, जो विन्यास कक्षाओं के लिए गणना की गई और autoconfiguration, और कारणों, के लिए जो वे मेल खाते थे या नहीं वे मेल नहीं खाते।
configprops	सभी की सूची प्रदर्शित करता है @ConfigurationProperties
env	से गुण प्रदर्शित करता है ConfigurableEnvironment।
flyway	डेटाबेस माइग्रेशन दिखाता है फ्लाईवे जो लागू किया गया था।
स्वास्थ्य	स्वास्थ्य संबंधी जानकारी दिखाता है आवेदन।
httptrace	ट्रेस जानकारी प्रदर्शित करता है HTTP (डिफ़ॉल्ट रूप से, अंतिम 100 HTTP ) और जवाब किए जाते हैं।
जानकारी	अतिरिक्त जानकारी प्रदर्शित करता है आवेदन के बारे में।
integrationgraph	गिनती वसंत एकीकरण।
वालों	प्रदर्शित करता है और अनुमति देता है में लकड़हारा का विन्यास बदलें आवेदन।
liquibase	लागू माइग्रेशन दिखाता है लिकीबेस डेटाबेस
मैट्रिक्स	मेट्रिक्स जानकारी दिखाता है वर्तमान आवेदन के लिए।
मैपिंग	सभी रास्तों की सूची प्रदर्शित करता है। @RequestMapping।
scheduledtasks	अनुसूचित कार्यों को प्रदर्शित करता है (निर्धारित कार्य)।
सत्र	पुनर्प्राप्त करने और हटाने की अनुमति देता है रिपॉजिटरी से उपयोगकर्ता सत्र, स्प्रिंग सत्र द्वारा समर्थित। उपलब्ध नहीं है प्रतिक्रियाशील के लिए वसंत सत्र का उपयोग करते समय वेब अनुप्रयोग।
बंद	एप्लिकेशन को सही तरीके से अनुमति देता है काम पूरा करने के लिए।
threaddump	स्ट्रीम जानकारी प्रदर्शित करता है।

समापन बिंदु सक्षम करना

डिफ़ॉल्ट रूप से, shutdown को छोड़कर सभी समापन बिंदु सक्षम हैं। समापन बिंदु को सक्षम करने के लिए, application.properties फ़ाइल में निम्न गुण का उपयोग करें।

 management.endpoint.<code><</code>id<code>></code>.enabled

अनुवादक का ध्यान दें: डिफ़ॉल्ट रूप से, सभी समापन बिंदुओं तक पहुंच केवल JMX के माध्यम से है, HTTP के माध्यम से सभी समापन बिंदुओं तक पहुँच नहीं है (नीचे देखें)।

एक उदाहरण:

shutdown समापन बिंदु को सक्षम करने के लिए, हमें application.properties फ़ाइल में निम्नलिखित प्रविष्टि करने की आवश्यकता है:

 management.endpoint.shutdown.enabled=true

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

 management.endpoints.enabled-by-default=false management.endpoint.info.enabled=true

HTTP के माध्यम से एंडपॉइंट तक पहुंच

आइए स्थानीयहोस्ट URL पर जाएं: 8080 / एक्ट्यूएटर और उपलब्ध एंडपॉइंट को देखें।

नोट: मैं पोस्टमैन का उपयोग परीक्षण के लिए करता हूं क्योंकि यह JSON को एक अच्छी तरह से संरचित प्रारूप में दिखाता है। आप किसी अन्य उपकरण या सिर्फ एक ब्राउज़र का उपयोग कर सकते हैं।

जैसा कि आपने पहले ही देखा है, केवल health और info समापन बिंदु यहां दिखाए गए हैं। क्योंकि ये ही एंडपॉइंट हैं जो डिफ़ॉल्ट रूप से http के माध्यम से सुलभ हैं। Http के माध्यम से अन्य समापन बिंदुओं तक पहुंच सुरक्षा कारणों से डिफ़ॉल्ट रूप से बंद है, क्योंकि उनमें गोपनीय जानकारी हो सकती है और इसलिए, समझौता किया जा सकता है।

विशिष्ट समापन बिंदुओं तक पहुंच

यदि हम अन्य समापन बिंदुओं पर वेब (http) के माध्यम से पहुँच प्रदान करना चाहते हैं तो हमें application.properties फ़ाइल में निम्न प्रविष्टियाँ करने की आवश्यकता है।

 management.endpoints.web.exposure.include=<    ><a href="http://localhost:8080/actuator"></a>

एक उदाहरण :

 management.endpoints.web.exposure.include= health,info,env

अब, उपरोक्त प्रविष्टि को application.properties जोड़ने के बाद, आइए फिर से http: // localhost: 8080 / actuator पर जाएं

जैसा कि हम नीचे स्क्रीनशॉट में देखते हैं, env एंडपॉइंट भी शामिल है।

सभी समापन बिंदुओं तक पहुँच

यदि हम सभी समापन बिंदुओं को शामिल करना चाहते हैं, तो हम नीचे दिखाए गए अनुसार * साइन का उपयोग कर सकते हैं।

 management.endpoints.web.exposure.include=*

सभी के लिए पहुँच, लेकिन कुछ समापन बिंदु

नीचे दो प्रविष्टियाँ सभी समापन बिंदुओं को सक्रिय करती हैं, लेकिन env समापन बिंदु को निष्क्रिय कर देती हैं।

 management.endpoints.web.exposure.include=* management.endpoints.web.exposure.exclude=env

सभी HTTP समापन बिंदुओं को अक्षम करना

यदि आप HTTP के माध्यम से एंडपॉइंट्स प्रदान नहीं करना चाहते हैं, तो आप application.properties फ़ाइल में निम्न सेट करके ऐसा कर सकते हैं:

 management.server.port=-1

या तो:

 management.endpoints.web.exposure.exclude=*

एंडपॉइंट तक पहुंच के लिए URL कॉन्फ़िगर करें

डिफ़ॉल्ट रूप से, सभी एंडपॉइंट फॉर्म /actuator/{id} पते पर URL /actuator माध्यम से पहुंच योग्य हैं। हालाँकि, आप application.properties में निम्न गुण का उपयोग करके आधार पथ /actuator को बदल सकते हैं।

 management.endpoints.web.base-path

उदाहरण के लिए, यदि आप आधार /actuator बजाय आधार URL बनाना चाहते हैं, तो आप इस प्रकार कर सकते हैं:

 management.endpoints.web.base-path=/monitor

इस स्थिति में, सभी समापन बिंदु /actuator/{id} बजाय /monitor/{id} रूप में उपलब्ध होंगे।

समापन बिंदु स्प्रिंग बूट एक्ट्यूएटर

आइए कुछ सबसे महत्वपूर्ण समापन बिंदुओं पर चर्चा करें।

/ स्वास्थ्य

health समापन बिंदु आवेदन की समग्र स्थिति देता है: चाहे वह ऊपर और चल रहा हो या नहीं। यह उत्पादन में होने पर एप्लिकेशन की स्थिति की निगरानी के लिए बहुत महत्वपूर्ण है। यह समापन बिंदु निगरानी अनुप्रयोगों के साथ एकीकृत किया जा सकता है और वास्तविक समय में अनुप्रयोगों के स्वास्थ्य का निर्धारण करने के लिए बहुत उपयोगी होगा।

health एंडपॉइंट द्वारा दी गई जानकारी की मात्रा application.properties फ़ाइल में management.endpoint.health.show-details संपत्ति पर निर्भर करती है।

यदि management.endpoint.health.show-details=never , तो कोई अतिरिक्त जानकारी प्रदर्शित नहीं की जाती है। इस मामले में, आप केवल निम्नलिखित देखेंगे (यह डिफ़ॉल्ट व्यवहार है)।

यदि management.endpoint.health.show-details=always , तो अतिरिक्त जानकारी सभी उपयोगकर्ताओं को दिखाई जाती है। जैसा कि हम नीचे दिए गए उत्तर में देखते हैं, हमारे पास डिस्क स्थान (डिस्कस्पेस) के बारे में जानकारी है। यदि आपका एप्लिकेशन किसी डेटाबेस से जुड़ा है, तो आप डेटाबेस की स्थिति के बारे में भी जानकारी देखेंगे।

यदि management.endpoint.health.show-details=when-authorized , तो अतिरिक्त जानकारी केवल अधिकृत उपयोगकर्ताओं को दिखाई जाएगी। प्राधिकरण को management.endpoint.health.roles गुण का उपयोग करके कॉन्फ़िगर किया जा सकता है।

प्रीसेट संकेतक

स्प्रिंग बूट एक्ट्यूएटर ने आवेदन के विभिन्न हिस्सों के स्वास्थ्य का परीक्षण करने के लिए कई स्वचालित रूप से "स्वास्थ्य संकेतक" (HeathIndicators) को कॉन्फ़िगर किया है। उदाहरण के लिए, DiskspaceHealthIndicator स्पेस डिस्क जानकारी प्रदान करता है। यदि आप MongoDB का उपयोग कर रहे हैं, तो MongoHealthIndicator Mongo डेटाबेस (चाहे सर्वर चल रहा हो या नहीं) की जाँच करेगा और संबंधित जानकारी प्रदर्शित करेगा। डिफ़ॉल्ट रूप से, एप्लिकेशन की अंतिम स्थिति HealthAggregator द्वारा निर्धारित की HealthAggregator , जो प्रत्येक HealthIndicator द्वारा प्रदान की गई स्थितियों की सूची को HealthIndicator । सॉर्ट की गई सूची में पहली स्थिति का उपयोग एप्लिकेशन की अंतिम स्थिति के रूप में किया जाता है।

सभी पूर्व-कॉन्फ़िगर संकेतकों को अक्षम करना

ऊपर वर्णित "स्वास्थ्य संकेतक" डिफ़ॉल्ट रूप से सक्षम हैं, हालांकि, आप उन्हें निम्नलिखित संपत्ति का उपयोग करके बंद कर सकते हैं:

 management.health.defaults.enabled=false

किसी एक संकेतक को अक्षम करना

वैकल्पिक रूप से, आप एक अलग HealthIndicator को अक्षम कर सकते हैं, जैसा कि नीचे दिखाया गया है, उदाहरण के लिए, डिस्क स्थान जाँच को अक्षम करने के लिए:

 management.health.diskspace.enabled=false

नोट: किसी भी HealthIndicator का पहचानकर्ता HealthIndicator प्रत्यय के बिना बीन का नाम होगा।

उदाहरण के लिए :

 DiskSpaceHealthIndicator diskspace MongoHealthIndicator mongo CassandraHealthIndicator cassandra DataSourceHealthIndicator datasource

और इसी तरह ...

आपका संकेतक लिखना (स्वास्थ्यविद्)

स्प्रिंग बूट एक्ट्यूएटर द्वारा प्रदान किए गए अंतर्निहित HealthIndicator के साथ, हम कस्टम स्थिति संकेतक बना सकते हैं। ऐसा करने के लिए, आपको एक वर्ग बनाने की आवश्यकता है जो HealthIndicator इंटरफ़ेस को लागू करता है, इसके health() पद्धति को लागू करता है और Health को संबंधित जानकारी के साथ उत्तर के रूप में देता है, जैसा कि नीचे दिखाया गया है:

 import org.springframework.boot.actuate.health.Health; import org.springframework.boot.actuate.health.HealthIndicator; import org.springframework.stereotype.Component; @Component public class CustomHealthIndicator implements HealthIndicator { @Override public Health health() { int errorCode = 0; // In the above line,I am simple assigning zero,but you can call Health check related code like below commented line and that method can return the appropriate code. // int errorCode = performHealthCheck(); if (errorCode != 0) { return Health.down().withDetail("Error Code", errorCode).build(); } return Health.up().build(); } }

चलिए फिर से हेल्थ एंडपॉइंट पर जाते हैं और देखते हैं कि हमारा इंडिकेटर परिलक्षित होता है या नहीं।

हम अपना इंडिकेटर देखते हैं।

एकल घटक स्थिति

आप एक व्यक्तिगत घटक की स्थिति भी देख सकते हैं। उपरोक्त उदाहरण में, हमने देखा कि हमने लिखा संकेतक और डिस्कस्पेस।

यदि हम केवल डिस्क की स्थिति देखना चाहते हैं, तो हम निम्नलिखित URL का उपयोग कर सकते हैं:

http: // localhost: 8080 / एक्ट्यूएटर / हेल्थ / डिस्कस्पेस

/ जानकारी

info समापन बिंदु उस एप्लिकेशन के बारे में सामान्य जानकारी प्रदान करता है जो उसे build-info.properties या git.properties जैसी फ़ाइलों से प्राप्त git.properties , या git.properties में निर्दिष्ट गुणों से प्राप्त होती application.properties ।

चूंकि हमारी परियोजना में ऐसी कोई फ़ाइल नहीं है, इसलिए उत्तर रिक्त होगा, जैसा कि नीचे दिखाया गया है:

स्प्रिंग बूट एक्ट्यूएटर META-INF/build-info.properties सूचना का निर्माण करता META-INF/build-info.properties । यह प्रोजेक्ट जानकारी फ़ाइल build-info लक्ष्य द्वारा build-info समय पर बनाई गई है। यहां आप अतिरिक्त गुणों की एक मनमानी संख्या भी जोड़ सकते हैं।

चलो spring-boot-maven-plugin pom.xm spring-boot-maven-plugin के लिए एक build-info लक्ष्य pom.xm l में जोड़ें।

 <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <version>2.1.0.RELEASE</version> <executions> <execution> <goals> <goal>build-info</goal> </goals> <configuration> <additionalProperties> <encoding.source>UTF-8</encoding.source> <encoding.reporting>UTF-8</encoding.reporting> <java.source>${maven.compiler.source}</java.source> <java.target>${maven.compiler.target}</java.target> </additionalProperties> </configuration> </execution> </executions> </plugin>

अब, आइए फिर से info समापन बिंदु को देखें और विधानसभा की जानकारी देखें, जैसा कि नीचे दिखाया गया है:

इसके अलावा, हम एप्लिकेशन की जानकारी को info कुंजी के साथ application.properties में जोड़ सकते हैं, जैसा कि नीचे दिखाया गया है, और यह एंडपॉइंट /info पर प्रदर्शित किया जाएगा।

 info.application.name=spring-actuator info.application.description=spring boot actuator application info.application.version=0.0.1-SNAPSHOT

/ सेम

beans एंडपॉइंट प्रत्येक सेम के बारे में निम्नलिखित जानकारी के साथ स्प्रिंग कंटेनर में परिभाषित सभी beans दिखाता है:

 aliases :    scope :   type :    resource :  (),     dependencies :

उदाहरण के लिए, मैंने टेस्टकंट्रोलर नाम का एक रेस्टकंट्रोलर बनाया और एक घटक को इंजेक्ट किया, जिसे TestController कहा जाता है

 import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class TestController { @Autowired private TestService testService; @GetMapping("/messages") public String getMessage() { return "Hello"; } } import org.springframework.context.annotation.Configuration; @Configuration public class TestService { }

आप नीचे स्क्रीनशॉट में यह देख सकते हैं कि यह टेस्टकंट्रोलर के लिए कैसे दिखाया गया है।

/ configprops
configProps @ConfigurationProperties द्वारा एनोटेट की गई सभी @ConfigurationProperties ।

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

नीचे दिया गया स्क्रीनशॉट HttpTraceProperties स्रोत कोड @ConfigurationProperties द्वारा एनोटेट किया @ConfigurationProperties ।

/ एन.वी.

env एंडपॉइंट निम्नलिखित क्रम में सभी पर्यावरणीय जानकारी प्रदान करता है:

सिस्टम गुण	JVM निर्भर (प्लेटफ़ॉर्म स्वतंत्र)
सिस्टम वातावरण या चर परिवेश	संचालन पर निर्भर करता है सिस्टम (प्लेटफ़ॉर्म आश्रित)
अनुप्रयोग स्तर सेटिंग्स	में परिभाषित किया गया application.properties

/ हीपडम्प

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

/ लकड़हारा

loggers , एप्लिकेशन लॉगर को उनके कॉन्फ़िगर किए गए लॉग स्तर (कॉन्फ़िगरलेवल) और प्रभावी स्तर (प्रभावी लेवेल) के बारे में जानकारी प्रदान करता है। यदि लकड़हारा और उसके माता-पिता (अशक्त) के लिए कॉन्फ़िगर किया गया स्तर निर्दिष्ट नहीं है, तो रूट लकड़हारा स्तर एक प्रभावी स्तर होगा।

level संपत्ति इंगित करती है कि लॉगिंग फ्रेमवर्क द्वारा लॉगिंग स्तरों का समर्थन किया जाता है।

एक विशेष लकड़हारे के लिए जानकारी प्राप्त करने के लिए, /loggers बाद URL में लकड़हारा का नाम (आईडी) पास करें, जैसा कि नीचे दिखाया गया है:

http: // localhost: 8080 / actuator / loggers / nl.blogpsot.javasolutionsguide.springactuator.SpringActuatorApplication

/ मेट्रिक्स

metrics एंडपॉइंट उन सभी metrics दिखाता है जिन्हें आप अपने एप्लिकेशन के लिए ट्रैक कर सकते हैं।

व्यक्तिगत मैट्रिक्स की जाँच करना

आप एक मीट्रिक को url में /metrics बाद पास करके देख सकते /metrics , जैसा कि नीचे दिखाया गया है:

http: // localhost: 8080 / एक्ट्यूएटर / मेट्रिक्स / jvm.memory.used

संदर्भ

docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html
docs.spring.io/spring-boot/docs/current/actuator-api/html

स्थापित परंपरा के अनुसार, हम आपकी टिप्पणियों की प्रतीक्षा कर रहे हैं और सभी को खुले दिन के लिए आमंत्रित करते हैं , जो 23 मई को आयोजित किया जाएगा।

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

More articles: