Spring Cloud Gray 配置参数

Joe.Ye • 2023-03-27 • 发布部署

管控端

gray.server.discovery

Property Name Default Value Remarks
evictionEnabled true 定时同步注册中心实例状态的开关
evictionIntervalTimerInMs 60000 定时同步注册中心实例状态的时间间隔(默认60秒)，
0表示不创建定时任务		 
gray:
  server:
    discovery:
      evictionEnabled: true
      evictionIntervalTimerInMs: 60000

gray.server.instance

Property Name Default Value Remarks
normalInstanceStatus STARTING, UP 正常的实例状态,默认为STARTING, UP
实例状态分别是STARTING, UP, OUT_OF_SERVICE, DOWN, UNKNOWN		 
gray:
  server:
    instance:
      normalInstanceStatus: STARTING,UP

gray.server.instance.eviction

Property Name Default Value Remarks
enabled false 是否启用实例记录清除任务(默认为false)
evictionIntervalTimerInMs 86400000 任务间隔时间,单位为毫秒(默认1天)
evictionInstanceStatus DOWN, UNKNOWN 需要清徐的实例状态，默认DOWN, UNKNOWN
lastUpdateDateExpireDays 1 最后更新时间过期天数，默认1天 
gray:
  server:
    instance:
      eviction:
        enabled: true
        evictionIntervalTimerInMs: 86400000
        evictionInstanceStatus: DOWN,UNKNOWN
        lastUpdateDateExpireDays: 1

客户端

gray

Property Name Default Value Remarks
enabled false 是否启用实例记录清除任务(默认为false)
grayRouting true 是否灰度路由，如果开启，将优先对灰度实例进行路由，
如果没有匹配的灰度实例，再对正常实现进行路由		 
gray:
  enabled: true
  grayRouting: true

gray.server

灰度管控端相关的配置

Property Name Default Value Remarks
url 灰度管控端的url
可以http://192.168.0.1:8080/uri
也可以是ribbon的风格http://gray-server/uri
loadbalanced false url是否是负载均衡的路径
retryable true 在和灰度服务器通信时，如果交互失败，是否重试
retryNumberOfRetries 3 重试次数 
gray:
  server:
    url: http://gray-server
    loadbalanced: false
    retryable: true
    retryNumberOfRetries: 3

gray.client

Property Name Default Value Remarks
runenv web 运行环境(默认web)
serviceInitializeDelayTimeInMs 40000 实始化灰度信息的延迟时间<默认40秒>
serviceUpdateIntervalTimerInMs 60000 定时从管控端更新灰度实例信息的间隔时间(默认60秒)
0表示不创建定时任务		 
gray:
  client:
  runenv: web
  serviceInitializeDelayTimeInMs: 40000
  serviceUpdateIntervalTimerInMs: 60000

gray.client.instance

实例自身相关的灰度参数，比如自动注册灰度实例。

Property Name Default Value Remarks
grayEnroll false 是否自动注册为灰度服务，默认false
grayEnrollDealyTimeInMs 40000 触发自动注册的延迟时间 
gray:
  client:
  instance:
    grayEnroll: true
    grayEnrollDealyTimeInMs: 40000

gray.client.caches

缓存的配置属性，目前实例的灰度决策缓存策略(grayDecision)已应用

Property Name Default Value Remarks
maximumSize 1000 最大缓存数
expireSeconds 60 过期时间(秒) 
gray:
  client:
    caches:
      grayDecision:
        maximumSize: 1000
        expireSeconds: 60

gray.request

http request相关的配置

Property Name Default Value Remarks
loadBody false 是否记录请求body，不推荐 
gray:
  request:
    loadBody: false

gray.request.track

灰度追踪相关的配置

Property Name Default Value Remarks
enabled true 是否启用灰度追踪
trackType web 追踪类型: web环境
definitionsUpdateIntervalTimerInMs 60000 定时从拉取最新的追踪信息的间隔时间
definitionsInitializeDelayTimeInMs 40000 初始化追踪信息的延迟时间 
gray:
  request:
    track:
      enabled: true
      trackType:  web
      definitionsUpdateIntervalTimerInMs: 60000
      definitionsInitializeDelayTimeInMs: 40000

gray.request.track.web

Property Name Default Value Remarks
pathPatterns /* Filter拦截的uri，多个用逗号分隔
excludePathPatterns Filter拦截排除的uri，多个用逗号分隔 
gray:
  request:
    track:
      web:
        pathPatterns: /*
        excludePathPatterns: /static/*

gray.request.track.web.trackDefinitions

追踪项配置。这部分可以在项目中配置好，也可以在管控端编辑。优先级以管控端优先，项目配置次之。

Property Name Default Value Remarks
name 追踪项的名称
value 追踪项的内容(字段)，多个用逗号分隔 
gray:
  request:
    track:
      web:
        trackDefinitions:
          name: HttpHeader
          value: varsion

gray.holdoutServer

以Ribbon的举例，Ribbon在路由转发时，只会将请求转发给实例状态为UP的Server。 如果在新版本上线过程中，希望上线的实例不影响正常用户，同时又能在线上进行测试，这就需要Ribbon能够将特定的请求转发给不是UP状态的实例。通过该配置，可以实现。

Property Name Default Value Remarks
enabled false 是否开启
services 配置服务可以被转发的实例状态，该参数为Map<String, List>类型
zoneAffinity false 是否开启区域亲和
cacheable false 是否缓存 
gray:
  holdout-server:
    enabled: false
    zoneAffinity: false
    cacheable: false
    services:
      service-a: STARTING

gray.hystrix

Hystrix的相关配置

Property Name Default Value Remarks
enabled false 是否加载灰度hystrix的相关配置与实现类
threadTransmitStrategy WRAP_CALLABLE 线程变量传递策略，分别WRAP_CALLABLE,HYSTRIX_REQUEST_LOCAL_STORAGE
WRAP_CALLABLE: 使用com.netflix.hystrix.strategy.concurrency.HystrixConcurrencyStrategy实现
HYSTRIX_REQUEST_LOCAL_STORAGE: 使用com.netflix.hystrix.strategy.concurrency.HystrixRequestVariableDefault实现		 
gray:
  hystrix:
    enabled: true
    threadTransmitStrategy: WRAP_CALLABLE

版权声明：
作者：Joe.Ye
链接：https://www.appblog.cn/index.php/2023/03/27/spring-cloud-gray-configuration-parameters/
来源：APP全栈技术分享
文章版权归作者所有，未经允许请勿转载。

THE END
分享
二维码
打赏
海报
Spring Cloud Gray 配置参数
管控端 gray.server.discovery Property Name Default Value Remarks evictionEnabled true 定时同步注册中心实例状态的开关 evictionIntervalTimer……
<<上一篇
下一篇>>
文章目录
关闭
目 录