Skip to main content
Version: v1.6.x

springboot2

Collect and monitor the general performance metrics exposed by the SpringBoot 2.0 actuator.

Pre-monitoring operations

If you want to monitor information in 'SpringBoot' with this monitoring type, you need to integrate your SpringBoot application and enable the SpringBoot Actuator.

1、Add POM .XML dependencies:

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

2. Modify the YML configuration exposure metric interface:

management:
endpoints:
web:
exposure:
include: '*'
enabled-by-default: on

Note: If your project also introduces authentication related dependencies, such as springboot security, the interfaces exposed by SpringBoot Actor may be intercepted. In this case, you need to manually release these interfaces. Taking springboot security as an example, you should add the following code to the Security Configuration class:

public class SecurityConfig extends WebSecurityConfigurerAdapter{
@Override
protected void configure(HttpSecurity httpSecurity) throws Exception{
httpSecurity
// Configure the interfaces to be released -----------------------------------
.antMatchers("/actuator/**").permitAll()
.antMatchers("/metrics/**").permitAll()
.antMatchers("/trace").permitAll()
.antMatchers("/heapdump").permitAll()
// 。。。
// For other interfaces, please refer to: https://blog.csdn.net/JHIII/article/details/126601858 -----------------------------------
}
}

Configure parameters

Parameter nameParameter Help describes the
Monitor HostTHE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://).
Monitoring NameA name that identifies this monitoring that needs to be unique.
PortThe default port provided by the database is 8080.
Enable HTTPSWhether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443
The acquisition interval isMonitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds
Whether to probe theWhether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation
Description CommentFor more information identifying and describing the remarks for this monitoring, users can remark the information here

Collect metrics

metric Collection: Health

Metric Namemetric unitMetrics help describe
statusNoneService health: UP, Down

metric Collection: enviroment

Metric Namemetric unitMetrics help describe
profileNoneThe application runs profile: prod, dev, test
portNoneApply the exposed port
osNoneRun the operating system
os_archNoneRun the operating system architecture
jdk_vendorNonejdk vendor
jvm_versionNonejvm version

metric Collection: threads

Metric Namemetric unitMetrics help describe
stateNoneThread status
numberNoneThis thread state corresponds to

metric Collection: memory_used

Metric Namemetric unitMetrics help describe
spaceNoneMemory space name
mem_usedMBThis space occupies a memory size of