Skip to content

Latest commit

 

History

History
166 lines (127 loc) · 6.04 KB

config.md

File metadata and controls

166 lines (127 loc) · 6.04 KB
Raw

配置参考手册

1. 配置文件

1.1 配置文件目录

├── config
│   ├── bootstrap.properties
│   ├── config.yaml
│   ├── lanes.json
│   ├── livespaces.json
│   ├── logback.xml
│   └── microservice.json
文件 说明
bootstrap.properties 启动相关配置
config.yaml 存放增强配置、插件定义以及多活流量治理策略配置
logback.xml 日志配置
livespaces.json 本地多活策略
lanes.json 本地泳道策略
microservice.json 本地微服务策略

1.2 bootstrap.properties

存放应用信息和类加载器配置

app.name=${APPLICATION_NAME}
app.service.name=${APPLICATION_SERVICE_NAME:${APPLICATION_NAME}}
app.service.namespace=${APPLICATION_SERVICE_NAMESPACE:default}
app.service.group=${APPLICATION_SERVICE_GROUP:default}
app.service.gateway=${APPLICATION_SERVICE_GATEWAY:NONE}
app.location.region=${APPLICATION_LOCATION_REGION}
app.location.zone=${APPLICATION_LOCATION_ZONE}
app.location.liveSpaceId=${APPLICATION_LOCATION_LIVESPACE_ID:${CONFIG_LIVESPACE_ID}}
app.location.unitRuleId=${APPLICATION_LOCATION_UNIT_RULE_ID}
app.location.unit=${APPLICATION_LOCATION_UNIT}
app.location.cell=${APPLICATION_LOCATION_CELL}
app.location.laneSpaceId=${APPLICATION_LOCATION_LANESPACE_ID}
app.location.lane=${APPLICATION_LOCATION_LANE}
agent.enhance.shutdownOnError=${CONFIG_ENHANCE_SHUTDOWN_ON_ERROR:true}

1.2 config.yaml

存放增强配置、插件定义以及多活流量治理策略配置。

其骨架如下：

agent:
  enhance: # 存放字节码增强配置
  publisher: # 存放事件总线配置
  plugin: # 插件配置
  sync: # 策略同步配置
  watchdog: # 文件变更监听配置
  switch: # 系统开关项
  governance: # 治理配置
  counter: # 流量统计配置

1.2.1 字节码

1.3 livespaces.json

请参阅多活治理模型

1.4 microservice.json

请参阅微服务治理模型

1.5 lanes.json

请参阅泳道模型

2. 环境变量

配置文件bootstrap.properties和config.yaml的配置项的值支持环境变量占位符。支持的格式如下：

  • ${KEY}
  • ${KEY:defaultValue}
  • ${KEY:${KEY2}}

环境变量名称建议大写

2.1 环境变量来源

  1. 系统环境变量

System.getenv()

  1. 系统属性

System.getProperties()

  1. 应用资源文件

应用类根路径下的live-agent.properties

  1. 应用名称

application.properties、application.yaml或application.yml

  1. 扩展实现环境提供者
@Extensible
public interface EnvSupplier {
    
    void process(Map<String, Object> env);
    
}
classDiagram
direction BT
class AbstractEnvSupplier {
  # loadConfigs() Map~String, Object~
  # loadConfigs(String, String) Map~String, Object~
  # parse(InputStream, ConfigParser) Map~String, Object~
  + AbstractEnvSupplier(String[]) 
}
class ConfigEnvSupplier {
  + process(Map~String, Object~) void
  + ConfigEnvSupplier() 
}
class EnvSupplier {
<<Interface>>
  + process(Map~String, Object~) void
}
class SpringEnvSupplier {
  + process(Map~String, Object~) void
  + SpringEnvSupplier() 
}

AbstractEnvSupplier  ..>  EnvSupplier 
ConfigEnvSupplier  -->  AbstractEnvSupplier 
SpringEnvSupplier  -->  AbstractEnvSupplier
Loading
  1. ConfigEnvSupplier从应用资源路径加载live-agent.properties
  2. SpringEnvSupplier从应用资源路径加载应用名称

2.2 常用环境变量

更多请参考bootstrap.properties和config.yaml中的配置

名称 说明 必需 默认值 说明
APPLICATION_NAME 应用名 是 建议和Spring的应用名称保持一致
APPLICATION_SERVICE_NAME 服务名 否 应用名称 建议和SpringCloud的应用名称保持一致
APPLICATION_LOCATION_LIVESPACE_ID 实例所在多活空间ID 是
APPLICATION_LOCATION_UNIT 实例所在单元编码 是
APPLICATION_LOCATION_CELL 实例所在分区编码 是
APPLICATION_LOCATION_LANESPACE_ID 实例所在泳道空间ID 否 当启用泳道服务时候配置
APPLICATION_LOCATION_LANE 实例所在泳道编码 否 当启用泳道服务时候配置
APPLICATION_LOCATION_REGION 实例所在地域 否
APPLICATION_LOCATION_ZONE 实例所在可用区 否
CONFIG_LIVE_ENABLED 启用多活流控 否 true 是否要进行多活的流控
CONFIG_POLICY_INITIALIZE_TIMEOUT 策略同步超时 否 10000(ms)
CONFIG_FLOW_CONTROL_ENABLED 启用服务流控 否 true 启用服务流控，包括限流、熔断、负载均衡、标签路由等等策略
CONFIG_LANE_ENABLED 启用泳道流控 否 true 启用泳道流控
CONFIG_WARMUP_SERVICES 预热服务 否 配置预热的微服务名称，多个服务用分号或逗号分隔