Spring Boot Actuator 使用和常用配置

简介: 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

目录
相关文章
|
5月前
|
负载均衡 监控 Java
Spring Cloud Gateway 全解析:路由配置、断言规则与过滤器实战指南
本文详细介绍了 Spring Cloud Gateway 的核心功能与实践配置。首先讲解了网关模块的创建流程,包括依赖引入(gateway、nacos 服务发现、负载均衡)、端口与服务发现配置,以及路由规则的设置(需注意路径前缀重复与优先级 order)。接着深入解析路由断言,涵盖 After、Before、Path 等 12 种内置断言的参数、作用及配置示例,并说明了自定义断言的实现方法。随后重点阐述过滤器机制,区分路由过滤器(如 AddRequestHeader、RewritePath、RequestRateLimiter 等)与全局过滤器的作用范围与配置方式,提
Spring Cloud Gateway 全解析:路由配置、断言规则与过滤器实战指南
|
5月前
|
Java 关系型数据库 MySQL
Spring Boot自动配置:魔法背后的秘密
Spring Boot 自动配置揭秘:只需简单配置即可启动项目,背后依赖“约定大于配置”与条件化装配。核心在于 `@EnableAutoConfiguration` 注解与 `@Conditional` 系列条件判断,通过 `spring.factories` 或 `AutoConfiguration.imports` 加载配置类,实现按需自动装配 Bean。
|
5月前
|
人工智能 Java 开发者
【Spring】原理解析:Spring Boot 自动配置
Spring Boot通过“约定优于配置”的设计理念,自动检测项目依赖并根据这些依赖自动装配相应的Bean,从而解放开发者从繁琐的配置工作中解脱出来,专注于业务逻辑实现。
1913 0
|
7月前
|
Java Spring
Spring Boot配置的优先级?
在Spring Boot项目中,配置可通过配置文件和外部配置实现。支持的配置文件包括application.properties、application.yml和application.yaml,优先级依次降低。外部配置常用方式有Java系统属性(如-Dserver.port=9001)和命令行参数(如--server.port=10010),其中命令行参数优先级高于系统属性。整体优先级顺序为:命令行参数 &gt; Java系统属性 &gt; application.properties &gt; application.yml &gt; application.yaml。
1145 0
|
4月前
|
前端开发 Java 应用服务中间件
《深入理解Spring》 Spring Boot——约定优于配置的革命者
Spring Boot基于“约定优于配置”理念,通过自动配置、起步依赖、嵌入式容器和Actuator四大特性,简化Spring应用的开发与部署,提升效率,降低门槛,成为现代Java开发的事实标准。
|
4月前
|
JavaScript Java Maven
【SpringBoot(二)】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理!
SpringBoot专栏第二章,从本章开始正式进入SpringBoot的WEB阶段开发,本章先带你认识yaml配置文件和资源的路径配置原理,以方便在后面的文章中打下基础
464 3
|
5月前
|
缓存 Java 应用服务中间件
Spring Boot配置优化:Tomcat+数据库+缓存+日志,全场景教程
本文详解Spring Boot十大核心配置优化技巧,涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置,结合代码示例与通俗解释,助你轻松掌握高并发场景下的性能调优方法,适用于实际项目落地。
883 5
|
5月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
298 0
探索Spring Boot的@Conditional注解的上下文配置
|
6月前
|
安全 算法 Java
在Spring Boot中应用Jasypt以加密配置信息。
通过以上步骤,可以在Spring Boot应用中有效地利用Jasypt对配置信息进行加密,这样即使配置文件被泄露,其中的敏感信息也不会直接暴露给攻击者。这是一种在不牺牲操作复杂度的情况下提升应用安全性的简便方法。
1234 10
|
SQL 关系型数据库 MySQL
SpringBoot自定义配置注入的方式:自定义配置文件注入,从mysql读取配置进行注入
SpringBoot自定义配置注入的方式:自定义配置文件注入,从mysql读取配置进行注入
622 0

热门文章

最新文章