springboot actuator

了解Springboot Actuator,它提供了很多生产级的特性,比如说监控和度量spring boot应用程序。Actuator的这些特性可以通过众多的REST断点,远程shell和JMX获得。

加入依赖:

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

配置文件:

security.basic.enabled=false
management.security.enabled=false

之前的boot版本1.4.*不需要加入spring-boot-starter-security依赖,自己本demo使用的是1.5.4的版本,发现无法访问监控度量的web端点,在控制台上提示加入spring-boot-starter-security依赖及配置management.security.enabled=false

监控

  1. 描述应用程序上下文的全部beans,以及它们的关系
http://localhost:8080/beans
  1. 获取全部的环境变量
http://localhost:8080/env

包括系统属性,系统配置,配置文件application.properties配置文件中的属性。

增加配置文件db.properties

@SpringBootApplication
@PropertySource(value = "classpath:db.properties")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}
  1. 描述全部的URL路径,以及它们和控制器(包含Actuator断点)的映射关系。
http://localhost:8080/mappings
  1. 提供了一份自动配置报告,记录哪些自动配置条件通过了,哪些没有通过
    比如我人为的排除WebSocketAutoConfiguration,在监控上也可以反应出来。
@SpringBootApplication(exclude = {WebSocketAutoConfiguration.class})
@PropertySource(value = "classpath:db.properties")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}
http://localhost:8080/autoconfig
  1. 健康检查
    报告应用程序的健康指标,这些值由org.springframework.boot.actuate.health.HealthIndicator的实现类提供。

比如我在项目中加入mysql服务,如下监控

http://localhost:8080/health

当然不仅仅是mysql服务,springboot默认实现的监控还包括redis服务,mongodbsolrrabbitmqElasticsearch等等服务。

这些实现在spring-boot-actuator-1.5.4.RELEASE.jarorg.springframework.boot.actuate.health包下,

自定义健康检查
实现HealthIndicator接口,并纳入到spring容器的管理之中。

@Component
public class MyHealthIndicator implements HealthIndicator{

    @Override
    public Health health() {
        return Health.down().withDetail("error","spring boot error").build();
    }
}

这边举了简单的列子,并没有任何有意义的实现,实际开发中我们可以使用心跳检测监测一些外部调用服务的健康状态。

  1. 获取应用程序的定制信息,这些信息由info打头的属性提供
    在配置文件中配置:
info.hello.name=miaozhihao
info.hello.password=2312312ewr

配置的信息必须以info开头,只有在配置文件中配置了/info才能监控得到。

也可以配置一些git信息,配置哪些配置呢?可以看GitInfoContributor中的GitProperties这个类。

新建git.properties文件,在git.properties中配置:

git.branch=master
git.commit.id=23r234wfsadfasfsdfdsf2qerqwrwt
git.commit.time=20170801

查看url地址,发现可疑监控到git的版本信息。


源码分析
spring-boot-actuator-1.5.4.RELEASE.jar这个jar下的org.springframework.boot.actuate.endpoint包下
org.springframework.boot.actuate.endpoint.BeansEndpoint
org.springframework.boot.actuate.endpoint.HealthEndpoint
org.springframework.boot.actuate.endpoint.MetricsEndpoint等等。

比如说根据源码分析可以设置
endpoints.beans.enabled=false那么http://localhost:8080/beans就不显示了。

度量

对运行时度量情况做一个快照,这对评估应用程序的健康情况很有帮助。actuator提供了一系列的端点,让你能在运行时快速检查应用程序。

http://localhost:8080/metrics

查看某一项的度量值


springboot还提供了CounterService类和GaugeService类便于我们去度量。
CounterService :用来计数的服务,可以直接使用。
GaugeService :用来统计某个值,可以直接使用。

@RestController
public class UserController {

    @Autowired
    private CounterService counterService;

    @Autowired
    private GaugeService gaugeService;

    @GetMapping("/user/index/{id}")
    public String index(@PathVariable int id){
        counterService.increment("user home");
        if(2 == id){
            throw new NullPointerException();
        }
        return "user home";
    }

    @GetMapping("/user/price")
    public String getPrice(@RequestParam double price){
        gaugeService.submit("price",price);
        return "user price";
    }

}
http://localhost:8080/user/index/1
http://localhost:8080/user/index/2
http://localhost:8080/user/price?price=3423

Metric不仅可以输出到页面,还可以输出到jmx,redis等地方
通过向spring容器中装配一个MetricWriter来实现定向输出。
下面的demo就是向jmx实现定向输出,然后进行相关的操作之后就能在jconsole(jvisualvm,jmc)上面看到具体的度量,

@Configuration
public class ExportConfiguration {

    @Bean
    @ExportMetricWriter
    public MetricWriter metricWriter(MBeanExporter exporter){
        return new JmxMetricWriter(exporter);
    }
}

然后我们java的安装目录去查看相关工具的监控,

关于MetricWriter实现类,


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容