老司机的应用级监控——spring?actuator

http://mt.sohu.com/20160824/n465783118.shtml

************************************************

　　1什么是spring actuator?

　　这是一个研发老司机与运维同学都会非常喜欢的东西，随着点融集团的扩张，点融网的业务越来越复杂、服务越来越多，不论是微服务还是SOA都会大大加重运维的负担。这时在应用层提供统一、强大的监控接口对于自动化运维来讲就显得非常重要！

对于研发来讲，可以在应用启动后拿到应用的各种数据，非常便于调试应用、分析应用的运行状况，并且不需要研发去实现这些监控功能。

　　对于运维来讲，可以监控应用的健康信息、统计应用的瞬时信息。发现应用挂掉了、发现瞬时信息不正常都可以发送报警信息， 也可以将信息拉到监控系统的数据系统中，再展示到漂亮的UI上实时监控应用的运行状态。这些actions 无疑将会大大保证系统的整体质量。

　　而集成了actuator的springboot应用会在约定的endpoints上暴露自己应用的内部信息，又强大又统一标准，满足复杂分布式系统的监控需求，一些endpoints简介如下：

Path	Deion
health	展示系统的各种组件运行状态、硬盘使用状况
metrics	统计系统当前的一些瞬时信息，如：该系统接收了多少个请求、cache命中率、mq中有多少条信息待处理、CPU使用率、内存占用情况 等，后面会有更加详细的介绍。
dump	当前系统中线程的详细信息
env	展示系统变量 和 springboot的应用变量
trace	显示最近的http请求的request、response对（默认最多缓存100条）
autoconfig	展示所有auto-configuration候选者及它们被应用或未被应用的原因
info	显示应用自定义的信息：如该应用的联系人、名称、版本等
configprops	显示所有被@ConfigurationProperties mark的Bean的信息列表
mappings	显示所有@RequestMapping mark 的url list
shutdown	允许以POST方式关闭应用
beans	显示该应用中所有Spring Beans的完整信息，包括依赖了哪些bean、是singleton还是prototype

　　研发会重点关注绿色的五项、而运维更关注深绿色的两项，其他项笔者暂时没有发现有特别的用处...

　　2如何在springboot应用中enable actuator？

　　compile

　　'org.springframework.boot:spring-boot-starter-actuator:1.3.6.RELEASE'

　　3自定义已有的endpoints

　　1） 每个endpoint都可以在application.properties里面用 endpoints.[endpoint].[id|sensitive|enabled]来重定义其默认值。

　　例如：

这样就将autoconfig这个endpoint的path修改为了auto_cfg，本着约定优于配置原则，没有特殊需求，笔者不建议做此类修改。

　　2） 自定义 /health endpoint

　　当springboot应用跑起来之后，你可以通过访问该接口获得应用的健康状态。

例如，图片中的 “ status:"UP" ” 即表明应用的健康状态，diskSpace 当中的单位为bytes. 表明了该应用目前硬盘的健康状态：

　　红色箭头为我在health endpoint中自定义的 rabbitMQ healthCheckIndicator. 用于检查我的应用所依赖的rabbitMQ的健康状态。具体实现方式如下：

　　您需要实现HealthIndicator 接口或者继承AbstractHealthIndicator

3） 自定义 /metrics endpoint

　　正如一的表格当中所讲的， metrics是最重要的endpoint之一。

红色箭头所指向两个gauge指标是我fake的一个queue所对应有几个consumer, 有几条还在queue中未被消费的消息数量，具体自定义方式如下：

如果想要自定义一些metrics， 如api的访问次数、消息数量成功处理次数、消息处理失败次数则可以自定义如下，也会展示在metrics接口中：

4） 自定义 /info endpoint 　　在application.properties中， 添加自定义字段，如下

访问效果：

4创建一个新的endpoint

　　您需要实现Endpoint 接口或者继承AbstractEndpoint。

访问效果：

还有其他的一些自定义，开发可以不用特别关心 。

　　5非Springboot的Spring应用, 集成spring actuator

　　添加依赖：

　　compile('org.springframework.boot:spring-boot-actuator'){ exclude group: 'org.springframework.boot',

　　module:'spring-boot-starter-logging'}

　　1） 使用 AnnotationConfigWebApplicationContext :

　　并在 Spring初始化config bean的上面添加@EnableAutoConfiguration 即可。详情见附录3。

　　2） 使用 XML 方式的nonboot - spring 应用

　　在任一Spring生命周期的Component bean上 添加@EnableAutoConfiguration 即可。

　　也可以@Autowire 这些Endpoint自定义访问路径。详情见附录4

　　术语解释：

术语	描述
Gauge	Gauge代表一个度量的即时值。当你开汽车的时候，当前速度是Gauge值。你测体温的时候，体温计的刻度是一个Gauge值。当你的程序运行的时候，内存使用量和CPU占用率都可以通过Gauge值来度量。
Counter	Counter是一个AtomicLong实例，可以增加或者减少值。例如，可以用它来计数队列中加入的Job的总数、可以统计api总计的访问次数。

　　附录：

1. 集成springboot actuator到非springboot spring应用中 ： https://stackoverflow.com/questions/26913087/use-spring-boot-actuator-without-a-spring-boot-application

2. 本文所用的springboot源码： https://github.com/Agileaq/springboot-actuator

3. 非springboot的annotationConfig spring web应用源码： https://github.com/Agileaq/nonboot-actuator-example

4. 非springboot的xml base web应用源码： https://github.com/Agileaq/nonboot-xml-spring-actuator

5. English version of Spring Actuator introduction： http://www.baeldung.com/spring-boot-actuators

6. 黑帮文章——神荼之眼监控系统（后台回复【神荼之眼】即可查看）

7. 黑帮文章——高颜值绘图工具Grafana（后台回复【Grafana】即可查看）

　　

本文作者：钱晟龙 Arc_Qian（点融黑帮），现任点融网架构组产品研发工程师，主要任务是思考并尝试解决各类点融网迈出第一公里之后遇到的现实问题。

　　随着点融网新一轮融资，点融网即将开始大规模的扩张，需要各种优秀人才的加入，如果你觉得自己够优秀，欢迎加入我们！获取更多职位信息，请关注点融黑帮。