Update spring_boot_actuator.md
qibaoguang
parent
ada6150157
commit
60807c25ed
|
|
@ -62,7 +62,76 @@ endpoints.shutdown.enabled=true
|
||||||
endpoints.enabled=false
|
endpoints.enabled=false
|
||||||
endpoints.info.enabled=true
|
endpoints.info.enabled=true
|
||||||
```
|
```
|
||||||
|
2. 健康信息
|
||||||
|
|
||||||
|
健康信息可以用来检查应用的运行状态。它经常被监控软件用来提醒人们生产系统是否停止。health端点暴露的默认信息取决于端点是如何被访问的。对于一个非安全，未认证的连接只返回一个简单的'status'信息。对于一个安全或认证过的连接其他详细信息也会展示（具体参考[Section 41.6, “HTTP Health endpoint access restrictions” ]()）。
|
||||||
|
|
||||||
|
健康信息是从你的ApplicationContext中定义的所有[HealthIndicator](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthIndicator.java) beans收集过来的。Spring Boot包含很多auto-configured的HealthIndicators，你也可以写自己的。
|
||||||
|
|
||||||
|
3. 安全与HealthIndicators
|
||||||
|
|
||||||
|
HealthIndicators返回的信息常常性质上有点敏感。例如，你可能不想将数据库服务器的详情发布到外面。因此，在使用一个未认证的HTTP连接时，默认只会暴露健康状态（health status）。如果想将所有的健康信息暴露出去，你可以把endpoints.health.sensitive设置为false。
|
||||||
|
|
||||||
|
为防止'拒绝服务'攻击，Health响应会被缓存。你可以使用`endpoints.health.time-to-live`属性改变默认的缓存时间（1000毫秒）。
|
||||||
|
|
||||||
|
- 自动配置的HealthIndicators
|
||||||
|
|
||||||
|
下面的HealthIndicators会被Spring Boot自动配置（在合适的时候）：
|
||||||
|
|
||||||
|
|名称|描述|
|
||||||
|
|----|:-----|
|
||||||
|
|[DiskSpaceHealthIndicator](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DiskSpaceHealthIndicator.java)|低磁盘空间检测|
|
||||||
|
|[DataSourceHealthIndicator](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DataSourceHealthIndicator.java)|检查是否能从DataSource获取连接|
|
||||||
|
|[MongoHealthIndicator](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/MongoHealthIndicator.java)|检查一个Mongo数据库是否可用（up）|
|
||||||
|
|[RabbitHealthIndicator](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/RabbitHealthIndicator.java)|检查一个Rabbit服务器是否可用（up）|
|
||||||
|
|[RedisHealthIndicator](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/RedisHealthIndicator.java)|检查一个Redis服务器是否可用（up）|
|
||||||
|
|[SolrHealthIndicator](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/SolrHealthIndicator.java)|检查一个Solr服务器是否可用（up）|
|
||||||
|
|
||||||
|
- 编写自定义HealthIndicators
|
||||||
|
|
||||||
|
想提供自定义健康信息，你可以注册实现了[HealthIndicator](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthIndicator.java)接口的Spring beans。你需要提供一个health()方法的实现，并返回一个Health响应。Health响应需要包含一个status和可选的用于展示的详情。
|
||||||
|
```java
|
||||||
|
import org.springframework.boot.actuate.health.HealthIndicator;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
|
||||||
|
@Component
|
||||||
|
public class MyHealth implements HealthIndicator {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Health health() {
|
||||||
|
int errorCode = check(); // perform some specific health check
|
||||||
|
if (errorCode != 0) {
|
||||||
|
return Health.down().withDetail("Error Code", errorCode).build();
|
||||||
|
}
|
||||||
|
return Health.up().build();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
除了Spring Boot预定义的[Status](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Status.java)类型，Health也可以返回一个代表新的系统状态的自定义Status。在这种情况下，需要提供一个[HealthAggregator](http://github.com/spring-projects/spring-boot/tree/master/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthAggregator.java)接口的自定义实现，或使用management.health.status.order属性配置默认的实现。
|
||||||
|
|
||||||
|
例如，假设一个新的，代码为FATAL的Status被用于你的一个HealthIndicator实现中。为了配置严重程度，你需要将下面的配置添加到application属性文件中：
|
||||||
|
```java
|
||||||
|
management.health.status.order: DOWN, OUT_OF_SERVICE, UNKNOWN, UP
|
||||||
|
```
|
||||||
|
如果使用HTTP访问health端点，你可能想要注册自定义的status，并使用HealthMvcEndpoint进行映射。例如，你可以将FATAL映射为HttpStatus.SERVICE_UNAVAILABLE。
|
||||||
|
|
||||||
|
4. 自定义应用info信息
|
||||||
|
|
||||||
|
通过设置Spring属性info.*，你可以定义info端点暴露的数据。所有在info关键字下的Environment属性都将被自动暴露。例如，你可以将下面的配置添加到application.properties：
|
||||||
|
```java
|
||||||
|
info.app.name=MyService
|
||||||
|
info.app.description=My awesome service
|
||||||
|
info.app.version=1.0.0
|
||||||
|
```
|
||||||
|
- 在构建时期自动扩展info属性
|
||||||
|
|
||||||
|
你可以使用已经存在的构建配置自动扩展info属性，而不是对在项目构建配置中存在的属性进行硬编码。这在Maven和Gradle都是可能的。
|
||||||
|
|
||||||
|
-
|
||||||
|
|
||||||
|
|
||||||
|
* 基于HTTP的监控和管理
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue