当前位置：网站首页>Boot indicator monitoring

Boot indicator monitoring

2022-06-26 18:46:00 【51CTO】

1、SpringBoot Actuator

1、 brief introduction

In the future, after every micro service is deployed on the cloud , We all need to monitor it 、 track 、 Audit 、 Control, etc. .
SpringBoot I'll take it Actuator scene , So that each of us Microservices Quick reference to get Production level application monitoring 、 Audit and other functions .

       
       <
       
       dependency
       
       >
       
       <
       
       groupId
       
       >org.springframework.boot
       
       </
       
       groupId
       
       >
       
       <
       
       artifactId
       
       >spring-boot-starter-actuator
       
       </
       
       artifactId
       
       >
       
       </
       
       dependency
       
       >
      
1.
2.
3.
4.

2、1.x And 2.x Different

Boot Indicator monitoring _ The server

3、 How to use

Introduce the scene
visit http://localhost:8080/actuator/ You can view various indicators

Recorded all kinds of http://localhost:8080/actuator/xxx xxx For monitoring endpoints
springboot Many monitoring endpoints are provided ----> Check out the official documents
All monitoring endpoints are enabled by default , But not all of them are exposed
Many monitoring endpoints JMX Way to expose , But not with WEB The way to expose

What endpoint is exposed by default ----> Look at the official documents
How to JMX、WEB Expose endpoints in a way ？？

Expose profile settings for monitoring endpoints

       
       management
       
       :
       
        endpoints
       
       : 
       
       # Configure the default for all endpoints 
       
        enabled-by-default
       
       : true 
       
       # Open all monitoring endpoints 
       
        web
       
       :
       
        exposure
       
       :
       
        include
       
       : 
       
       '*'  
       
       # With web Monitoring endpoints exposed in the way ,* Represents total exposure 
      
1.
2.
3.
4.
5.
6.

Test various monitoring endpoints

http://localhost:8080/actuator/beans Components in the current container
http://localhost:8080/actuator/conditions take effect | Don't take effect Automatic configuration of （ The current environment ）
http://localhost:8080/actuator/configprops Properties of the current application configuration
http://localhost:8080/actuator/env Environment variable information
http://localhost:8080/actuator/metrics Indicator information
http://localhost:8080/actuator/metrics/jvm.gc.pause An indicator of a specific item
http://localhost:8080/actuator/ Endpoint name / Details path
......

4、 visualization

Integrated visualization platform ----> Aspect view indicator monitoring

A free open source project ： https://github.com/codecentric/spring-boot-admin

The project can be used for indicator monitoring and safety monitoring -- Only use its indicator monitoring function
Detailed use steps ： See the address above gethub Introduce
Use steps ：

1、 Create a Monitoring server （ Equivalent to a project ）

stay pom Introduce in the file jar package

       
       <!-- Indicators monitor -->
       
       <
       
       dependency
       
       >
       
       <
       
       groupId
       
       >de.codecentric
       
       </
       
       groupId
       
       >
       
       <
       
       artifactId
       
       >spring-boot-admin-starter-server
       
       </
       
       artifactId
       
       >
       
       <
       
       version
       
       >2.3.1
       
       </
       
       version
       
       >
       
       </
       
       dependency
       
       >
       
<!-web Common in the development of -->
       
       <
       
       dependency
       
       >
       
       <
       
       groupId
       
       >org.springframework.boot
       
       </
       
       groupId
       
       >
       
       <
       
       artifactId
       
       >spring-boot-starter-web
       
       </
       
       artifactId
       
       >
       
       </
       
       dependency
       
       >
      
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

Add... On the startup entry class ：@EnableAdminServer annotation
modify Tomcat port , Do not project （ Microservices ） Port conflict for

2、 Register client , Put every micro service （ project ） Add to monitoring server

introduce jar package （ Indicators monitor （ Safe use to introduce ））

       
       <!-- Indicators monitor  -->
       
       <
       
       dependency
       
       >
       
       <
       
       groupId
       
       >de.codecentric
       
       </
       
       groupId
       
       >
       
       <
       
       artifactId
       
       >spring-boot-admin-starter-client
       
       </
       
       artifactId
       
       >
       
       <
       
       version
       
       >2.3.1
       
       </
       
       version
       
       >
       
       </
       
       dependency
       
       >
       
       <!-- Safe  -->
       
       <
       
       dependency
       
       >
       
       <
       
       groupId
       
       >org.springframework.boot
       
       </
       
       groupId
       
       >
       
       <
       
       artifactId
       
       >spring-boot-starter-security
       
       </
       
       artifactId
       
       >
       
       </
       
       dependency
       
       >
      
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

In microservice （ project ） Configure the port location of the monitoring server in also Expose all endpoints

spring.boot.admin.client.url=http://localhost:8080 （ Monitor server location ）
management.endpoints.web.exposure.include=*
spring.boot.admin.client.instance.prefer=true( Use ip Mode injection monitor )
spring.application.name= The name of the current project

In fact, the monitoring server calls the bottom of the project http://localhost:8080/actuator , We can also write a front-end monitoring page ourselves

Boot Indicator monitoring _ Applications _04

2、Actuator Endpoint （ Monitor endpoints ）

1、 The most commonly used endpoint

ID	describe
`auditevents`	Expose audit event information for the current application . Need one `AuditEventRepository Components` .
`beans`	Show all of the Spring Bean A complete list of .
`caches`	Expose available cache .
`conditions`	Display all condition information of automatic configuration , Include the reasons for the match or mismatch .
`configprops`	Show all `@ConfigurationProperties`.
`env`	expose Spring Properties of `ConfigurableEnvironment`
`flyway`	Show all the applied Flyway Database migration . Need one or more `Flyway` Components .
`health`	Display application health information .
`httptrace`	Show HTTP Tracking information （ By default , lately 100 individual HTTP request - Respond to ）. Need one `HttpTraceRepository` Components .
`info`	Display application information .
`integrationgraph`	Show Spring `integrationgraph` . Need to rely on `spring-integration-core`.
`loggers`	Display and modify the configuration of logs in the application .
`liquibase`	Show all the applied Liquibase Database migration . Need one or more `Liquibase` Components .
`metrics`	Shows the current application's “ indicators ” Information .
`mappings`	Show all `@RequestMapping` Path list .
`scheduledtasks`	Show scheduled tasks in the application .
`sessions`	Allow from Spring Session Retrieve and delete user sessions from supported session stores . Need to use Spring Session Based on the Servlet Of Web Applications .
`shutdown`	Make the application shut down normally . Default disabled .
`startup`	Show by `ApplicationStartup` Start up step data collected . Need to use `SpringApplication` To configure `BufferingApplicationStartup`.
`threaddump`	Execute thread dump .

If your application is Web Applications （Spring MVC,Spring WebFlux or Jersey）, You can use the following additional endpoints ：

ID	describe
`heapdump`	return `hprof` Heap dump file .
`jolokia`	adopt HTTP expose JMX bean（ Need to introduce Jolokia, Do not apply to WebFlux）. Need to introduce dependency `jolokia-core`.
`logfile`	Return the contents of the log file （ If set `logging.file.name` or `logging.file.path` attribute ）. Support use HTTP`Range` Header to retrieve the contents of some log files .
`prometheus`	With Prometheus The format that the server can grab exposes metrics . Need to rely on `micrometer-registry-prometheus`.

Most commonly used Endpoint

Health： health
Metrics： Runtime metrics
Loggers： logging

2、Health Endpoint （ Health check endpoint ）

Health check endpoint , We generally use it on cloud platforms , The platform will check the health of the application regularly , We just need Health Endpoint It can return a collection of health status of a series of components of the current application for the platform . Check the running status of the current program

Important points ：

Only one current application is displayed by default The overall state

Turn on Health Monitoring endpoint's Show in detail

       
       management
       
       :
       
        endpoints
       
       : 
       
       # Settings for all endpoints 
       
        enabled-by-default
       
       : true 
       
       # Open all monitoring endpoints 
       
        web
       
       :
       
        exposure
       
       :
       
        include
       
       : 
       
       '*'  
       
       # With web Monitoring endpoints exposed in the way ,* Represents total exposure 
       
        endpoint
       
       : 
       
       # Detailed settings for a certain endpoint 
       
        health
       
       :
       
        show-details
       
       : always      
       
       # Show health Monitor endpoint details 
      
1.
2.
3.
4.
5.
6.
7.
8.
9.

health endpoint The result returned , It should be a summary report after a series of health checks （ Database health 、redis Health, etc ）
Many health checks are automatically configured by default , such as ： database 、redis etc.
You can easily add a custom health check mechanism

Boot Indicator monitoring _ Applications _05

3、Metrics Endpoint ( Runtime metric endpoint )

Provide detailed 、 Hierarchical 、 Spatial index information , This information can be pull（ Take the initiative to push ） perhaps push（ Passive acquisition ） The way to get ;

adopt Metrics Docking multiple monitoring systems
Simplify the core Metrics Development
Add custom Metrics Or expand the existing Metrics
All kinds of Metrics The indicators are shown in the figure below

http://localhost:8080/actuator/metrics/ Specifically indicators An indicator of a specific item

Boot Indicator monitoring _ Applications _06

4、 Manage monitoring endpoints

1、 On and off Monitor endpoints

Default owned Endpoint Excepting shutdown It's all on .
Need to enable or disable Some Endpoint.

The configuration mode is management.endpoint. Endpoint name .enabled = true

       
       management
       
       :
       
        endpoint
       
       :
       
        beans
       
       :
       
        enabled
       
       : 
       
       true
      
1.
2.
3.
4.

Disable or enable all Endpoint

management.endpoints.enabled-by-default = true

       
       management
       
       :
       
        endpoints
       
       :
       
        enabled-by-default
       
       : 
       
       false
       
        endpoint
       
       :
       
        beans
       
       :
       
        enabled
       
       : 
       
       true
       
        health
       
       :
       
        enabled
       
       : 
       
       true
      
1.
2.
3.
4.
5.
6.
7.
8.

2、 expose Monitor endpoints

Exposure to support

HTTP： By default, only expose health and info Endpoint
JMX： Default exposure all Endpoint

JMX The way is java Provide the underlying data monitoring
DOS command ：jconsole You can see the present java Operation details

Excepting health and info, The rest Endpoint Should be protected access . If you introduce SpringSecurity, Security access rules are configured by default

ID	JMX	Web
`auditevents`	Yes	No
`beans`	Yes	No
`caches`	Yes	No
`conditions`	Yes	No
`configprops`	Yes	No
`env`	Yes	No
`flyway`	Yes	No
`health`	Yes	Yes
`heapdump`	N/A	No
`httptrace`	Yes	No
`info`	Yes	Yes
`integrationgraph`	Yes	No
`jolokia`	N/A	No
`logfile`	N/A	No
`loggers`	Yes	No
`liquibase`	Yes	No
`metrics`	Yes	No
`mappings`	Yes	No
`prometheus`	N/A	No
`scheduledtasks`	Yes	No
`sessions`	Yes	No
`shutdown`	Yes	No
`startup`	Yes	No
`threaddump`	Yes	No

3、 customized Endpoint

1、 customized Of a component health information

Custom status check information

Realization HealthIndicator Interface perhaps Inherit AbstractHealthIndicator abstract class
For implementing the interface Realization health Method

Judge in this method What is the condition of the component health / unhealthy
Health.up(); health
Health.down(); unhealthy

For inheritance AbstractHealthIndicator The abstract class Implement the... In the classification doHealthCheck Method

Judge in this method What is the condition of the component health / unhealthy
builder.up(); health
builder.budn(); unhealthy
builder.status（Status. state ）; Return detailed status

Set the specific display details

Health.down() .withDetail("key1", "value1") .withDetail("key2", "value2")......;

       
       // Implementation of the interface 
       
       @Component
       
       public 
       
       class 
       
       MyHealthIndicator 
       
       implements 
       
       HealthIndicator {
       
       @Override
       
       public 
       
       Health 
       
       health() {
       
       // Judge in this method   What is the condition of the component   health / unhealthy 
       
       int 
       
       errorCode 
       
       = 
       
       check(); 
       
       // perform some specific health check
       
       if (
       
       errorCode 
       
       != 
       
       0) {
       
       return 
       
       Health.
       
       down().
       
       withDetail(
       
       "Error Code", 
       
       errorCode).
       
       build();
       
        }
       
       return 
       
       Health.
       
       up().
       
       build();
       
    }
       
}
       
       // structure Health, The specific direction details returned 
       
       Health 
       
       build 
       
       = 
       
       Health.
       
       down()
       
                .
       
       withDetail(
       
       "msg", 
       
       "error service")
       
                .
       
       withDetail(
       
       "code", 
       
       "500")
       
                .
       
       withException(
       
       new 
       
       RuntimeException())
       
                .
       
       build();
       
}
      
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.

       
       management
       
       :
       
        health
       
       :
       
        enabled
       
       : 
       
       true
       
        show-details
       
       : always 
       
       # Always show details . The status information of each module can be displayed 
      
1.
2.
3.
4.

       
       // Inherit AbstractHealthIndicator The abstract class 
       
       @Component
       
       public 
       
       class 
       
       MyComHealthIndicator 
       
       extends 
       
       AbstractHealthIndicator {
       
       /**
       
       *  The real test method 
       
       * @param builder
       
       * @throws Exception
       
       */
       
       @Override
       
       protected 
       
       void 
       
       doHealthCheck(
       
       Health.
       
       Builder 
       
       builder) 
       
       throws 
       
       Exception {
       
       // Judge in this method   What is the condition of the component   health / unhealthy 
       
       //mongodb.  Get the connection to test 
       
       Map
       
       <
       
       String,
       
       Object
       
       > 
       
       map 
       
       = 
       
       new 
       
       HashMap
       
       <>();
       
       //  Check complete 
       
       if(
       
       1 
       
       == 
       
       2){
       
       // builder.up(); // health 
       
       builder.
       
       status(
       
       Status.
       
       UP);
       
       map.
       
       put(
       
       "count",
       
       1);
       
       map.
       
       put(
       
       "ms",
       
       100);
       
        }
       
       else {
       
       // builder.down();
       
       builder.
       
       status(
       
       Status.
       
       OUT_OF_SERVICE);
       
       map.
       
       put(
       
       "err",
       
       " Connection timeout ");
       
       map.
       
       put(
       
       "ms",
       
       3000);
       
        }
       
       builder.
       
       withDetail(
       
       "code",
       
       100)
       
                .
       
       withDetails(
       
       map);
       
    }
       
}
      
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.

2、 customized info Information （ Customize the details of the current application ）

There is nothing in the default customization information

There are two common customization methods ：

1、 Writing configuration files

       
       info
       
       :
       
        appName
       
       : boot-admin     
       
       # The name of the current app 
       
        version
       
       : 2.0.1          
       
       # The current version of the application 
       
        mavenProjectName
       
       : @[email protected]    
       
       # Use @@ Can get maven Of pom File value 
       
        mavenProjectVersion
       
       : @[email protected]
      
1.
2.
3.
4.
5.

2、 To write InfoContributor

Write configuration classes Realization InfoContributor Interface Medium contribute Method

stay contribute Method to write prompt information
builder .withDetail("key1", "value1") .withDetail("key2", "value2")......;

       
       import 
       
       java.
       
       util.
       
       Collections;
       
       import 
       
       org.
       
       springframework.
       
       boot.
       
       actuate.
       
       info.
       
       Info;
       
       import 
       
       org.
       
       springframework.
       
       boot.
       
       actuate.
       
       info.
       
       InfoContributor;
       
       import 
       
       org.
       
       springframework.
       
       stereotype.
       
       Component;
       
       @Component
       
       public 
       
       class 
       
       ExampleInfoContributor 
       
       implements 
       
       InfoContributor {
       
       @Override
       
       public 
       
       void 
       
       contribute(
       
       Info.
       
       Builder 
       
       builder) {
       
       builder.
       
       withDetail(
       
       "example",
       
       Collections.
       
       singletonMap(
       
       "key", 
       
       "value"));
       
    }
       
}
      
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

visit http://localhost:8080/actuator/info It will output all the data returned in the above way info Information

3、 customized Metrics Information

1、SpringBoot Support Automatic adaptation Metrics indicators

JVM metrics, report utilization of:

Various memory and buffer pools
Statistics related to garbage collection
Threads utilization
Number of classes loaded/unloaded

CPU metrics
File descriptor metrics
Kafka consumer and producer metrics
Log4j2 metrics: record the number of events logged to Log4j2 at each level
Logback metrics: record the number of events logged to Logback at each level
Uptime metrics: report a gauge for uptime and a fixed gauge representing the application’s absolute start time
Tomcat metrics (

server.tomcat.mbeanregistry.enabled

must be set to

true

for all Tomcat metrics to be registered)
Spring Integration metrics

2、 Add customization Metrics indicators

Mode one ：

In which class do you want to add indicator monitoring information ----- Add a... To this class Counter counter attribute

For this class Pass a in the constructor MeterRegistry Index factory

Invocation in construction method counter = meterRegistry.counter （" Index name "）;

stay Add... To other methods ：

counter.increment(); Method every time it is called +1

Mode two ：

Add... To the configuration class MeterBinder Components

Method return value ：return (registry) -> Gauge.builder("queueSize", queue::size).register(registry);

       
       // Mode one ：
       
       class 
       
       MyService{       
       
       // This is an ordinary Service class 
       
       Counter 
       
       counter;
       
       public 
       
       MyService(
       
       MeterRegistry 
       
       meterRegistry){ 
       
       // The constructor of this class 
       
       //MeterRegistry Index factory 
       
       counter 
       
       = 
       
       meterRegistry.
       
       counter(
       
       "myservice.method.running.counter");
       
       // Give the name of indicator gas 
       
    }
       
       public 
       
       void 
       
       hello() {
       
       counter.
       
       increment();   
       
       // This method is not called to count +1
       
    }
       
}
       
       // Mode two ：
       
       @Bean
       
       MeterBinder 
       
       queueSize(
       
       Queue 
       
       queue) {
       
       return (
       
       registry) 
       
       -> 
       
       Gauge.
       
       builder(
       
       "queueSize", 
       
       queue::
       
       size).
       
       register(
       
       registry);
       
}
      
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.

4、 Customize the monitoring endpoint

1、SpringBoot Default monitoring endpoint for

What we used above is springboot Default monitoring endpoint for
springboot There are many default monitoring points for -- You can view the official documentation | There are also
When we visit ： http://localhost:8080/actuator You can see the exposed monitoring endpoint

2、 Customize a monitoring endpoint

Customize the monitoring endpoint

Define a class
On this class Use @Endpoint(id = "container") Note that this class is a monitoring endpoint , And specify the endpoint name
On this class Use @Component Put it in a container
Write a reading method （ Method name 、 Return value custom ）, Add... To this method @ReadOperation
Write a writing method （ Method name 、void Customize ）, Add... To this method @WriteOperation

Use monitoring endpoints

open DOS：jconsole Use the methods in our monitoring endpoint

       
       @Component
       
       @Endpoint(
       
       id 
       
       = 
       
       "container")
       
       public 
       
       class 
       
       DockerEndpoint {
       
       @ReadOperation
       
       public 
       
       Map 
       
       getDockerInfo(){
       
       // Endpoint read operation 
       
       return 
       
       Collections.
       
       singletonMap(
       
       "info",
       
       "docker started...");
       
    }
       
       @WriteOperation
       
       private 
       
       void 
       
       restartDocker(){
       
       // Endpoint write operations 
       
       System.
       
       out.
       
       println(
       
       "docker restarted....");
       
    }
       
}
      
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.