教你开发脚手架集成Spring Boot Actuator监控的详细过程

< dependency >

    < groupId >org.springframework.boot</ groupId >

    < artifactId >spring-boot-starter-actuator</ artifactId >

</ dependency >

management:

    # 禁用执行器端点的安全检查

    security:

       enabled: false

{

     "status": "UP"

}

management:

   endpoints:

     web:

       exposure:

         # 包含所有端点使用 "*"，注意有引号

         include: info, health, beans, env, metrics

management.endpoint.health.show-details=always

management.health.redis.enabled=false

info:

   app:

     name: spring-boot-actuator

     version: 1.0.0

     test: test

     encoding: @project.build.sourceEncoding@

     source: @java.version@

     target: @java.version@

{

     "app": {

         "name": "spring-boot-actuator",

         "version": "1.0.0",

         "test": "test",

         "encoding": "UTF-8",

         "source": "1.8.0_102",

         "target": "1.8.0_102"

     }

}

< dependency >

    < groupId >org.springframework.boot</ groupId >

    < artifactId >spring-boot-starter-security</ artifactId >

</ dependency >

@Configuration

public class ActuatorSecurityConfig extends WebSecurityConfigurerAdapter {

     /*

      * version1:

      * 1. 限制 '/shutdown'端点的访问，只允许ACTUATOR_ADMIN访问

      * 2. 允许外部访问其他的端点

      * 3. 允许外部访问静态资源

      * 4. 允许外部访问 '/'

      * 5. 其他的访问需要被校验

      * version2:

      * 1. 限制所有端点的访问，只允许ACTUATOR_ADMIN访问

      * 2. 允许外部访问静态资源

      * 3. 允许外部访问 '/'

      * 4. 其他的访问需要被校验

      */

     @Override

     protected void configure(HttpSecurity http) throws Exception {

         // version1

//        http

//                .authorizeRequests()

//                    .requestMatchers(EndpointRequest.to(ShutdownEndpoint.class))

//                        .hasRole("ACTUATOR_ADMIN")

//                .requestMatchers(EndpointRequest.toAnyEndpoint())

//                    .permitAll()

//                .requestMatchers(PathRequest.toStaticResources().atCommonLocations())

//                    .permitAll()

//                .antMatchers("/")

//                    .permitAll()

//                .antMatchers("/**")

//                    .authenticated()

//                .and()

//                .httpBasic();

         // version2

         http

                 .authorizeRequests()

                 .requestMatchers(EndpointRequest.toAnyEndpoint())

                     .hasRole( "ACTUATOR_ADMIN" )

                 .requestMatchers(PathRequest.toStaticResources().atCommonLocations())

                     .permitAll()

                 .antMatchers( "/" )

                     .permitAll()

                 .antMatchers( "/**" )

                     .authenticated()

                 .and()

                 .httpBasic();

     }

}

# Spring Security Default user name and password

spring.security.user.name=actuator

spring.security.user.password=actuator

spring.security.user.roles=ACTUATOR_ADMIN

@Component

public class EasyAdminHealthIndicator extends AbstractHealthIndicator {

     @Override

     public void doHealthCheck(Health.Builder builder) throws Exception {

         boolean checkHealth = check();

         if (checkHealth) {

             builder.up();

         } else {

             builder.down();

         }

         builder.withDetail( "code" , "200" )

                 .withDetail( "msg" , "i am ok" );

     }

     private boolean check() {

         return true ;

     }

}

{

     "status": "UP",

     "components": {

         "db": {

             "status": "UP",

             "details": {

                 "database": "MySQL",

                 "validationQuery": "isValid()"

             }

         },

         "diskSpace": {

             "status": "UP",

             "details": {

                 "total": 332861009920,

                 "free": 312464228352,

                 "threshold": 10485760,

                 "exists": true

             }

         },

         "easyAdmin": {         // do do do

             "status": "UP",

             "details": {

                 "code": "200",

                 "msg": "i am ok"

             }

         },

         "mail": {

             "status": "UP",

             "details": {

                 "location": "smtp.qq测试数据:-1"

             }

         },

         "ping": {

             "status": "UP"

         }

     }

}

Gauge.builder("gn.temperature.gauge", new AtomicInteger(37), AtomicInteger::get)

registry.gauge("gn.temperature.gauge", Tags.of("site", "SiteA", "cab", "cab01"), new AtomicInteger(37));

Counter counter = Counter.builder("gn.beat.counter")

   .tags("site", "SiteA", "function", "foo")

   .description("for request errors")

   .register(registry);

counter.increment();

@Component

public class SampleBean {

     private final Counter counter;

     private final List<String> list = new CopyOnWriteArrayList<>();;

     public SampleBean(MeterRegistry registry) {

         this .counter = registry.counter( "laker.counter" );

          registry.gauge( "laker.size" , Tags.empty(), this .list.size());

     }

     public void handleMessage(String message) {

         this .counter.increment();

         list.add(message);

     }

     public void handleRemoveMessage(String message) {

         list.remove(message);

     }

}

@Bean

public class MyMetrics implements MeterBinder {

    @Override

    public void bindTo(MeterRegistry meterRegistry) {

     //此处添加相关指标

     meterRegistry.gauge( "laker.gauge" , Tags.of( "site" , "SiteA" ), new AtomicInteger( 37 ));

    }

}

@SpringBootApplication

public class LakerMapApplication {

     public static void main(String[] args) {

         SpringApplication springApplication = new SpringApplication(LakerMapApplication. class );

         springApplication.addListeners( new ApplicationPidFileWriter(), new WebServerPortFileWriter( "./laker.port" ));

         springApplication.run(args);

     }

}

spring:

   pid:

     # 写入pid的文件

     file: ./laker.pid

     # 当无法写入pid文件的时候，是否抛出异常

     fail-on-write-error: false

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

management.endpoints.web.base-path=/

management.endpoints.web.path-mapping.health=healthcheck

management.server.port=8081

management.server.address=127.0.0.1

<!-- Micrometer Prometheus registry  -->

< dependency >

     < groupId >io.micrometer</ groupId >

     < artifactId >micrometer-registry-prometheus</ artifactId >

</ dependency >