Springboot actuator使用详解

最新推荐文章于 2023-06-28 19:34:39 发布
最新推荐文章于 2023-06-28 19:34:39 发布
阅读量516 收藏
点赞数
原文链接：https://my.oschina.net/u/3768341/blog/3085478
版权

Springboot actuator是一个追踪各种springboot应用状态的健康检查机制，使用需要添加一个pom

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

在启动springboot中，我们往往会看到这样的一条日志 Exposing 20 endpoint(s) beneath base path '/actuator'

这个20是每一个springboot应用程序的健康检查点的个数，他是随着你配置文件中的配置而不同的。

由于本人配置的Server信息如下

server:
  port: 8001
  servlet:
    context-path: /api-u

所以当我们访问actuator Web信息的路径如下

http://127.0.0.1:8001/api-u/actuator

这里需要注意的是，如果我们配置了oauth 2的资源访问权限的时候，需要对该路径放行

@EnableResourceServer
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true,securedEnabled = true)
public class ResourceServerConfig extends ResourceServerConfigurerAdapter {

   @Override
   public void configure(HttpSecurity http) throws Exception {
      http.csrf().disable().exceptionHandling()
            .authenticationEntryPoint(
                  (request, response, authException) -> response.sendError(HttpServletResponse.SC_UNAUTHORIZED))
            .and().authorizeRequests().antMatchers(PermitAllUrl.permitAllUrl("/users-anon/**", "/sys/login","/actuator/**")).permitAll() //此处添加"/actuator/**"进行放行
            .anyRequest().authenticated().and().httpBasic();
   }
   @Override
   public void configure(ResourceServerSecurityConfigurer resource) throws Exception {
      //这里把自定义异常加进去
      resource.authenticationEntryPoint(new AuthExceptionEntryPoint())
            .accessDeniedHandler(new CustomAccessDeniedHandler());
   }


   @Bean
   public BCryptPasswordEncoder bCryptPasswordEncoder() {
      return new BCryptPasswordEncoder();
   }

}

在配置文件中做如下配置

management:
  endpoint:
    health:
      show-details: always

此时我们访问http://127.0.0.1:8001/api-u/actuator的结果如下

{
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8001/api-u/actuator" ,
"templated" : false
},
"health" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/health" ,
"templated" : false
},
"info" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/info" ,
"templated" : false
}
}
}

具体大家可以参考这个官网说明 https://docs.spring.io/spring-boot/docs/2.0.1.RELEASE/reference/htmlsingle/中的

https://docs.spring.io/spring-boot/docs/2.0.1.RELEASE/reference/htmlsingle/#production-ready-endpoints-enabling-endpoints以及 https://docs.spring.io/spring-boot/docs/2.0.1.RELEASE/reference/htmlsingle/#_auto_configured_healthindicators

其中的http://127.0.0.1:8001/api-u/actuator/health就是我们需要的健康检查的具体信息

{
"status" : "DOWN" ,
"details" : {
"rabbit" : {
"status" : "DOWN" ,
"details" : {
"error" : "org.springframework.amqp.AmqpConnectException: java.net.ConnectException: Connection refused (Connection refused)"
}
},
"diskSpace" : {
"status" : "UP" ,
"details" : {
"total" : 499963174912 ,
"free" : 435209195520 ,
"threshold" : 10485760
}
},
"db" : {
"status" : "UP" ,
"details" : {
"database" : "MySQL" ,
"hello" : 1
}
},
"refreshScope" : {
"status" : "UP"
},
"discoveryComposite" : {
"status" : "UP" ,
"details" : {
"discoveryClient" : {
"status" : "UP" ,
"details" : {
"services" : [
"register-center" ,
"user-center"
]
}
},
"eureka" : {
"description" : "Remote status from Eureka server" ,
"status" : "UP" ,
"details" : {
"applications" : {
"REGISTER-CENTER" : 1 ,
"USER-CENTER" : 1
}
}
}
}
},
"configServer" : {
"status" : "UNKNOWN" ,
"details" : {
"error" : "no property sources located"
}
},
"hystrix" : {
"status" : "UP"
},
"redis" : {
"status" : "UP" ,
"details" : {
"version" : "3.2.12"
}
}
}
}

这里为该进程spring支持的各种服务的健康状态，UP为在线，DOWN为下线状态,UNKNOWN为不知道。

除了http://127.0.0.1:8001/api-u/actuator/health之外还有一个http://127.0.0.1:8001/api-u/actuator/info

这是一个描述信息的说明，如果我们在配置文件中做如下配置

info:
  app-name: user
  author: guanjian
  email: 12345@xy.com

则可以在http://127.0.0.1:8001/api-u/actuator/info的返回信息中看到

{
"app-name" : "user" ,
"author" : "guanjian" ,
"email" : "12345@xy.com"
}

但是我们在以上配置中可以看到的信息很少，需要激活所有的actuator端点，增加配置如下

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: always

此时再次访问http://127.0.0.1:8001/api-u/actuator的结果如下

{
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8001/api-u/actuator" ,
"templated" : false
},
"archaius" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/archaius" ,
"templated" : false
},
"auditevents" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/auditevents" ,
"templated" : false
},
"beans" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/beans" ,
"templated" : false
},
"health" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/health" ,
"templated" : false
},
"conditions" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/conditions" ,
"templated" : false
},
"configprops" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/configprops" ,
"templated" : false
},
"env" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/env" ,
"templated" : false
},
"env-toMatch" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/env/{toMatch}" ,
"templated" : true
},
"info" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/info" ,
"templated" : false
},
"logfile" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/logfile" ,
"templated" : false
},
"loggers-name" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/loggers/{name}" ,
"templated" : true
},
"loggers" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/loggers" ,
"templated" : false
},
"heapdump" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/heapdump" ,
"templated" : false
},
"threaddump" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/threaddump" ,
"templated" : false
},
"metrics-requiredMetricName" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/metrics/{requiredMetricName}" ,
"templated" : true
},
"metrics" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/metrics" ,
"templated" : false
},
"scheduledtasks" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/scheduledtasks" ,
"templated" : false
},
"sessions-sessionId" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/sessions/{sessionId}" ,
"templated" : true
},
"sessions" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/sessions" ,
"templated" : false
},
"httptrace" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/httptrace" ,
"templated" : false
},
"mappings" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/mappings" ,
"templated" : false
},
"refresh" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/refresh" ,
"templated" : false
},
"features" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/features" ,
"templated" : false
},
"service-registry" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/service-registry" ,
"templated" : false
}
}
}

现在来挑几个做一下说明 http://127.0.0.1:8001/api-u/actuator/configprops 查看所有的配置信息（当然密码会隐藏） 片段

"spring.cloud.config-org.springframework.cloud.bootstrap.config.PropertySourceBootstrapProperties" : {
"prefix" : "spring.cloud.config" ,
"properties" : {
"overrideSystemProperties" : true ,
"overrideNone" : false ,
"allowOverride" : true
}
},
"configClientProperties" : {
"prefix" : "spring.cloud.config" ,
"properties" : {
"headers" : {},
"discovery" : {
"enabled" : false ,
"serviceId" : "configserver"
},
"profile" : "default" ,
"name" : "user-center" ,
"uri" : "http://localhost:8888" ,
"enabled" : true ,
"failFast" : false ,
"username" : "user"
}
},

http://127.0.0.1:8001/api-u/actuator/metrics 查看某些指标的具体数值，比如JVM,tomcat等等

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

比方说我们要查看JVM的最大内存，访问 http://127.0.0.1:8001/api-u/actuator/metrics/jvm.memory.max

{
"name" : "jvm.memory.max" ,
"measurements" : [
{
"statistic" : "VALUE" ,
"value" : 5.587337215E9
}
],
"availableTags" : [
{
"tag" : "area" ,
"values" : [
"heap" ,
"nonheap"
]
},
{
"tag" : "id" ,
"values" : [
"Compressed Class Space" ,
"PS Survivor Space" ,
"PS Old Gen" ,
"Metaspace" ,
"PS Eden Space" ,
"Code Cache"
]
}
]
}

http://127.0.0.1:8001/api-u/actuator/metrics/jvm.memory.used JVM已经使用的内存

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

http://127.0.0.1:8001/api-u/actuator/beans 查看spring中注入的所有bean

部分片段

"spring.cloud.config-org.springframework.cloud.bootstrap.config.PropertySourceBootstrapProperties" : {
"aliases" : [],
"scope" : "singleton" ,
"type" : "org.springframework.cloud.bootstrap.config.PropertySourceBootstrapProperties" ,
"resource" : null ,
"dependencies" : []
},
"propertySourcesPlaceholderConfigurer" : {
"aliases" : [],
"scope" : "singleton" ,
"type" : "org.springframework.context.support.PropertySourcesPlaceholderConfigurer" ,
"resource" : "org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration" ,
"dependencies" : []
}

如果我们不想激活所有的端点，只激活部分端点，比如configprops,metrics,beans,health,info,配置如下

management:
  endpoints:
    web:
      exposure:
        include: "configprops,metrics,beans,health,info"
  endpoint:
    health:
      show-details: always

访问http://127.0.0.1:8001/api-u/actuator结果如下

{
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8001/api-u/actuator" ,
"templated" : false
},
"beans" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/beans" ,
"templated" : false
},
"health" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/health" ,
"templated" : false
},
"configprops" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/configprops" ,
"templated" : false
},
"info" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/info" ,
"templated" : false
},
"metrics-requiredMetricName" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/metrics/{requiredMetricName}" ,
"templated" : true
},
"metrics" : {
"href" : "http://127.0.0.1:8001/api-u/actuator/metrics" ,
"templated" : false
}
}
}
我的博客即将同步至腾讯云+社区，邀请大家一同入驻：https://cloud.tencent.com/developer/support-plan?invite_code=2ezsltbcry3oc

转载于:https://my.oschina.net/u/3768341/blog/3085478

chidi5109
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot Actuator执行器运行原理详解
08-24
Spring Boot Actuator 执行器运行原理详解 Spring Boot Actuator 执行器是 Spring Boot 框架中的一种功能强大且实用的模块，用于监视和管理 Spring Boot 应用程序。在本文中，我们将详细介绍 Spring Boot Actuator ...
SpringBoot整合Swagger和Actuator的使用教程详解
08-25
Swagger 是一套基于 OpenAPI 规范构建的开源工具，可以帮助我们设计、构建、记录...本篇文章主要介绍的是SpringBoot整合Swagger(API文档生成框架)和SpringBoot整合Actuator(项目监控)使用教程。感兴趣的朋友一起看看吧
spring-boot-actuator-2.2.0.RELEASE-API文档-中文版.zip
07-13
赠送jar包：spring-boot-actuator-2.2.0.RELEASE.jar； 赠送原API文档：spring-boot-actuator-2.2.0.RELEASE-javadoc.jar； 赠送源代码：spring-boot-actuator-2.2.0.RELEASE-sources.jar； 赠送Maven依赖信息文件：spring-boot-actuator-2.2.0.RELEASE.pom； 包含翻译后的API文档：spring-boot-actuator-2.2.0.RELEASE-javadoc-API文档-中文(简体)版.zip； Maven坐标：org.springframework.boot:spring-boot-actuator:2.2.0.RELEASE； 标签：springframework、boot、spring、actuator、中文文档、jar包、java； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
Spring Boot 系统监控
fang.lovest.yang的博客
02-09 1714
1.系统监控 Spring Boot的系统监控是对应用程序运行状态进行管理，通过 Spring Boot Actuator 来实现， Spring Boot Actuator 组件主要通过一系列 HTTP 端点提供的系统监控功能来实现系统监控。 2.引入 Spring Boot Actuator （1）项目中引入组件 <dependency> <groupId>org.springframework.boot</groupId> <a...
实用技巧：Spring Cloud中，如何优雅下线微服务？
dragoonnet的专栏
04-12 1117
Spring Cloud中，如何优雅下线微服务？
Spring Boot - Actuator 应用监控
t5721654的专栏
03-25 967
在微服务架构中往往需要对服务各状态进行收集、监控、统计，否则整个整个集群将是一个可怕的黑盒。 Spring Boot提供了Actuator组件使我们可以通过restful API的方式获取服务运行中的各项指标，默认提供了以下监控指标： 我们也可以自己实现HealthIndicator接口自行提供监控指标。 同时Actuator还为我们的应用提供了优雅关机功能，相当于一个APP的管家了！ ...
Spring Boot Actuator
qq_37705525的博客
06-25 1354
Spring Boot Actuator
详解关于springboot-actuator监控的401无权限访问
08-29
Spring Boot Actuator监控的401无权限访问详解 在本篇文章中，我们将详解关于Spring Boot Actuator监控的401无权限访问问题，该问题是Spring Boot开发中常见的错误之一。我们将通过实践演示如何解决该问题，并提供...
详解spring-boot actuator（监控）配置和使用
08-29
Spring Boot Actuator 配置和使用详解 Spring Boot Actuator 是 Spring Boot 框架中的一组组件，提供了一系列的监控和管理接口，帮助开发者快速构建可靠的生产环境。下面我们将详细介绍 Spring Boot Actuator 的...
prometheus监控springboot应用简单使用介绍详解
08-26
prometheus监控springboot应用简单使用介绍详解 在本文中，我们将介绍如何使用Prometheus监控SpringBoot应用。Prometheus是一款强大的监控工具，可以帮助我们实时监控应用程序的性能和状态。 第一步：配置...
Springcloud EurekaClient 底层实现（一）
qq_30905661的博客
07-10 874
最近接手一个项目，需要重启服务时先注销掉当前服务，再重启程序，这样就不会因为ribbon负载均衡到重启的服务上从而丢失请求，那么我们先来研究下怎么手动注销服务。 以下所有代码都是基于springboot2.0.9 RELEASE和springcloud Finchley.RELEASE 注销服务 向eurekaserver发送delete请求 比如说现在想注销下图中的PRODUCER服务 那么...
SpringBoot 监控神器——Actuator 保姆级教程
qq_45635347的博客
06-28 4202
自定义配置来控制是否开启过滤actuator:filter:@Endpoint：定义一个监控端点，同时支持 HTTP 和 JMX 两种方式。：定义一个监控端点，只支持 HTTP 方式。：定义一个监控端点，只支持 JMX 方式。：作用在方法上，可用来返回端点展示的信息（通过 Get 方法请求）。：作用在方法上，可用来修改端点展示的信息（通过 Post 方法请求）。：作用在方法上，可用来删除对应端点信息（通过 Delete 方法请求）。@Selector：作用在参数上，用来定位一个端点的具体指标路由。
【SpringBoot新手篇】SpringBoot集成actuator监控服务
输入技术、输出想法
04-29 8993
SpringBoot整合actuatorSpringBoot监控管理SpringBoot Actuator的使用Actuator 的 REST 接口命令详解health自定义 HealthIndicator 健康检查infobeansconditionsheapdumpshutdownmappingsthreaddump SpringBoot监控管理 微服务的特点决定了功能模块的部署是分布式的，大部分功能模块都是运行在不同的机器上，彼此通过服务调用进行交互，前后台的业务流会经过很多个微服务的处理和传递，出现
springboot之Actuator
热门推荐
weixin_40482816的博客
09-12 1万+
1、Actuator介绍 Actuator是Springboot提供的用来对应用系统进行自省和监控的功能模块，借助于Actuator开发者可以很方便地对应用系统某些监控指标进行查看、统计等。 Actuator 的核心是端点 Endpoint，它用来监视应用程序及交互，spring-boot-actuator 中已经内置了非常多的 Endpoint（health、info、beans、metrics、httptrace、shutdown等等），同时也允许我们自己扩展自己的 Endpoints。每个 En.
Spring Cloud 学习(17) --- Actuator(一) 常见端点、配置明细端点
霓虹深处
05-24 2653
在 Hystrix Dashboard 中，使用了 /actuator/hystrix.stream，查看正在运行的项目的运行状态。 其中 /actuator 代表 SpringBoot 中的 Actuator 模块。该模版提供了很多生产级别的特性，如：监控、度量应用。Actuator 的特性可以通过众多的 REST 端点，远程 shell、JMX 获得。 源码：https://gitee.co...
Spring boot——Actuator 详解
leveretz的博客
07-25 4998
Spring boot——Actuator 详解
Spring Boot 探索 | Actuator 端点详细说明
挖坑埋你
12-25 1万+
先在这里声明一下：这一系列的文章都是自己查询网上资料学习而来，不可避免有些内容从其他地方copy过来，如有侵犯请联系我删除，谢谢！（引用部分都会添加注脚） 本系列文章的写作环境为：Spring Boot 1.5.18.RELEASE、JDK 1.8.0_131、IntelliJ IDEA ULTIMATE 2018.1。并没有使用最新版本的Spring Boot进行学习，新版本还不稳定，存在...
Spring Cloud 优雅下线以及灰度发布
CG国斌的博客
10-20 7484
文章目录前言优雅下线常见的下线方式优雅的下线方式灰度发布蓝绿部署滚动部署金丝雀部署 前言 在生产环境中，如何保证在服务升级的时候，不影响用户的体验，这个是一个非常重要的问题。如果在我们升级服务的时候，会造成一段时间内的服务不可用，这就是不够优雅的。那什么是优雅的呢？主要就是指在服务升级的时候，不中断整个服务，让用户无感知，进而不会影响用户的体验，这就是优雅的。 实际上，优雅下线是目标，而不是手段，它是一个相对的概念，例如kill PID和kill -9 PID都是暴力杀死服务，相对于kill -9 PID来
spring-boot-starter-actuator监控接口详解
大鹏
03-12 6590
概述 微服务作为一项在云中部署应用和服务的新技术是当下比较热门话题，而微服务的特点决定了功能模块的部署是分布式的，运行在不同的机器上相互通过服务调用进行交互，业务流会经过多个微服务的处理和传递，在这种框架下，微服务的监控显得尤为重要。 而Actuator正是Spring Boot提供的对应用系统的监控和管理的集成功能，可以查看应用配置的详细信息，例如自动化配置信息、创建的Spring beans信息、系统环境变量的配置信以及Web请求的详细信息等。如果使用不当或者一些不经意的疏忽，可能造成信息泄露等严重
springboot actuator路径
最新发布
09-02
引用中提到，SpringBoot 1.x 和 2.x 的 Actuator 监控配置有很大的差异。在SpringBoot 2.x版本中，Actuator的endpoint路径为/actuator/。引用提到，只要添加了对应的maven依赖，SpringBoot会自动开启/actuator/...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值