配置规则

在 Dubbo 中配置应用级治理规则和服务级治理规则

提示

本文描述的是新版本规则配置，而不是老版本配置规则

覆盖规则是 Dubbo 设计的在无需重启应用的情况下，动态调整 RPC 调用行为的一种能力。2.7.0 版本开始，支持从服务和应用两个粒度来调整动态配置。

概览

请在服务治理控制台查看或修改覆盖规则。

应用粒度

  1. # 将应用demo（key:demo）在20880端口上提供（side:provider）的所有服务（scope:application）的权重修改为1000（weight:1000）。
  2. ---
  3. configVersion: v2.7
  4. scope: application
  5. key: demo
  6. enabled: true
  7. configs:
  8. - addresses: ["0.0.0.0:20880"]
  9.   side: provider
  10.   parameters:
  11.   weight: 1000
  12.   ...

服务粒度

  1. # 所有消费（side:consumer）DemoService服务（key:org.apache.dubbo.samples.governance.api.DemoService）的应用实例（addresses:[0.0.0.0]），超时时间修改为6000ms
  2. ---
  3. configVersion: v2.7
  4. scope: service
  5. key: org.apache.dubbo.samples.governance.api.DemoService
  6. enabled: true
  7. configs:
  8. - addresses: [0.0.0.0]
  9.   side: consumer
  10.   parameters:
  11.   timeout: 6000
  12.   ...

规则详解

配置模板

  1. ---
  2. configVersion: v2.7
  3. scope: application/service
  4. key: app-name/group+service+version
  5. enabled: true
  6. configs:
  7. - addresses: ["0.0.0.0"]
  8.   providerAddresses: ["1.1.1.1:20880", "2.2.2.2:20881"]
  9.   side: consumer
  10.   applications/services: []
  11.   parameters:
  12.     timeout: 1000
  13.     cluster: failfase
  14.     loadbalance: random
  15. - addresses: ["0.0.0.0:20880"]
  16.   side: provider
  17.   applications/services: []
  18.   parameters:
  19.     threadpool: fixed
  20.     threads: 200
  21.     iothreads: 4
  22.     dispatcher: all
  23.     weight: 200
  24. ...

其中：

  • configVersion 表示 dubbo 的版本
  • scope表示配置作用范围，分别是应用（application）或服务（service）粒度。必填。
  • key 指定规则体作用在哪个服务或应用。必填。
    • scope=service时，key取值为[{group}:]{service}[:{version}]的组合
  • scope=application时，key取值为application名称
  • enabled=true 覆盖规则是否生效，可不填，缺省生效。
  • configs 定义具体的覆盖规则内容，可以指定n（n>=1）个规则体。必填。
    • side，
    • applications
    • services
    • parameters
    • addresses
    • providerAddresses

对于绝大多数配置场景，只需要理清楚以下问题基本就知道配置该怎么写了：

  1. 要修改整个应用的配置还是某个服务的配置。

    • 应用：scope: application, key: app-name（还可使用services指定某几个服务）。
    • 服务：scope: service, key:group+service+version 。

  2. 修改是作用到消费者端还是提供者端。

    • 消费者：side: consumer ，作用到消费端时（你还可以进一步使用providerAddress, applications选定特定的提供者示例或应用）。
    • 提供者：side: provider。

  3. 配置是否只对某几个特定实例生效。

    • 所有实例：addresses: ["0.0.0.0"] 或addresses: ["0.0.0.0:*"] 具体由side值决定。
    • 指定实例：addersses[实例地址列表]。
  4. 要修改的属性是哪个。

示例

  1. 禁用提供者：(通常用于临时踢除某台提供者机器，相似的，禁止消费者访问请使用路由规则)

    1. ---
    2. configVersion: v2.7
    3. scope: application
    4. key: demo-provider
    5. enabled: true
    6. configs:
    7. - addresses: ["10.20.153.10:20880"]
    8.   side: provider
    9.   parameters:
    10.     disabled: true
    11. ...

  2. 调整权重：(通常用于容量评估，缺省权重为 200)

    1. ---
    2. configVersion: v2.7
    3. scope: application
    4. key: demo-provider
    5. enabled: true
    6. configs:
    7. - addresses: ["10.20.153.10:20880"]
    8.   side: provider
    9.   parameters:
    10.     weight: 200
    11. ...

  3. 调整负载均衡策略：(缺省负载均衡策略为 random)

    1. ---
    2. configVersion: v2.7
    3. scope: application
    4. key: demo-consumer
    5. enabled: true
    6. configs:
    7. - side: consumer
    8.   parameters:
    9.     loadbalance: random
    10. ...

  4. 服务降级：(通常用于临时屏蔽某个出错的非关键服务)

    1. ---
    2. configVersion: v2.7
    3. scope: service
    4. key: org.apache.dubbo.samples.governance.api.DemoService
    5. enabled: true
    6. configs:
    7. - side: consumer
    8.  parameters:
    9.    force: return null
    10. ...

最后修改 September 21, 2021: Bug fix miss mialbox (#953) (57cf51b)