Oceanus：美团点评HTTP流量定制化路由的实践

640?wx_fmt=png

总第278篇

2018年第70篇

背景

Oceanus是美团基础架构部研发的统一HTTP服务治理框架，基于Nginx和ngx_lua扩展，主要提供服务注册与发现、动态负载均衡、可视化管理、定制化路由、安全反扒、session ID复用、熔断降级、一键截流和性能统计等功能。本文主要讲述Oceanus如何通过策略抽象、查询、渲染和分组动态更新，实现HTTP请求的定制化路由。

随着公司业务的高速发展，路由场景也越来越复杂。比如：

由于公司早期的业务场景相对比较简单，所以均通过Nginx if指令支持。比如某业务要把来源IP为10.4.242.16的请求转发到后端节点10.4.232.110，其它请求转发到后端节点10.4.232.111和10.4.232.112，就可以进行如下配置：

upstream backend_aaa {    server 10.4.232.110:8080 weight=10;}upstream backend_bbb {    server 10.4.232.111:8080 weight=10;    server 10.4.232.112:8080 weight=10;}location /abc {    if($remote_ip = "10.4.242.16") {        proxy_pass http://backend_aaa; #路由到backend_aaa集群    }    proxy_pass http://backend_bbb; #路由到backend_bbb集群}

上述方式虽然不需要额外开发，性能方面也接近原生的Nginx框架，但是使用场景比较受限，因为if指令仅支持比较简单的condition类型，其官方描述如下：

640?wx_fmt=jpeg

如果某业务要把IP段10.4.242.16/34的请求转发到10.4.232.110时，if指令勉强还可以支持。但对于上述的复杂业务场景，if指令均无法支持。除此之外，这种方式还存在以下两点不足：

为了解决上述问题，Oceanus开始探索如何实现HTTP流量的定制化路由。

业界调研

通过初步调研，发现业界有一套开源的ABTestingGateway（以下简称AB）框架：

640?wx_fmt=png

由上图所示，AB框架使用Redis存储策略数据，key是Host字段，value是策略对象，包括策略类型、匹配区间和要分发的Upstream。策略的增删改查可以通过基于Nginx搭建的Web服务的API实现，运行时根据请求的Host字段从lua-shared-dict或Redis获取关联的策略，根据策略类型（ iprange/uidrange/uidsuffix/uidappoint ）选择对应的Lua脚本从请求中获取相关参数（ IP、UID ）查询是否匹配策略，若匹配，就修改请求的Upstream上下文完成分流的目的。相比if指令的方式，AB框架有下面两个优点：

策略调整动态生效：已有策略类型中的策略变更均可以通过HTTP API进行动态管理。
分流策略丰富：支持IP段、UID段等策略，也可以通过新增策略类型对策略库进行扩展。

由于AB框架只支持4种策略类型，对于业务要根据请求Cookie、自定义header控制转发的情况，均需要开发新的策略类型和发布上线。另外，策略类型和业务场景紧密相关，导致AB系统的扩展性极差，很难快速支持新业务的路由需求。

无论是Nginx if指令，还是AB框架，要么需要reload重新加载才能生效，要么无法支持某些业务场景下的分流需求，所以都很难作为解决公司级分流框架的有效手段。针对它们所存在的不足，Oceanus开发了一套应用级、高可扩展的动态分流框架，不仅动态支持各种业务场景的分流需求，而且保证了请求转发的性能，下文将阐述我们如何解决分流机制的几个核心问题。

Oceanus定制化路由的核心设计&实现

关于分流机制，我们主要从以下四个方面来讲述：

策略抽象：合理定义策略结构，适用尽可能多的业务场景。
策略的高效查询：接口粒度关联，应用维度管理。
运行时策略渲染：渲染策略模板，判断是否匹配策略，实现动态路由。
分组动态更新：分组数据增删改，均不需要reload。

策略的结构定义

以AB框架为例，只支持iprange、uidrange、uidsuffix、uidappoint四种场景，对策略类型和匹配方式太具体化，导致无法支持更多普适性的业务场景。从分流的本质出发，即根据请求特征完成流量的定制化路由。结合Nginx if指令的几个组成部分：条件判断依赖的变量、条件判断要匹配的value、条件表达式、匹配后要执行的proxy_pass，一个策略必须要包含请求特征描述、定制化路由描述以及两者的关系描述。

其中请求特征描述包含特征关键字、关键字的上下文传输方式，定制化路由描述通过Upstream表示，Upstream可以预先设置，也可以动态指定，两者的关系通过泛型表达式表示。那么一个策略就需要包含下面几个属性：

name：策略名，没有实际意义，可以根据业务场景进行定义。
key：分流时依赖的关键字，比如要根据城市地域进行分发路由时，key就是regionid。
passway：关键字在HTTP协议中的传输方式，可以是Parameter、Cookie、header、body中的一种。
condition：表达式模板，支持四则运算/取模、关系运算符、逻辑运算符等。
group：后端服务集群，即匹配策略后，转发请求的目标节点，一般是策略所属应用集群中的部分节点。
category：策略类型，如果为1，表示某个服务的私有策略；如果为2，表示公共策略，主要用于策略数据管理。
switch：策略开关，用于控制当前策略是在线还是离线。
graylist：灰度列表，用于策略变更的线上灰度校验。

其中switch、graylist字段主要用于策略的上下线操作，这里不做过多讨论。下面重点介绍上面的策略定义是如何表述业务场景的：

640?wx_fmt=png

备注：应用apk1和apk2分别配置2个私有策略，apk3使用公共策略。如上图所示，无论业务根据请求的哪些特征进行分流，策略结构均可以支持。以私有策略gray-deploy为例，在Oceanus管理平台进行添加，如下图所示：

640?wx_fmt=jpeg

备注：这里省略了策略的非核心字段比如switch、graylist等。

如何实现策略的高效查询？

策略拓扑关系

分流策略分为私有策略和公共策略。私有策略是面向服务的，而且和该服务创建的分组紧密相关。不同服务的私有策略完全独立，可以相同，也可以不同。

一个服务可以配置多个私有策略，也可以关联多个Host的Location，Location之间的策略使用完全独立，一个Location可以启用该服务的一个或者多个私有策略。如果通过Host+location_path直接关联策略数据，不同Location关联同一个私有策略时，会存在大量的数据冗余。所以我们通过服务标识（appkey，唯一标识一个应用服务）关联具体的策略数据，Host+location_path只关联当前Location使用的策略名列表，策略之间支持指定顺序。

公共策略与具体服务无关，策略名全局唯一，可以使用策略名关联策略数据即可。综上，策略的拓扑关系描述如下：

640?wx_fmt=png

如上图所示，以应用apk1为例，关联了两个Location接口，分别为/api和/list，总共部署了8个节点，创建了2个分组ups-cq和ups-gray，其中节点10.5.23.6和10.5.24.72属于分组ups-cq，节点10.7.46.32和10.7.72.232属于分组ups-gray。应用配置了两个私有策略stress-testing和gray-deploy，其中策略stress-testing被接口/api启用，匹配策略的流量路由到分组ups-cq，策略gray-deploy被接口/list启用，匹配策略的流量路由到ups-gray。

运行时获取Location path

Nginx在解析Location配置时，通过不同的字段区分不同类型的Location，没有记录配置中的Location path。如果要运行时获取，一般有两种方式：一种是根据相关字段逆向还原path，另一种是为框架新增变量。由于Nginx在处理正则Location时，对于是否忽略大小写的情况，并没有做标记，即解析的过程是不可逆的，所以我们选择了第二种方式。在核心模块的变量数组ngx_http_core_variables中新增了内置变量，记录下原始的Location path，变量属性定义如下：

{ngx_string("loc_mod"), NULL, ngx_http_variable_loc_mod,  0, NGX_HTTP_VAR_NOCACHEABLE, 0},{ngx_string("loc_name"), NULL, ngx_http_variable_loc_name,  0, NGX_HTTP_VAR_NOCACHEABLE, 0}

loc_mod和loc_name之间用一个空格符连接，格式和Oceanus管理平台保持一致。