router

README

Router

The router is a client library for global service load balancing. Go-micro uses client side load balancing with the Selector interface but most implementation only provide a single view point of the environment, from the service itself. The router library talks to a backend service which aggregates metrics from all services and relays back routing information.

Interface

// The router is the client interface for 
// global service load balancing (GSLB).
// Metrics are batched and published to
// a router which has a view of the whole
// system.
type Router interface {
	// Provides the selector interface
	selector.Selector
	// Return stats maintained here
	Stats() ([]*Stats, error)
	// Record stats for a request - too many args ugh
	Record(r Request, node *registry.Node, d time.Duration, err error)
}

type Stats struct {
	Service   *registry.Service
	Client    *registry.Service
	Timestamp int64
	Duration  int64
	// TODO:
	// Selected
	// Endpoints
}

func NewRouter(opts ...selector.Option) Router {
	return newOS(opts...)
}

Supported Backends

• Router service

Documentation

Overview

Package router is an interface for global service routing.

Index

• Variables
• func Client(c client.Client) selector.Option
• func NewContext(ctx context.Context, c Router) context.Context
• func NewLabelWrapper(c client.Client) client.Client
• func Server(s server.Server) selector.Option
• type Request
• type Router
  • func FromContext(ctx context.Context) (Router, bool)
  • func NewRouter(opts ...selector.Option) Router
• type Stats

Variables

var (
	StatsTopic  = "micro.router.stats"
	LabelPrefix = "X-Micro-Label-"
)

Functions

func Client

func Client(c client.Client) selector.Option

func NewContext

func NewContext(ctx context.Context, c Router) context.Context

func NewLabelWrapper

func NewLabelWrapper(c client.Client) client.Client

func Server

func Server(s server.Server) selector.Option

Types

type Request

type Request interface {
	Service() string
	Method() string
}

Could be client or server request

type Router

type Router interface {
	// Provides the selector interface
	selector.Selector
	// Return stats maintained here
	Stats() ([]*Stats, error)
	// Record stats for a request - too many args ugh
	Record(r Request, node *registry.Node, d time.Duration, err error)
}

The router is the client interface to a global service loadbalancer (GSLB). Metrics are batched and published to a router which has a view of the whole system.

func FromContext

func FromContext(ctx context.Context) (Router, bool)

func NewRouter

func NewRouter(opts ...selector.Option) Router

type Stats

type Stats struct {
	Service   *registry.Service
	Client    *registry.Service
	Timestamp int64
	Duration  int64
}