应用监控之 SpringBoot Actuator 使用及配置

前言

  1. 一般JavaWeb应用都需要被管理以及监控,比如:查看应用所占的内存,还有查看应用的运行状态等等,这样做的目的就是对应用进行实时监控,避免应用出现问题了都无从查起。
  2. 我们都知道SpringBoot最牛的地方就是快速整合第三方技术,让我们能够快速开发,避免一些繁琐的配置。所有在SpringBoot中,也集成了监控功能的插件,就是SpringBoot Actuator

SpringBoot Actuator简介

  1. Actuator是SpringBoot项目中一个非常强大一个功能,有助于对应用程序进行监视和管理,通过restful api请求来监管、审计、收集应用的运行情况。
  2. Actuator的核心是端点Endpoint,它用来监视应用程序及交互,spring-boot-actuator中已经内置了非常多的Endpoint(health、info、beans、metrics、httptrace、shutdown等等),同时也允许我们自己扩展自己的Endpoints。
  3. 每个Endpoint都可以启用和禁用。要远程访问Endpoint,还必须通过JMX或HTTP进行暴露,大部分应用选择HTTP,Endpoint 的ID默认映射到一个带/actuator前缀的URL。例如,health端点默认映射到/actuator/health。

Endpoint端点介绍

Actuator的核心就是Endpoint,每一个Endpoint都代表着监控某一项数据。

端点 描述
auditevents 获取当前应用暴露的审计事件信息
beans 获取应用中所有的 Spring Beans 的完整关系列表
caches 获取公开可以用的缓存
conditions 获取自动配置条件信息,记录哪些自动配置条件通过和没通过的原因
configprops 获取所有配置属性,包括默认配置,显示一个所有 @ConfigurationProperties 的整理列版本
env 获取所有环境变量
flyway 获取已应用的所有Flyway数据库迁移信息,需要一个或多个 Flyway Bean
liquibase 获取已应用的所有Liquibase数据库迁移。需要一个或多个 Liquibase Bean
health 获取应用程序健康指标(运行状况信息)
httptrace 获取HTTP跟踪信息(默认情况下,最近100个HTTP请求-响应交换)。需要 HttpTraceRepository Bean
info 获取应用程序信息
integrationgraph 显示 Spring Integration 图。需要依赖 spring-integration-core
loggers 显示和修改应用程序中日志的配置
logfile 返回日志文件的内容(如果已设置logging.file.name或logging.file.path属性)
metrics 获取系统度量指标信息
mappings 显示所有@RequestMapping路径的整理列表
scheduledtasks 显示应用程序中的计划任务
sessions 允许从Spring Session支持的会话存储中检索和删除用户会话。需要使用Spring Session的基于Servlet的Web应用程序
shutdown 关闭应用,要求endpoints.shutdown.enabled设置为true,默认为 false
threaddump 获取系统线程转储信息
heapdump 返回hprof堆转储文件
jolokia 通过HTTP公开JMX bean(当Jolokia在类路径上时,不适用于WebFlux)。需要依赖 jolokia-core
prometheus 以Prometheus服务器可以抓取的格式公开指标。需要依赖 micrometer-registry-prometheus

SpringBoot Actuator使用及配置

  1. 上面介绍了Actuator以及Endpoint,接下来就开始使用它,只需要引入下面启动器依赖就可以使用Actuator了。

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- actuator -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    
  2. 在SpringBoot2.X中,Actuator 默认只开放 health 和 info 两个端点。我们先不做任何配置,直接启动SpringBoot项目,然后在浏览器输入:http://localhost:8080/actuator查看默认开放的端点,如下图所示:

    在这里插入图片描述

  3. 我们可以看到端点的访问地址都是以/actuator为前缀,这是SpringBoot默认设置的地址,我们可以在配置文件中修改,如下配置:

    management:
      endpoints:
        web:
          base-path: /myActuator
    
    在这里插入图片描述
  4. 恢复默认的访问路径,然后在浏览器上访问http://localhost:8080/actuator/health,如果出现UP表示应用程序正常运行。

    在这里插入图片描述

  5. 接下来暴露所有的端点Endpoint,如下配置:

        management:
          endpoints:
            web:
              base-path: /actuator #配置端点访问前缀
              exposure:
                include: '*' #暴露所有端点
    
    在这里插入图片描述
  6. 当然也可以禁用所有端点,如下配置:

    management:
      endpoints:
        web:
          base-path: /actuator #配置端点访问前缀
          exposure:
            include: '*' #暴露所有端点
        enabled-by-default: false #禁用所有端点
    
    在这里插入图片描述
  7. 关闭所有端点之后,可以指定暴露某个端点,如下配置:

    management:
      endpoints:
        web:
          base-path: /actuator #配置端点访问前缀
          exposure:
            include: '*' #暴露所有端点
        enabled-by-default: false #禁用所有端点
      endpoint:
        info:
          enabled: true #上面关闭所有端点之后,又暴露指定的端点,这里暴露info端点
    
  8. 还可以指定不暴露某个端点,下面首先暴露所有端点,然后又指定不暴露:infobeansenv这三个端点。

    management:
      endpoints:
        web:
          base-path: /actuator #配置端点访问前缀
          exposure:
            include: '*'  #暴露所有端点
            exclude: info,beans,env #在暴露所有端点的前提下,可以排除某个端点(不暴露)
    

详细介绍Endpoint

上面介绍了Actuator的使用,以及端点Endpoint的配置(暴露与不暴露),接下来再详细介绍常用的Endpoint。

health

  1. health主要用来检测应用的运行状况,是使用最多的一个监控点。
  2. 监控软件通常使用该接口实时监测应用运行状况,在系统出现故障时把报警信息推送给相关人员,如磁盘空间使用情况、数据库和缓存等的一些健康指标。
  3. 默认情况下health端点是开放的,访问http://127.0.0.1:8080/actuator/health即可看到应用运行状态。
  4. 如果应用程序正常时,默认访问会显示:{"status":"UP"}。如果需要更详细的信息,需要配置如下内容:
    management:
      endpoint:
        health:
          show-details: always
    
    在这里插入图片描述

info

查看应用信息是否在配置文件中配置。如我们在项目中配置是:

info:
  app:
    name: SpringBoot Actuator
    version: v1.0.0
    description: this is a SpringBoot Actuator Project
在这里插入图片描述

env

  1. 通过 env 可以获取到所有关于当前 SpringBoot 应用程序的运行环境信息,如:操作系统信息(systemProperties)、环境变量信息、JDK 版本及 ClassPath 信息、当前启用的配置文件(activeProfiles)、propertySources、应用程序配置信息(applicationConfig)等。
  2. 可以通过http://127.0.0.1:8080/actuator/env/{name},name表示想要查看的信息,可以独立显示。
    在这里插入图片描述

beans

  1. beans显示应用程序启动之后,SpringIOC容器注册了哪些Bean。
  2. 主要展示了 bean 的别名、类型、是否单例、类的地址、依赖等信息。


    在这里插入图片描述

总结

  1. 上面几种是比较常用的Endpoint,其他的Endpoint可以点击链接进行查看。附上官方说明文档:
    https://docs.spring.io/spring-boot/docs/2.2.1.RELEASE/reference/html/production-ready-features.html
  2. 此篇博客也为下面一篇博客打基础。
    SpringBoot2.X监控和管理神器:SpringBoot Admin
  3. 本篇博客源代码
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,319评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,801评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,567评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,156评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,019评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,090评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,500评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,192评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,474评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,566评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,338评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,212评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,572评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,890评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,169评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,478评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,661评论 2 335

推荐阅读更多精彩内容