Spring Cloud 学习(17) --- Actuator(一) 常见端点、配置明细端点

在 Hystrix Dashboard 中,使用了 /actuator/hystrix.stream,查看正在运行的项目的运行状态。 其中 /actuator 代表 SpringBoot 中的 Actuator 模块。该模版提供了很多生产级别的特性,如:监控、度量应用。Actuator 的特性可以通过众多的 REST 端点,远程 shell、JMX 获得。

源码:https://gitee.com/laiyy0728/spring-cloud/tree/master/spring-boot-actuator

常见 Actuator 端点

Actuator endpoints 端点

路径省略前缀:/actuator

路径 HTTP 动作 描述
/conditions GET 提供了一份自动配置报告,记录哪些自动配置条件通过了,哪些没通过
/configprops GET 描述配置属性(包含默认值)如何注入 Bean
/caches GET 获取所有的 Cachemanager
/caches/{cache} DELETE 移除某个 CacheManager
/beans GET 描述应用程序上下文全部 bean,以及他们的关系
/threaddump GET 获取线程活动快照
/env GET 获取全部环境属性
/env/{toMatch} GET 获取指定名称的特定环境的属性值
/health GET 报告应用长须的健康指标,由 HealthIndicator 的实现提供
/httptrace GET 提供基本的 HTTP 请求跟踪信息(时间戳、HTTP 头等)
/info GET 获取应用程序定制信息,由 Info 开头的属性提供
/loggers GET 获取 bean 的日志级别
/loggers/{name} GET 获取某个 包、类 路径端点的日志级别
/loggers/{name} POST 新增某个 包、类 路径端点的日志级别
/mappings GET 描述全部的 URL 路径,以及它们和控制器(包含Actuator端点)的映射关系
/metrics GET 报告各种应用程序度量信息,如:内存用量、HTTP 请求计数
/metrics/{name} GET 根据名称获取度量信息
/shutdown POST 关闭应用,要求 endpoints.shutdown.enabled 为 true
/scheduledtasks GET 获取所有定时任务信息

SpringCloud 中,默认开启了 /actuator/health/actuator/info 端点,其他端点都屏蔽掉了。如果需要开启,自定义开启 endpoints 即可

management:
  endpoints:
    web:
      exposure:
        exclude: ['health','info','beans','env']

如果要开启全部端点,设置 exclude: * 即可


配置明细端点

引入pom文件,设置 yml

 <dependencies>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-actuator</artifactId>
      </dependency>
  </dependencies>
management:
  endpoints:
    web:
      exposure:
        include: '*'

beans 端点

使用 /actuator/beans 端点,获取 JSON 格式的 bean 装配信息。访问: http://localhost:8080/actuator/beans

{
    "contexts": {
        "application": {
            "beans": {
                "webEndpointDiscoverer": {    // bean 名称
                    "aliases": [],    // bean 别名
                    "scope": "singleton",   // bean 作用域
                    "type": "org.springframework.boot.actuate.endpoint.web.annotation.WebEndpointDiscoverer",   // bean 类型
                    "resource": "class path resource [org/springframework/boot/actuate/conditionsure/endpoint/web/WebEndpointconditionsuration.class]",   // class 文件物理地址
                    "dependencies": [   // 当前 bean 注入的 bean 的列表
                        "endpointOperationParameterMapper",
                        "endpointMediaTypes"
                    ]
                },
                "parentId": null
            }
        }
    }
}

conditions 端点

/beans 端点可以看到当前 Spring 上下文有哪些 bean, /conditions 端点可以看到为什么有这个 bean
SpringBoot 自动配置构建与 Spring 的条件化配置之上,提供了众多的 @Conditional 注解的配置类,根据 @Conditional 条件决定是否自动装配这些 bean。
/conditions 端点提供了一个报告,列出了所有条件,根据条件是否通过进行分组

访问 http://localhost:8080/actuator/conditions

{
    "contexts": {
        "application": {
            "positiveMatches": {    // 成功的自动装配
                "AuditEventsEndpointAutoConfiguration#auditEventsEndpoint": [{
                        "condition": "OnBeanCondition",   // 装配条件
                        "message": "@ConditionalOnBean (types: org.springframework.boot.actuate.audit.AuditEventRepository; SearchStrategy: all) found bean 'auditEventRepository'; @ConditionalOnMissingBean (types: org.springframework.boot.actuate.audit.AuditEventsEndpoint; SearchStrategy: all) did not find any beans"    // 装配信息
                    },
                    {
                        "condition": "OnEnabledEndpointCondition",
                        "message": "@ConditionalOnEnabledEndpoint no property management.endpoint.auditevents.enabled found so using endpoint default"
                    }
                ],
      },
            "negativeMatches": {      // 失败的自动装配
        "RabbitHealthIndicatorAutoConfiguration": {
          "notMatched": [   // 没有匹配到的条件
            {
              "condition": "OnClassCondition",
              "message": "@ConditionalOnClass did not find required class 'org.springframework.amqp.rabbit.core.RabbitTemplate'"
            }],
            "matched": []   // 匹配到的条件
          },
      },
            "unconditionalClasses": [     // 无条件装配
        "org.springframework.boot.actuate.autoconfigure.management.HeapDumpWebEndpointAutoConfiguration"
      ]
        }
    }
}

可以看到,在 negativeMatchesRabbitHealthIndicatorAutoConfiguration 自动状态,没有匹配到 org.springframework.amqp.rabbit.core.RabbitTemplate 类,所有没有自动装配。

env 端点

{
    "activeProfiles": [],   // 启用的 profile 
    "propertySources": [{
            "name": "server.ports",   // 端口设置
            "properties": {
                "local.server.port": {
                    "value": 8080   // 本地端口
                }
            }
        },
        {
            "name": "servletContextInitParams",   // servlet 上下文初始化参数信息
            "properties": {}
        },
        {
            "name": "systemProperties",     // 系统配置
            "properties": {
        "java.runtime.name": {    // 配置名称
          "value": "Java(TM) SE Runtime Environment"    // 配置值
        }
      }
        },
        {
            "name": "systemEnvironment",    // 系统环境
            "properties": {
        "USERDOMAIN_ROAMINGPROFILE": {    
          "value": "DESKTOP-QMHTL6V",   // 环境名称
          "origin": "System Environment Property \"USERDOMAIN_ROAMINGPROFILE\""   // 环境值
        }
      }
        },
        {
            "name": "applicationConfig: [classpath:/application.yml]",    // 配置文件信息
            "properties": {
                "management.endpoints.web.exposure.include": {      // 配置文件 key
                    "value": "*",       // 配置文件 value
                    "origin": "class path resource [application.yml]:5:18"    // 位置
                }
            }
        }
    ]
}

mappings 端点

mappings 端点可以生成一份 控制器到端点 的映射,即 访问路径与控制器 的映射

{
    "contexts": {
        "application": {
            "mappings": {
                "dispatcherServlets": {   // 所有的 DispatcherServlet
                    "dispatcherServlet": [{ // DispatcherServlet
                            "handler": "ResourceHttpRequestHandler [class path resource [META-INF/resources/], class path resource [resources/], class path resource [static/], class path resource [public/], ServletContext resource [/], class path resource []]",   // 处理器
                            "predicate": "/**/favicon.ico",   // 映射路径
                            "details": null
                        },
                        {
                            "handler": "public java.lang.Object org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping$OperationHandler.handle(javax.servlet.http.HttpServletRequest,java.util.Map<java.lang.String, java.lang.String>)",
                            "predicate": "{[/actuator/auditevents],methods=[GET],produces=[application/vnd.spring-boot.actuator.v2+json || application/json]}",   // 断言(包含端点、请求方式、类型等)
                            "details": {    // 详细信息
                                "handlerMethod": {  // 处理器
                                    "className": "org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping.OperationHandler", // handle 实现类
                                    "name": "handle", // 处理器名称
                                    "descriptor": "(Ljavax/servlet/http/HttpServletRequest;Ljava/util/Map;)Ljava/lang/Object;"    // 描述符
                                },
                                "requestMappingConditions": {   // 请求映射条件
                                    "consumes": [],   // 入参类型
                                    "headers": [],    // 入参头
                                    "methods": [      // 请求方式
                                        "GET"
                                    ],
                                    "params": [],     // 参数
                                    "patterns": [
                                        "/actuator/auditevents"   // 请求 URL
                                    ],
                                    "produces": [{    // 返回值类型
                                            "mediaType": "application/vnd.spring-boot.actuator.v2+json",
                                            "negated": false
                                        },
                                        {
                                            "mediaType": "application/json",
                                            "negated": false
                                        }
                                    ]
                                }
                            }
                        }
                    ]
                },
                "servletFilters": [{    // 所有 Filters
                        "servletNameMappings": [],    // servlet 名称映射
                        "urlPatternMappings": [
                            "/*"      // filter 过滤路径
                        ],
                        "name": "webMvcMetricsFilter",    // filter 名称
                        "className": "org.springframework.boot.actuate.metrics.web.servlet.WebMvcMetricsFilter"   // Filter 实现类
                    }
                ],
                "servlets": [{    // 所有 Servlet
                        "mappings": [],   // 映射
                        "name": "default",    // servlet 名称
                        "className": "org.apache.catalina.servlets.DefaultServlet"    // servlet 实现类
                    },
                    {
                        "mappings": [
                            "/"
                        ],
                        "name": "dispatcherServlet",
                        "className": "org.springframework.web.servlet.DispatcherServlet"
                    }
                ]
            },
            "parentId": null
        }
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,794评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,050评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,587评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,861评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,901评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,898评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,832评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,617评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,077评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,349评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,483评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,199评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,824评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,442评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,632评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,474评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,393评论 2 352