Spring Boot Actuator 使用和常用配置

本文涉及的产品
Redis 开源版,标准版 2GB
推荐场景:
搭建游戏排行榜
云数据库 Tair(兼容Redis),内存型 2GB
简介: Spring Boot Actuator 使用和常用配置

转载请注明出处:

  Spring Boot Actuator是Spring Boot提供的一个非常强大的工具,它可以帮助我们监控和管理我们的Spring Boot应用。Actuator提供了一系列的端点,我们可以通过这些端点来查看我们的应用的运行状态,例如健康状态、指标、信息、数据库连接、Redis连接等等

1.配置Spring Boot Actuator

  要使用Spring Boot Actuator,我们首先需要在我们的Spring Boot项目中添加spring-boot-starter-actuator依赖。在Maven项目中,我们可以通过以下方式添加这个依赖:

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

  添加了这个依赖之后,Spring Boot Actuator会自动配置各种端点,使我们可以在生产环境中监控和管理我们的Spring Boot应用。

  Spring Boot Actuator提供了一系列的端点,可以通过访问这些端点来查看我们的应用的运行状态。例如,通过访问/actuator/health端点来查看应用的健康状态,通过访问/actuator/metrics端点来查看我们的应用的指标,通过访问/actuator/info端点来查看我们的应用的信息等。

  以下是一个示例,展示了如何在我们的Spring Boot应用中使用Spring Boot Actuator:

curl http://localhost:8080/actuator/health

  通过curl命令访问了/actuator/health端点,查看了我们的应用的健康状态。

2.Spring Boot Actuator默认配置项:

  1.management.endpoints.web.exposure.include:这个配置项用于指定哪些端点应该被暴露出来。默认情况下,它的值是*,表示所有的端点都会被暴露出来。如果你想关闭某个端点,你可以将它的值从*改为你想要暴露的端点的名称,用逗号分隔

  2.management.endpoints.web.exposure.exclude:这个配置项用于指定哪些端点不应该被暴露出来。默认情况下,它的值是空字符串,表示没有端点被排除。如果你想关闭某个端点,你可以将它的值改为你想要关闭的端点的名称,用逗号分隔

  3.management.endpoints.web.base-path:这个配置项用于指定所有端点的基础路径。默认情况下,它的值是/actuator,表示所有的端点的路径都会以/actuator开始。    

  4.management.endpoints.web.path-mapping:这个配置项用于指定端点的路径映射。默认情况下,它的值是空字符串,表示没有端点的路径被映射。如果你想改变某个端点的路径,你可以将它的值改为端点的名称和新的路径,用冒号分隔

  5.management.endpoints.web.cors.allowed-origins:这个配置项用于指定哪些源站点可以访问端点。默认情况下,它的值是空字符串,表示没有源站点被允许。如果你想允许某个源站点访问端点,你可以将它的值改为源站点的URL,用逗号分隔

  以下是一个示例,展示了如何在Spring Boot的配置文件中设置Actuator的默认配置项:

management:
 endpoints:
   web:
     exposure:
       include: '*'
     base-path: '/actuator'
     path-mapping: 'health=healthcheck'
     cors:
       allowed-origins: 'http://localhost:8080'

  在这个示例中,设置了所有的端点都会被暴露出来,所有的端点的路径都会以/actuator开始,health端点的路径被映射为healthcheckhttp://localhost:8080被允许访问所有的端点.

3.关闭健康检查

  在Spring Boot中,你可以通过配置文件来关闭Actuator的检查。具体来说,你可以使用management.endpoints.web.exposure.includemanagement.endpoints.web.exposure.exclude配置项来控制哪些端点被暴露出来。

  如果你想关闭所有的Actuator端点,你可以将management.endpoints.web.exposure.include配置项设置为空字符串。这样,Actuator就不会暴露任何端点,也就意味着Actuator的检查就不会被执行。

  以下是一个示例,展示了如何在Spring Boot的配置文件中关闭所有的Actuator端点:

management:
 endpoints:
  web:
    exposure:
      include: ''

  在这个示例中,我们将management.endpoints.web.exposure.include配置项设置为空字符串,这样Actuator就不会暴露任何端点,也就意味着Actuator的检查就不会被执行

  需要注意的是,关闭Actuator的检查可能会影响到你的应用程序的监控和管理。因此,你应该在关闭Actuator的检查之前,确保你已经准备好了其他的监控和管理方案。

4.健康检查检查示例

  如果你的management.endpoint.health.show-details=always配置项设置为always,那么/actuator/health端点会返回所有的健康检查结果,包括应用程序的各种状态信息,如数据库连接、Redis连接等

  以下是一个示例,展示了/actuator/health端点返回的健康检查结果:

{
 "status": "UP",
 "components": {
  "db": {
    "status": "UP",
    "details": {
      "database": "MySQL",
      "hello": 1
    }
  },
  "diskSpace": {
    "status": "UP",
    "details": {
      "total": 250685575168,
      "free": 66978721536,
      "threshold": 10485760
    }
  },
  "redis": {
    "status": "UP",
    "details": {
      "version": "4.0.10",
      "redis_version": "4.0.10",
      "uptime": 11038,
      "os": "Linux 3.10.0-862.11.6.el7.x86_64 x86_64",
      "redis_mode": "standalone",
      "role": "master",
      "connected_clients": 1,
      "used_memory": 610024,
      "used_memory_human": "594.09K",
      "used_memory_rss": 737008,
      "used_memory_peak": 610024,
      "used_memory_peak_human": "594.09K",
      "used_memory_lua": 37888,
      "mem_fragmentation_ratio": "1.44",
      "mem_allocator": "jemalloc-3.6.0",
      "loading": 0,
      "rdb_changes_since_last_save": 0,
      "rdb_bgsave_in_progress": 0,
      "rdb_last_save_time": 1577023058,
      "rdb_last_bgsave_status": "ok",
      "rdb_last_bgsave_time_sec": -1,
      "rdb_current_bgsave_time_sec": -1,
      "aof_enabled": 0,
      "aof_rewrite_in_progress": 0,
      "aof_rewrite_scheduled": 0,
      "aof_last_rewrite_time_sec": -1,
      "aof_current_rewrite_time_sec": -1,
      "aof_last_bgrewrite_status": "ok",
      "aof_last_write_status": "ok",
      "total_connections_received": 1,
      "total_commands_processed": 1,
      "instantaneous_ops_per_sec": 0,
      "total_net_input_bytes": 73,
      "total_net_output_bytes": 394,
      "instantaneous_input_kbps": 0.0,
      "instantaneous_output_kbps": 0.0,
      "rejected_connections": 0,
      "sync_full": 0,
      "sync_partial_ok": 0,
      "sync_partial_err": 0,
      "expired_keys": 0,
      "evicted_keys": 0,
      "keyspace_hits": 0,
      "keyspace_misses": 0,
      "pubsub_channels": 0,
      "pubsub_patterns": 0,
      "latest_fork_usec": 0,
      "migrate_cached_sockets": 0,
      "slave_expires_tracked_keys": 0,
      "active_defrag_hits": 0,
      "active_defrag_misses": 0,
      "active_defrag_key_hits": 0,
      "active_defrag_key_misses": 0,
      "active_defrag_key_hits_perc": 0.0,
      "active_defrag_key_misses_perc": 0.0,
      "active_defrag_scanned": 0,
      "active_defrag_scanned_perc": 0.0,
     ```

 

标签: spring boot

相关实践学习
基于Redis实现在线游戏积分排行榜
本场景将介绍如何基于Redis数据库实现在线游戏中的游戏玩家积分排行榜功能。
云数据库 Redis 版使用教程
云数据库Redis版是兼容Redis协议标准的、提供持久化的内存数据库服务,基于高可靠双机热备架构及可无缝扩展的集群架构,满足高读写性能场景及容量需弹性变配的业务需求。 产品详情:https://www.aliyun.com/product/kvstore &nbsp; &nbsp; ------------------------------------------------------------------------- 阿里云数据库体验:数据库上云实战 开发者云会免费提供一台带自建MySQL的源数据库&nbsp;ECS 实例和一台目标数据库&nbsp;RDS实例。跟着指引,您可以一步步实现将ECS自建数据库迁移到目标数据库RDS。 点击下方链接,领取免费ECS&amp;RDS资源,30分钟完成数据库上云实战!https://developer.aliyun.com/adc/scenario/51eefbd1894e42f6bb9acacadd3f9121?spm=a2c6h.13788135.J_3257954370.9.4ba85f24utseFl
目录
相关文章
|
6天前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
22 4
|
11天前
|
Java 数据库连接 Maven
springBoot:项目建立&配置修改&yaml的使用&resource 文件夹(二)
本文档介绍了如何创建一个基于Maven的项目,并配置阿里云仓库、数据库连接、端口号、自定义启动横幅及多环境配置等。同时,详细说明了如何使用YAML格式进行配置,以及如何处理静态资源和模板文件。文档还涵盖了Spring Boot项目的`application.properties`和`application.yaml`文件的配置方法,包括设置数据库驱动、URL、用户名、密码等关键信息,以及如何通过配置文件管理不同环境下的应用设置。
|
3天前
|
Java API 数据库
Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐
本文通过在线图书管理系统案例,详细介绍如何使用Spring Boot构建RESTful API。从项目基础环境搭建、实体类与数据访问层定义,到业务逻辑实现和控制器编写,逐步展示了Spring Boot的简洁配置和强大功能。最后,通过Postman测试API,并介绍了如何添加安全性和异常处理,确保API的稳定性和安全性。
10 0
|
2天前
|
druid Java Maven
|
4天前
|
Java BI 调度
Java Spring的定时任务的配置和使用
遵循上述步骤,你就可以在Spring应用中轻松地配置和使用定时任务,满足各种定时处理需求。
28 1
|
14天前
|
消息中间件 Java 大数据
大数据-56 Kafka SpringBoot与Kafka 基础简单配置和使用 Java代码 POM文件
大数据-56 Kafka SpringBoot与Kafka 基础简单配置和使用 Java代码 POM文件
47 2
|
9天前
|
监控 Java Maven
springboot学习二:springboot 初创建 web 项目、修改banner、热部署插件、切换运行环境、springboot参数配置,打包项目并测试成功
这篇文章介绍了如何快速创建Spring Boot项目,包括项目的初始化、结构、打包部署、修改启动Banner、热部署、环境切换和参数配置等基础操作。
44 0
|
10天前
|
XML Java 数据格式
手动开发-简单的Spring基于注解配置的程序--源码解析
手动开发-简单的Spring基于注解配置的程序--源码解析
24 0
|
10天前
|
XML Java 数据格式
手动开发-简单的Spring基于XML配置的程序--源码解析
手动开发-简单的Spring基于XML配置的程序--源码解析
35 0
|
11天前
|
机器学习/深度学习 移动开发 自然语言处理
基于人工智能技术的智能导诊系统源码,SpringBoot作为后端服务的框架,提供快速开发,自动配置和生产级特性
当身体不适却不知该挂哪个科室时,智能导诊系统应运而生。患者只需选择不适部位和症状,系统即可迅速推荐正确科室,避免排错队浪费时间。该系统基于SpringBoot、Redis、MyBatis Plus等技术架构,支持多渠道接入,具备自然语言理解和多输入方式,确保高效精准的导诊体验。无论是线上医疗平台还是大型医院,智能导诊系统均能有效优化就诊流程。