Spring Boot 2.X(十六)：应用监控之 Spring Boot Actuator 使用及配置

时间 2019-11-13

标签 spring boot 2.x 十六应用监控 actuator 使用配置栏目 Spring 繁體版

原文原文链接

Actuator 简介

Actuator 是 Spring Boot 提供的对应用系统的自省和监控功能。经过 Actuator，可使用数据化的指标去度量应用的运行状况，好比查看服务器的磁盘、内存、CPU等信息，系统的线程、gc、运行状态等等。html

Actuator 一般经过使用 HTTP 和 JMX 来管理和监控应用，大多数状况使用 HTTP 的方式。git

Actuator 端点说明

端点	描述
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

Actuator 使用及配置

快速使用

项目依赖

<dependencies>
        <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>
</dependencies>

配置文件

management.endpoints.enabled-by-default=true
#启动全部端点
management.endpoints.web.exposure.include=*
#自定义管理端点路径
#management.endpoints.web.base-path=/manage

Spring Boot 2.X 中，Actuator 默认只开放 health 和 info 两个端点。github

添加management.endpoints.web.exposure.include=*配置后启动应用，访问 http://127.0.0.1:8080/actuator 咱们能够看到全部的 Actuator 端点列表。web

若是将management.endpoints.enabled-by-default设置为false，则禁用全部端点，如需启用则以下:spring

management.endpoints.enabled-by-default=false
management.endpoint.info.enabled=true

禁用的端点将从应用程序上下文中彻底删除。若是只想更改公开端点，使用include和exclude属性。使用以下：数据库

management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env,beans

management.endpoints.web.base-path=/manage 配置表示将 /actuator 路径重定义为 /manage。缓存

经常使用端点详解

health

主要用来检测应用的运行情况，是使用最多的一个监控点。监控软件一般使用该接口实时监测应用运行情况，在系统出现故障时把报警信息推送给相关人员，如磁盘空间使用状况、数据库和缓存等的一些健康指标。
默认状况下 health 端点是开放的，访问 http://127.0.0.1:8080/actuator/health 便可看到应用运行状态。tomcat

{"status":"UP"}

若是须要看到详细信息，则须要作添加配置：springboot

management.endpoint.health.show-details=always

访问返回信息以下：服务器

{"status":"UP","details":{"diskSpace":{"status":"UP","details":{"total":180002725888,"free":8687988736,"threshold":10485760}}}}

info

查看应用信息是否在 application.properties 中配置。如咱们在项目中配置是：

info.app.name=Spring Boot Actuator Demo
info.app.version=v1.0.0
info.app.description=Spring Boot Actuator Demo

启动项目，访问 http://127.0.0.1:8080/actuator/info 返回信息以下：

{"app":{"name":"Spring Boot Actuator Demo","version":"v1.0.0","description":"Spring Boot Actuator Demo"}}

env

经过 env 能够获取到全部关于当前 Spring Boot 应用程序的运行环境信息，如：操做系统信息（systemProperties）、环境变量信息、JDK 版本及 ClassPath 信息、当前启用的配置文件（activeProfiles）、propertySources、应用程序配置信息（applicationConfig）等。

能够经过 http://127.0.0.1:8080/actuator/env/{name} ，name表示想要查看的信息，能够独立显示。

beans

访问 http://127.0.0.1:8080/actuator/beans 返回部分信息以下：

{
    "contexts": {
        "Spring Boot Actuator Demo": {
            "beans": {
                "endpointCachingOperationInvokerAdvisor": {
                    "aliases": [
                    ],
                    "scope": "singleton",
                    "type": "org.springframework.boot.actuate.endpoint.invoker.cache.CachingOperationInvokerAdvisor",
                    "resource": "class path resource [org/springframework/boot/actuate/autoconfigure/endpoint/EndpointAutoConfiguration.class]",
                    "dependencies": [
                        "environment"
                    ]
                },
                "defaultServletHandlerMapping": {
                    "aliases": [
                    ],
                    "scope": "singleton",
                    "type": "org.springframework.web.servlet.HandlerMapping",
                    "resource": "class path resource [org/springframework/boot/autoconfigure/web/servlet/WebMvcAutoConfiguration$EnableWebMvcConfiguration.class]",
                    "dependencies": [
                    ]
                },
                ...
            }
        }
    }
}

从返回的信息中咱们能够看出主要展现了 bean 的别名、类型、是否单例、类的地址、依赖等信息。

conditions

经过 conditions 能够在应用运行时查看代码了某个配置在什么条件下生效，或者某个自动配置为何没有生效。

访问 http://127.0.0.1:8080/actuator/conditions 返回部分信息以下：

{
    "contexts": {
        "Spring Boot Actuator Demo": {
            "positiveMatches": {
                "SpringBootAdminClientAutoConfiguration": [
                    {
                        "condition": "OnWebApplicationCondition",
                        "message": "@ConditionalOnWebApplication (required) found 'session' scope"
                    },
                    {
                        "condition": "SpringBootAdminClientEnabledCondition",
                        "message": "matched"
                    }
                ],
                "SpringBootAdminClientAutoConfiguration#metadataContributor": [
                    {
                        "condition": "OnBeanCondition",
                        "message": "@ConditionalOnMissingBean (types: de.codecentric.boot.admin.client.registration.metadata.CompositeMetadataContributor; SearchStrategy: all) did not find any beans"
                    }
                ],
                ...
            }
        }
    }
}

loggers

获取系统的日志信息。

访问 http://127.0.0.1:8080/actuator/loggers 返回部分信息以下：

{
    "levels": [
        "OFF",
        "ERROR",
        "WARN",
        "INFO",
        "DEBUG",
        "TRACE"
    ],
    "loggers": {
        "ROOT": {
            "configuredLevel": "INFO",
            "effectiveLevel": "INFO"
        },
        "cn": {
            "configuredLevel": null,
            "effectiveLevel": "INFO"
        },
        "cn.zwqh": {
            "configuredLevel": null,
            "effectiveLevel": "INFO"
        },
        "cn.zwqh.springboot": {
            "configuredLevel": null,
            "effectiveLevel": "INFO"
        },
        ...
    }
}

mappings

查看全部 URL 映射，即全部 @RequestMapping 路径的整理列表。

访问 http://127.0.0.1:8080/actuator/mappings 返回部分信息以下：

{
    "contexts": {
        "Spring Boot Actuator Demo": {
            "mappings": {
                "dispatcherServlets": {
                    "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
                        },
                        ...
                    ]
                }
            }
        }
    }
}

heapdump

访问：http://127.0.0.1:8080/actuator/heapdump会自动生成一个 GZip 压缩的 Jvm 的堆文件 heapdump,咱们可使用 JDK 自带的 Jvm 监控工具 VisualVM 打开此文件查看。如图：

VisualVM下载：https://visualvm.github.io/download.html

threaddump

获取系统线程的转储信息，主要展现了线程名、线程ID、线程的状态、是否等待锁资源等信息。在工做中，咱们能够经过查看线程的状况来排查相关问题。

访问 http://127.0.0.1:8080/actuator/threaddump 返回部分信息以下：

{
    "threads": [
        {
            "threadName": "DestroyJavaVM",
            "threadId": 40,
            "blockedTime": -1,
            "blockedCount": 0,
            "waitedTime": -1,
            "waitedCount": 0,
            "lockName": null,
            "lockOwnerId": -1,
            "lockOwnerName": null,
            "inNative": false,
            "suspended": false,
            "threadState": "RUNNABLE",
            "stackTrace": [
            ],
            "lockedMonitors": [
            ],
            "lockedSynchronizers": [
            ],
            "lockInfo": null
        },
        ...
    ]
}

shutdown

开启能够接口关闭 Spring Boot 应用，要使用这个功能须要作以下配置：

management.endpoint.shutdown.enabled=true

能够经过 post（仅支持 post）请求访问 http://127.0.0.1:8080/actuator/shutdown 关闭应用。

metrics

访问 http://127.0.0.1:8080/actuator/metrics 能够获取系统度量指标信息项以下：

{
    "names": [
        "jvm.memory.max",
        "jvm.threads.states",
        "jvm.gc.pause",
        "http.server.requests",
        "process.files.max",
        "jvm.gc.memory.promoted",
        "system.load.average.1m",
        "jvm.memory.used",
        "jvm.gc.max.data.size",
        "jvm.memory.committed",
        "system.cpu.count",
        "logback.events",
        "tomcat.global.sent",
        "jvm.buffer.memory.used",
        "tomcat.sessions.created",
        "jvm.threads.daemon",
        "system.cpu.usage",
        "jvm.gc.memory.allocated",
        "tomcat.global.request.max",
        "tomcat.global.request",
        "tomcat.sessions.expired",
        "jvm.threads.live",
        "jvm.threads.peak",
        "tomcat.global.received",
        "process.uptime",
        "tomcat.sessions.rejected",
        "process.cpu.usage",
        "tomcat.threads.config.max",
        "jvm.classes.loaded",
        "jvm.classes.unloaded",
        "tomcat.global.error",
        "tomcat.sessions.active.current",
        "tomcat.sessions.alive.max",
        "jvm.gc.live.data.size",
        "tomcat.threads.current",
        "process.files.open",
        "jvm.buffer.count",
        "jvm.buffer.total.capacity",
        "tomcat.sessions.active.max",
        "tomcat.threads.busy",
        "process.start.time"
    ]
}

对应访问 names 中的指标，能够查看具体的指标信息。如访问 http://127.0.0.1:8080/actuator/metrics/jvm.memory.used 返回信息以下：

{
    "name": "jvm.memory.used",
    "description": "The amount of used memory",
    "baseUnit": "bytes",
    "measurements": [
        {
            "statistic": "VALUE",
            "value": 1.16828136E8
        }
    ],
    "availableTags": [
        {
            "tag": "area",
            "values": [
                "heap",
                "nonheap"
            ]
        },
        {
            "tag": "id",
            "values": [
                "Compressed Class Space",
                "PS Survivor Space",
                "PS Old Gen",
                "Metaspace",
                "PS Eden Space",
                "Code Cache"
            ]
        }
    ]
}

示例代码

github

码云

参考文档

https://docs.spring.io/spring-boot/docs/2.2.1.RELEASE/reference/html/production-ready-features.html

非特殊说明，本文版权归朝雾轻寒全部，转载请注明出处.

原文标题：Spring Boot 2.X(十六)：应用监控之 Spring Boot Actuator 使用及配置

原文地址：https://www.zwqh.top/article/info/25

若是文章对您有帮助，请扫码关注下个人公众号，文章持续更新中...