Config Server的健康状态指示器

一 介绍

Config Server自带了一个健康状态指示器，用于检查所配置的EnvironmentRepository是否正常工作。可使用Config Server的/health端点查询当前健康状态。默认情况下，健康指示器向EnvironmentRepository请求的{application}是app，{profile}和{label}是对应 EnvironmentRepository实现的默认值。对于Git，{profile}是default，{label}是master。

同样也可以自定义健康状态指示器的配置，从而检查更多的{application}、自定义的{profile}以及自定义的{label}.

二 gitee截图

三 config Server配置举例

server:
  port: 8080
spring:
  application:
    name: microservice-config-server
  cloud:
    config:
      server:
        git:
          uri:https://git.oschina.net/itmuch/spring-cloud-config-repo/# 配置Git仓库的地址
          username:                                                         # Git仓库的账号
          password:                                                         # Git仓库的密码
        health:
          repositories:
            a-foo:
              label: config-label-v2.0
              name: microservice-foo
              profiles: dev

四 测试1

1 输入 http://localhost:8080/health

2 输出结果如下：

{
    "status": "UP",
    "diskSpace": {
        "status": "UP",
        "total": 209715195904,
        "free": 157954682880,
        "threshold": 10485760
    },
    "refreshScope": {
        "status": "UP"
    },
    "configServer": {
        "status": "UP",
        "repositories": [
            {
                "sources": [
                    "https://git.oschina.net/itmuch/spring-cloud-config-repo/microservice-foo-dev.properties",
                    "https://git.oschina.net/itmuch/spring-cloud-config-repo/microservice-foo.properties",
                    "https://git.oschina.net/itmuch/spring-cloud-config-repo/application.properties"
                ],
                "name": "microservice-foo",
                "profiles": [
                    "dev"
                ],
                "label": "master"
            }
        ]
    }
}

四 测试2

1 修改配置文件为：

server:
  port: 8080
spring:
  application:
    name: microservice-config-server
  cloud:
    config:
      server:
        git:
          uri:https://git.oschina.net/itmuch/spring-cloud-config-repo/# 配置Git仓库的地址
          username:                                                         # Git仓库的账号
          password:                                                         # Git仓库的密码

2 输入http://localhost:8080/health

3 输出结果如下：

{
    "status": "UP",
    "diskSpace": {
        "status": "UP",
        "total": 209715195904,
        "free": 157954674688,
        "threshold": 10485760
    },
    "refreshScope": {
        "status": "UP"
    },
    "configServer": {
        "status": "UP",
        "repositories": [
            {
                "sources": [
                    "https://git.oschina.net/itmuch/spring-cloud-config-repo/application.properties"
                ],
                "name": "app",
                "profiles": [
                    "default"
                ],
                "label": "master"
            }
        ]
    }
}

四 说明

如果需要禁用健康状态指示器，可设置spring.cloud.config.server.health.enabled=false