《Spring Boot开发:从0到1》第11章 Spring Boot应用监控

第11章 Spring Boot Actuator与应用监控

Spring Boot的Actuator 将应用的很多信息暴露出来,如容器中的 bean,自动配置时的决策,运行时健康状态, metrics等等。Actuator提供了三中方式获取这些信息:

HTTP Endpoints
Remote Shell
JMX (MBeans) 当然通过继承指定的类来自定义一些 actuator信息,暴露自己想要的信息。

11.1 使用Spring Boot Actuator监控应用

1.Spring boot Actuator Endpoints介绍

Actuator是Spring Boot提供的附加特性,来帮我们监控和管理生产环境下运行时的应用程序。我们可以通过HTTP endpoints、JMX或者SSH来监控和管理应用的健康状况、系统指标、参数信息、内存状况等等。

Spring Boot Actuator所提供的HTTP监控服务如下表:

上面的这些HTTP服务,我们就叫Endpoint。Endpoint允许对应用进行上述健康状况、系统指标、参数信息、内存状况等指标的监控和交互。Spring Boot提供了很多内置的Endpoint,同时支持定制Endpoint。

Endpoint被暴露的方式取决于采用的技术(HTTP、JMX、SSH等),大部分应用采用HTTP的方式, 暴露的方式即通过Endpoint的ID映射成一个URL,例如 id=health 的内置Endpoint映射到URL=/health, 提供应用基础健康检查信息, 为了安全起见,一般不暴露在应用服务端口上,而是暴露在专门的管理端口上。

其中,重点挑两个讲一下。

/health 提供应用程序的健康状态,或者是某个核心模块的健康状态。例如,
数据库连接,磁盘使用情况等指标。

/metrics,这个endpoint显示Metrics 子系统管理的信息。主要是一些度量的值,比如系统的吞吐量,堆栈信息,耗时(timer),接口被触发的次数(meter,count),对象大小(gauge)等。metrics的监控主要分以下几种类型:

2.开启Actuator
很简单,只需要引入官方提供的starter:

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

3.定制Endpoint

Endpoint可以通过application.properties配置文件中的配置项进行定制, 格式如下:

endpoints.[name].[property]

有三个通用的property:

id: id
enable: 开关
sensitive: 是否需要权限控制才可以看到
以health为例,/health暴露的监控信息是所有实现了HealthIndicator接口的Bean。

通过自定义HealthIndicator实现定制health endpoint

@Component
public class HealthCheck implements HealthIndicator {
    @Override
    public Health health() {
        int errorCode = check(); // perform some specific health check
        if (errorCode != 0) {
            return Health.down().withDetail("Error Code", errorCode).build();
        }
        return Health.up().build();
    }

    public int check() {
        // Your logic to check health
        return 0;
    }
}

输出类似如下格式:

{
    "status" : "DOWN",
    "myHealthCheck" : {
        "status" : "DOWN",
        "Error Code" : 1,
        "Description" : "You custom MyHealthCheck endpoint is down"
     },
     "diskSpace" : {
         "status" : "UP",
         "free" : 209047318528,
         "threshold" : 10485760
     }
}

4.创建新的Endpoint

一般通过继承AbstractEndpoint<T>抽象类创建一个新的Endpoint, 或者直接实现Endpoint<T>接口,AbstractEndpoint<T>抽象类也实现了Endpoint<T>接口。

@Component
public class CustomEndpoint implements Endpoint<List<String>> {

    public String getId() {
        return "customEndpoint";
    }

    public boolean isEnabled() {
        return true;
    }

    public boolean isSensitive() {
        return true;
    }

    public List<String> invoke() {
        // Custom logic to build the output
        List<String> messages = new ArrayList<String>();
        messages.add("This is message 1");
        messages.add("This is message 2");
        return messages;
    }
}

id=customEndpoint, 对应的URL为/customEndpoint

输出信息格式如下:

[ "This is message 1", "This is message 2" ]

11.2 Spring Boot远程Shell

推荐阅读更多精彩内容

  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 43,360评论 6 343
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 129,424评论 18 137
  • 要加“m”说明是MB,否则就是KB了. -Xms:初始值 -Xmx:最大值 -Xmn:最小值 java -Xms8...
    dadong0505阅读 4,340评论 0 53
  • 第11章 Spring Boot应用监控 在实际的生产系统中,我们怎样知道我们的应用运行良好呢?我们往往需要对系统...
    禅与计算机程序设计艺术阅读 8,848评论 0 19
  • 我还是会继续想你,只不过往后的日子你好好过,我慢慢走。或许如果当初忍住只做朋友会不会更长久一点?可是我还没办法放弃...
    常常的常常阅读 84评论 0 0
  • 素材的重要性,为什么我们写作总是写到一般就卡住了,或者写着写着就写不下去了,原因就是没有积累写作素材,。 写作素材...
    简书一智阅读 483评论 2 8
  • 花,未曾开花 在无涯的荒草里 静默似一朵莲花 带有那盆花的人 点亮过我的人生 徒留流光转盼 背影缱绻,也不曾回头 ...
    空月儿阅读 135评论 0 0
  • 我也经历了这样一个选择,走技术路线,还是管理路线?之前也犹豫、摇摆了很久。 选择做管理,放下技术于心不忍,之前也做...
    向右奔跑阅读 335评论 0 2