canaryrouter

README

Canary Router

Set canary flag for specified requests.

Use Cases

Set canary flag for specified requests and forward them to canary nodes in the upstream, in order to validate new features and identify issues in the gray stage.

Technical Solution

Retrieve the parameter value based on the key set in the gateway plugin. If the value is in the configured value list, set the canary flag.

Plugin Usage

• Enable Polaris canary routing in the gateway and upstream trpc framework configuration.
• Configure the canaryrouter plugin in the routing item with canary_key and values
• Set canary flag for upstream nodes
  • Set the canary:1 instance label for nodes in the Polaris console
• Note: Currently, Polaris canary routing only takes effect in the production environment

Import the Plugin in the main.go of the Gateway Project

import (
   _ "trpc.group/trpc-go/trpc-gateway/plugin/polaris/canaryrouter"
)

• Configure the canaryrouter interceptor in the tRPC framework configuration file.

Note: Make sure to register it in server.service.filter, not in server.filter

global:                             # Global configuration
server: # Server configuration
  filter:                                          # Interceptor list for all service handler functions
  service: # Business services provided, can have multiple
    - name: trpc.inews.trpc.gateway      # Routing name of the service
      filter:
        - canaryrouter: # Gateway plugin registered in the service filter, so that it can be dynamically loaded in router.yaml
plugins: # Plugin configuration
  log:                                            # Log configuration
  gateway: # Plugin type is gateway
    canaryrouter:  # Canary router plugin

Configure the Plugin in the Gateway Routing Configuration router.yaml

Different level plugins are executed only once, with the priority: routing plugin > service plugin > global plugin

router: # Routing configuration
  - method: /v1/user/info
    id: "xxxxxx"
    target_service:
      - service: trpc.user.service
    plugins:
      - name: canaryrouter
        props:
          request_key: user_id # Key of the request parameter to set the canary flag, if set_all is set, the canary flag will be set for all requests, and the parameters in query, header, and Cookie will be queried in order
          values: [ "xxx" ] # Value list of the request parameter to set the canary flag
          scale: 1 # Canary traffic ratio, in percentage, e.g., 0.01 for one in ten thousand
          hash_key: qimei36 # Canary traffic hash key
          canary_tag_val: my_canary # Polaris canary tag value, used with 123 to customize canary tags, default is 1
client: # Upstream service configuration, consistent with the trpc protocol
  - name: trpc.user.service
    plugins:
      - name: canaryrouter
        props:
plugins:

Documentation

Overview

Package canaryrouter Canary Router

Index

• type CanaryHandler
  • func (ehl *CanaryHandler) ServerFilter(ctx context.Context, req interface{}, handler filter.ServerHandleFunc) (interface{}, error)
• type Options
• type Plugin
  • func (p *Plugin) CheckConfig(_ string, decoder plugin.Decoder) error
  • func (p *Plugin) Setup(_ string, decoder plugin.Decoder) error
  • func (p *Plugin) Type() string

Types

type CanaryHandler

type CanaryHandler struct {
}

CanaryHandler Canary handler

func (*CanaryHandler) ServerFilter

func (ehl *CanaryHandler) ServerFilter(ctx context.Context, req interface{},
	handler filter.ServerHandleFunc) (interface{}, error)

ServerFilter Server interceptor

type Options

type Options struct {
	// ReqKey Canary key
	ReqKey string `yaml:"request_key"`
	// Values Canary values
	Values []string `yaml:"values"`

	// Canary traffic ratio, in percentage, e.g., 0.01 for one in ten thousand
	Scale float64 `yaml:"scale" json:"scale"`
	// Canary traffic hash key
	HashKey string `yaml:"hash_key" json:"hash_key"`
	// CanaryTagVal PolarisMesh Canary tag value, used with 123 to customize Canary tags, default is 1
	CanaryTagVal string `yaml:"canary_tag_val"`
	// contains filtered or unexported fields
}

Options Plugin configuration

type Plugin

type Plugin struct {
}

Plugin Plugin definition

func (*Plugin) CheckConfig

func (p *Plugin) CheckConfig(_ string, decoder plugin.Decoder) error

CheckConfig Validate plugin configuration and return the parsed configuration object. Used in ServerFilter method for parsing.

func (*Plugin) Setup

func (p *Plugin) Setup(_ string, decoder plugin.Decoder) error

Setup Plugin initialization

func (*Plugin) Type

func (p *Plugin) Type() string

Type Get plugin type