Skip to content

document-zh.md

Latest commit

 

History

History
181 lines (119 loc) · 9.98 KB

document-zh.md

File metadata and controls

181 lines (119 loc) · 9.98 KB
Raw

负载均衡

简体中文 | English

该文档主要介绍负载均衡插件的使用方法

功能:

根据配置中心的配置，无侵入地动态修改宿主应用的负载均衡策略。

负载均衡策略支持一览

框架类型 策略名 配置值 / 负载均衡策略 版本支持
dubbo 随机（dubbo默认） Random / RANDOM 2.6.x, 2.7.x
dubbo 轮询 RoundRobin / ROUNDROBIN 2.6.x, 2.7.x
dubbo 最少活跃 leastActive / LEASTACTIVE 2.6.x, 2.7.x
dubbo 一致性HASH consistentHash / CONSISTENTHASH 2.6.x, 2.7.x
dubbo 最短响应时间 shortestResponse / SHORTESTRESPONSE 2.7.7+
spring-cloud-netflix-ribbon 区域权重（ribbon默认） zoneAvoidance / ZONE_AVOIDANCE ZONE_AVOIDANCEspring cloud Edgware.x, spring cloud Finchley.x, spring cloud Greenwich.x, spring cloud Hoxton.x
spring-cloud-netflix-ribbon 随机 Random / RANDOM spring cloud Edgware.x, spring cloud Finchley.x, spring cloud Greenwich.x, spring cloud Hoxton.x
spring-cloud-netflix-ribbon 轮询 RoundRobin / ROUND_ROBIN spring cloud Edgware.x, spring cloud Finchley.x, spring cloud Greenwich.x, spring cloud Hoxton.x
spring-cloud-netflix-ribbon 重试 retry / RETRY spring cloud Edgware.x, spring cloud Finchley.x, spring cloud Greenwich.x, spring cloud Hoxton.x
spring-cloud-netflix-ribbon 最低并发 bestAvailable / BEST_AVAILABLE spring cloud Edgware.x, spring cloud Finchley.x, spring cloud Greenwich.x, spring cloud Hoxton.x
spring-cloud-netflix-ribbon 筛选过滤轮询 availabilityFiltering / AVAILABILITY_FILTERING spring cloud Edgware.x, spring cloud Finchley.x, spring cloud Greenwich.x, spring cloud Hoxton.x
spring-cloud-netflix-ribbon 响应时间加权重（Deprecated） ResponseTimeWeighted / RESPONSE_TIME_WEIGHTED spring cloud Edgware.x, spring cloud Finchley.x, spring cloud Greenwich.x, spring cloud Hoxton.x
spring-cloud-netflix-ribbon 响应时间加权重 weightedResponseTime / WEIGHTED_RESPONSE_TIME spring cloud Edgware.x, spring cloud Finchley.x, spring cloud Greenwich.x, spring cloud Hoxton.x
spring-cloud-loadbalancer 轮询（loadbalancer默认） RoundRobin / ROUND_ROBIN spring cloud Hoxton.SR10+, spring cloud 2020.0.x, spring cloud 2021.0.x
spring-cloud-loadbalancer 随机 Random / RANDOM spring cloud Hoxton.SR10+, spring cloud 2020.0.x, spring cloud 2021.0.x

配置说明

负载均衡基于配置中心进行动态配置，因此使用该能力需在配置中心配置对应负载均衡策略。负载均衡插件采用流量标记+负载均衡规则的方式规则，即配置一条规则需同时配置两者，下面分别介绍两项配置：

流量标记

流量标记用于标记当前针对那些服务生效，若服务为空，则会应用与所有微服务，配置示例如下:

配置key: servicecomb.matchGroup.testLb

配置键说明:

servicecomb.matchGroup. ：流量标记的固定前缀，所有key均需已此为前缀配置流量标记

testLb：业务场景名，对应的负载均衡规则需配置相同的业务场景名

配置content:

alias: loadbalancer-rule
matches:
- serviceName: zk-rest-provider  # 目标服务名

示例规则说明: serviceName为下游服务名，即针对请求微服务zk-rest-provider将应用匹配的负载均衡规则；若配置项serviceName未配置，则应用于所有微服务。需要注意的是，该配置仅需配置serviceName配置项，其他的格式需保持不变。

优先级说明：若同时配置了多个负载均衡规则，插件会优先匹配配置服务名的负载均衡规则，否则采用未配置服务名的匹配的负载均衡规则。

负载均衡规则

负载均衡规则需为应用配置具体的负载均衡策略，负载均衡策略目前完全依赖与宿主本身存在的负载均衡策略，即宿主本身支持才可配置，支持列表见负载均衡策略支持一览。

配置key：servicecomb.loadbalance.testLb

配置键说明:

servicecomb.loadbalance. ：负载均衡规则配置的固定前缀，所有key均需已此为前缀配置负载均衡规则

testLb：业务场景名，需与流量标记的业务场景相同才可生效

配置content:

rule: Random

示例配置项说明: 即配置随机负载均衡规则， 配置值见表负载均衡策略支持一览的配置值

以上需确认宿主自身应用的框架版本，确定当前支持的负载均衡策略。

发布配置

Sermant backend提供api的方式发布配置, 使用前需启动backend后台应用，如下为配置发布接口：

URL

POST /publishConfig

请求Body

参数 是否必填 参数类型 描述
key √ String 配置键
group √ String 配置组，用于配置订阅
content √ String 配置文本，即为具体规则

其中上表中key与content对应流量标记与负载均衡规则的配置key与配置content，而group则是针对指定服务的标签，group的配置采用标签对的模式进行配置，例如app=default&environment=development即对同时订阅该标签的微服务发布配置。

负载均衡插件默认会存在三种订阅标签：

  • 自定义标签：默认会订阅标签public=default，您也可以通过设置环境变量修改自定义标签，启动参数添加如下参数：-Dservice.meta.customLabel=public -Dservice.meta.customLabelValue=default
  • 微服务标签: 默认会订阅标签app=default&service=${yourServiceName}&environment=，其中${yourServiceName}为微服务的名称，environment默认为空。当然同样可以采用环境变量进行变更，启动参数添加如下参数：-Dservice.meta.application=default -Dservice.meta.environment=${yourEnvironment}, 分别对应app与envrionment，而服务名为动态获取。
  • 应用标签：默认会订阅标签app=default&&environment=, environment默认为空, 环境变量配置方式同微服务标签。

版本说明

  • 在spring cloud 2020.0.x之前，spring cloud负载均衡默认使用的核心组件为spring-cloud-netflix-ribbon（宿主应用可通过排除ribbon相关的组件使用spring-cloud-loadbalancer组件），从spring cloud 2020.0.x开始，负载均衡的核心组件为spring-cloud-loadbalancer。

  • 在spring cloud Hoxton.SR10之前，spring-cloud-loadbalancer的负载均衡策略只有轮询（ROUND_ROBIN），所以插件并不支持修改Hoxton. SR10之前的spring-cloud-loadbalancer组件的负载均衡策略，spring cloud Hoxton.SR10之前版本建议使用spring-cloud-netflix-ribbon组件进行负载均衡。

结果验证

  1. 前提条件已下载Sermant RELEASE包, 已下载demo源码，已下载zookeeper

  2. 启动zookeeper

  3. 启动backend, 参考后端模块介绍

  4. 编译demo应用

    mvn clean package

  5. 发布流量标记

    调用接口localhost:8900/publishConfig, 请求参数如下:

    {
    "content": "alias: loadbalancer-rule\nmatches:\n- serviceName: zk-rest-provider", 
    "group": {
        "app": "default", 
        "environment": "", 
        "service": "zk-rest-consumer"
    }, 
    "key": "servicecomb.matchGroup.testLb"
}

  6. 发布匹配的负载均衡规则（以Random为例）

    调用接口localhost:8900/publishConfig, 请求参数如下:

    {
    "content": "rule: Random", 
    "group": {
        "app": "default", 
        "environment": "", 
        "service": "zk-rest-consumer"
    }, 
    "key": "servicecomb.loadbalance.testLb"
}

  7. 启动生产者（两个实例）

    java -javaagent:${path}\sermant-agent-x.x.x\agent\sermant-agent.jar=appName=default -Dserver.port=${port} -jar zk-rest-provider.jar

    其中path需要替换为Sermant实际打包路径, port为生产者端口，这里需要启动两个实例, 请分别配置不同的端口，有利于结果观察

  8. 启动消费者（一个实例即可）

    java -javaagent:${path}\sermant-agent-x.x.x\agent\sermant-agent.jar=appName=default -Dserver.port=8005 -jar zk-rest-consumer.jar

  9. 测试

    上面步骤全部完成后，访问接口localhost:8005/hello, 通过返回的端口判断随机负载均衡规则（默认为轮询）是否生效。

返回Sermant说明文档