Implement Complex Canary Releases with MSE Cloud Native Gateway WASM Plugins

Background

Studies show that roughly 70% of production incidents are caused by changes. To limit risk, organizations validate new releases on a small, controlled slice of traffic before full rollout. Alibaba Cloud Microservice Engine (MSE) provides built‑in full‑link gray (canary) capabilities for microservice architectures.

Complex gray release scenarios

Random percentage selection based on a request parameter so that a given user consistently sees the same version.

OR‑logic routing: traffic from mobile apps (identified by a version header) or web browsers (identified by a tag query) should be sent to the canary lane.

Very low‑volume canary, e.g., 0.1% of total traffic.

Gray routing based on request body content.

WASM plugins for the MSE Cloud‑Native Gateway

WebAssembly (WASM) is a portable, high‑performance binary format that can run inside Envoy‑based gateways. MSE allows developers to upload custom WASM modules (written in Go, Rust, Lua, etc.) to extend request/response handling, authentication, traffic control, and more.

Plugin lifecycle

Develop a WASM module using the provided wrapper SDK.

Compile the module to a .wasm binary.

Upload the binary through the MSE plugin marketplace.

Configure the gateway to invoke the plugin for matching traffic.

Implementation example: parameter‑based percentage canary (Go)

Configuration structure

type ParamsRandomConfig struct {
    // Enable the parameter‑percentage feature
    paramsRandomEnable bool
    // Header key used for hashing, e.g. "userId"
    paramsRandomHeaderKey string
    // Desired percentage (0‑100)
    paramsPercentageRatio int64
}

Parsing YAML (converted to JSON) from the console

func parseConfig(json gjson.Result, cfg *ParamsRandomConfig, log wrapper.Log) error {
    cfg.paramsRandomEnable = json.Get("paramsRandomEnable").Bool()
    cfg.paramsRandomHeaderKey = json.Get("paramsRandomHeaderKey").String()
    cfg.paramsPercentageRatio = json.Get("paramsPercentageRatio").Int()
    return nil
}

Request‑header filter

func onHttpRequestHeaders(ctx wrapper.HttpContext, cfg ParamsRandomConfig, log wrapper.Log) types.Action {
    if cfg.paramsRandomEnable {
        headerVal, err := proxywasm.GetHttpRequestHeader(cfg.paramsRandomHeaderKey)
        if err != nil {
            proxywasm.LogErrorf("get header error: %v", err)
            return types.ActionContinue
        }
        // Hash the header value and map to 0‑99
        hash := sha256.Sum256([]byte(headerVal))
        hashInt := new(big.Int).SetBytes(hash[:])
        modulo := new(big.Int).Mod(hashInt, big.NewInt(100))
        if modulo.Cmp(big.NewInt(cfg.paramsPercentageRatio)) <= 0 {
            // Mark request for the gray lane
            proxywasm.AddHttpRequestHeader("x-mse-tag", "gray")
        } else {
            proxywasm.LogInfof("header %s not selected, hash %s", headerVal, hashInt)
        }
    }
    return types.ActionContinue
}

Compile the plugin with TinyGo

go mod tidy
tinygo build -o main.wasm -scheduler=none -target=wasi -gc=custom -tags='custommalloc nottinygc_finalizer' ./main.go

The resulting main.wasm is uploaded via the MSE plugin marketplace. After enabling the plugin, create a gray lane in the service‑governance configuration that matches requests containing x-mse-tag=gray. The gateway then routes those requests to the canary environment.

In the example the header userId is used as the hash key and the percentage is set to 10%. Requests with userId=1 always route to the gray lane, while userId=11 goes to the baseline.

Key considerations

WASM plugins enable fine‑grained, multi‑language extensions for the MSE gateway.

Deterministic header‑based hashing provides stable percentage canary routing.

The approach works for user‑based, geographic, traffic‑ratio, and request‑attribute routing.

Limitations: WASM cannot directly access external databases or spawn multiple threads; heavyweight logic should remain in backend services.

References

Implement an end‑to‑end canary release using MSE Cloud Native Gateways: https://help.aliyun.com/zh/mse/user-guide/implement-an-end-to-end-canary-release-by-using-mse-cloud-native-gateways?spm=a2c4g.11186623.0.0.226a5446EBhK5X

Develop plugins for MSE: https://help.aliyun.com/zh/mse/user-guide/14/?spm=a2c4g.11186623.0.0.73062e8dd0miqK