Spring Boot Actuator
Spring Boot Actuator on Spring Boot Frameworkin osaprojekti. Se sisältää useita lisäominaisuuksia, jotka auttavat meitä valvomaan ja hallitsemaan Spring Boot -sovellusta. Se sisältää toimilaitteen päätepisteet (paikan, jossa resurssit asuvat). Voimme käyttää HTTP ja JMX päätepisteet Spring Boot -sovelluksen hallintaan ja valvontaan. Jos haluamme saada tuotantovalmiita ominaisuuksia sovellukseen, meidän tulee käyttää S pring Boot-toimilaite.
Spring Boot Actuator -ominaisuudet
On kolme Spring Boot Actuatorin pääominaisuudet:
Päätepiste: Toimilaitteen päätepisteiden avulla voimme valvoa sovellusta ja olla vuorovaikutuksessa sen kanssa. Spring Boot tarjoaa joukon sisäänrakennettuja päätepisteitä. Voimme myös luoda oman päätepisteemme. Voimme ottaa käyttöön ja poistaa käytöstä jokaisen päätepisteen erikseen. Suurin osa sovelluksista valitsee HTTP , jossa päätepisteen tunnus sekä etuliite /toimilaite, on yhdistetty URL-osoitteeseen.
Esimerkiksi, /terveys päätepiste tarjoaa sovelluksen perusterveystiedot. Toimilaite määritti sen oletusarvoisesti /toimilaite/terveys .
Mittarit: Spring Boot Actuator tarjoaa mittamittoja integroimalla sen kanssa mikrometri . Mikrometri on integroitu Spring Bootiin. Se on instrumentointikirjasto, joka toimii sovellusmittareiden toimittajana keväästä lähtien. Se tarjoaa toimittajaneutraalit rajapinnat ajastimet, mittarit, laskurit, jakeluyhteenvedot, ja pitkät tehtäväajastimet mittatietomallilla.
Tarkastaa: Spring Boot tarjoaa joustavan auditointikehyksen, joka julkaisee tapahtumia AuditEventRepository. Se julkaisee automaattisesti todennustapahtumat, jos jousisuojaus on käynnissä.
Spring Boot Actuatorin käyttöönotto
Voimme ottaa toimilaitteen käyttöön ruiskuttamalla riippuvuuden jousi-saapas-käynnistin-toimilaite pom.xml-tiedostossa.
org.springframework.boot spring-boot-starter-actuator 2.2.2.RELEASE
Spring Boot Actuator -päätepisteet
Toimilaitteen päätepisteiden avulla voimme valvoa Spring Boot -sovellustamme ja olla vuorovaikutuksessa sen kanssa. Spring Boot sisältää useita sisäänrakennettuja päätepisteitä, ja voimme myös lisätä mukautettuja päätepisteitä Spring Boot -sovellukseen.
Seuraavassa taulukossa kuvataan yleisesti käytetyt päätepisteet.
| Id | Käyttö | Oletus |
|---|---|---|
| toimilaite | Se tarjoaa hypermediapohjaisen löytösivu muille päätepisteille. Se vaatii Spring HATEOASin olevan luokkapolulla. | Totta |
| auditointitapahtumat | Se paljastaa nykyisen sovelluksen tarkastustapahtumatiedot. | Totta |
| autoconfig | Sitä käytetään näyttämään automaattisen määritysraportin, joka näyttää kaikki automaattisen konfiguroinnin ehdokkaat ja syyn, miksi niitä 'otettiin' tai 'ei' käytetty. | Totta |
| pavut | Sitä käytetään näyttämään täydellinen luettelo kaikista sovelluksesi kevätpavuista. | Totta |
| configprops | Sitä käytetään näyttämään lajiteltu luettelo kaikista @ConfigurationProperties. | Totta |
| kaatopaikka | Sitä käytetään lankavedon suorittamiseen. | Totta |
| env | Sitä käytetään Spring's ConfigurableEnvironmentin ominaisuuksien paljastamiseen. | Totta |
| lentotie | Sitä käytetään näyttämään kaikki Flyway-tietokantasiirrot, jotka on otettu käyttöön. | Totta |
| terveys | Sitä käytetään sovelluksen terveystietojen näyttämiseen. | Väärä |
| tiedot | Sitä käytetään mielivaltaisten sovellustietojen näyttämiseen. | Väärä |
| metsurit | Sitä käytetään näyttämään ja muokkaamaan sovelluksen loggerien asetuksia. | Totta |
| nestemäinen emäs | Sitä käytetään näyttämään kaikki Liquibase-tietokantasiirrot, jotka on otettu käyttöön. | Totta |
| mittareita | Sitä käytetään nykyisen sovelluksen mittaustietojen näyttämiseen. | Totta |
| kartoituksia | Sitä käytetään näyttämään lajiteltu luettelo kaikista @RequestMapping-poluista. | Totta |
| sammuttaa | Sitä käytetään sallimaan sovelluksen sulkeminen sulavasti. | Totta |
| jäljittää | Sitä käytetään jäljitystietojen näyttämiseen. | Totta |
Spring MVC:ssä käytetään seuraavia lisäpäätepisteitä.
| Id | Kuvaus | Oletus |
|---|---|---|
| asiakirjoja | Sitä käytetään dokumentaation näyttämiseen, mukaan lukien esimerkkipyynnöt ja -vastaukset toimilaitteen päätepisteille. | Väärä |
| kasan kaatopaikka | Sitä käytetään GZip-pakatun hprof-keon vedostiedoston palauttamiseen. | Totta |
| jolokia | Sitä käytetään JMX-papujen paljastamiseen HTTP:n kautta (kun Jolokia on luokkapolulla). | Totta |
| loki tiedosto | Sitä käytetään palauttamaan lokitiedoston sisältö. | Totta |
| prometheus | Sitä käytetään mittareiden paljastamiseen muodossa, jonka prometheus-palvelin voi kaapata. Se vaatii riippuvuuden mikrometrirekisteristä-prometheuksesta. | Totta |
Spring Boot toimilaitteen ominaisuudet
Spring Boot mahdollistaa kaikkien toimilaitteiden päätepisteiden turvallisuuden. Se käyttää lomakepohjainen todennus, joka tarjoaa käyttäjätunnus käyttäjänä ja satunnaisesti luotu Salasana . Voimme myös käyttää toimilaitteen rajoittamia päätepisteitä mukauttamalla perusauth-suojausta päätepisteisiin. Meidän on ohitettava tämä kokoonpano management.security.roles omaisuutta. Esimerkiksi:
merkki merkkijonoon java
management.security.enabled=true management.security.roles=ADMIN security.basic.enabled=true security.user.name=admin security.user.passowrd=admin
Esimerkki Spring Boot Actuatorista
Ymmärretään toimilaitteen käsite esimerkin kautta.
Vaihe 1: Avaa Spring Initializr https://start.spring.io/ ja luo a Maven hanke.
Vaihe 2: Tarjoa Ryhmä nimi. Olemme tarjonneet com.javatpoint.
Vaihe 3: Tarjoa Esine Id. Olemme tarjonneet spring-boot-actuator-esimerkki.
Vaihe 4: Lisää seuraavat riippuvuudet: Spring Web, Spring Boot Starter Actuator, ja Spring Data Rest HAL-selain .
Vaihe 5: Klikkaa Tuottaa -painiketta. Kun napsautamme Luo-painiketta, se käärii kaikki projektiin liittyvät tiedot a Jar tiedosto ja lataa sen paikalliseen järjestelmäämme.
Vaihe 6: Pura Jar-tiedosto ja liitä se STS-työtilaan.
Vaihe 7: Tuo projektikansio.
Tiedosto -> Tuo -> Olemassa olevat Maven-projektit -> Selaa -> Valitse kansio spring-boot-actuator-example -> Finish
Tuonti kestää jonkin aikaa. Projektin tuonnin jälkeen näemme projektihakemiston pakettien hallintaosiossa.
Vaihe 8: Luo Controller-luokka. Olemme luoneet ohjainluokan nimellä DemoRestController.
DemoRestController.java
package com.javatpoint; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class DemoRestController { @GetMapping('/hello') public String hello() { return 'Hello User!'; } } Vaihe 9: Avaa application.properties tiedosto ja poista toimilaitteen suojausominaisuus käytöstä lisäämällä seuraava lauseke.
application.properties
management.security.enabled=false
Vaihe 10: Suorita SpringBootActuatorExampleApplication.java tiedosto.
Vaihe 11: Avaa selain ja kutsu URL-osoite http://localhost:8080/actuator. Se palauttaa seuraavan sivun:
{'_links':{'self':{'href':'http://localhost:8080/actuator','templated':false},'health':{'href':'http://localhost:8080/actuator/health','templated':false},'health-path':{'href':'http://localhost:8080/actuator/health/{*path}','templated':true},'info':{'href':'http://localhost:8080/actuator/info','templated':false}}} Sovellus toimii oletuksena portissa 8080. Kun toimilaite on käynnistynyt, voimme nähdä luettelon kaikista HTTP:n kautta paljastetuista päätepisteistä.
Kutsutaan terveys päätepiste kutsumalla URL-osoite http://localhost:8080/actuator/health. Se ilmaisee tilan YLÖS . Se tarkoittaa, että sovellus on kunnossa ja toimii ilman keskeytyksiä.
Samalla tavalla voimme kutsua muita päätepisteitä, jotka auttavat meitä valvomaan ja hallitsemaan Spring Boot -sovellusta.
Lataa projekti