yarpc

README

yarpc

A message passing platform for Go that lets you:

• Write servers and clients with various encodings, including JSON, Thrift, and Protobuf.
• Expose servers over many transports simultaneously, including HTTP/1.1, gRPC, and TChannel.
• Migrate outbound calls between transports without any code changes using config.

Installation

We recommend locking to SemVer range ^1 using Glide:

glide get 'go.uber.org/yarpc#^1'

Stability

This library is v1 and follows SemVer strictly.

No breaking changes will be made to exported APIs before v2.0.0 with the exception of experimental packages.

Experimental packages reside within packages named x, and are not stable. This means their APIs can break at any time. The intention here is to validate these APIs and iterate on them by working closely with internal customers. Once stable, their contents will be moved out of the containing x package and their APIs will be locked.

Documentation

Overview

Package yarpc provides the YARPC service framework.

With hundreds to thousands of services communicating with RPC, transport protocols (like HTTP and TChannel), encoding protocols (like JSON or Thrift), and peer choosers are the concepts that vary year over year. Separating these concerns allows services to change transports and wire protocols without changing call sites or request handlers, build proxies and wire protocol bridges, or experiment with load balancing strategies. YARPC is a toolkit for services and proxies.

YARPC breaks RPC into interchangeable encodings, transports, and peer choosers. YARPC for Go provides reference implementations for HTTP/1.1, TChannel and gRPC transports, and also raw, JSON, Thrift, and Protobuf encodings. YARPC for Go provides a round robin peer chooser and experimental implementations for debug pages and rate limiting. YARPC for Go plans to provide a load balancer that uses a least-pending-requests strategy. Peer choosers can implement any strategy, including load balancing or sharding, in turn bound to any peer list updater.

Regardless of transport, every RPC has some common properties: caller name, service name, procedure name, encoding name, deadline or TTL, headers, baggage (multi-hop headers), and tracing. Each RPC can also have an optional shard key, routing key, or routing delegate for advanced routing. YARPC transports use a shared API for capturing RPC metadata, so middleware can apply to requests over any transport.

Each YARPC transport protocol can implement inbound handlers and outbound callers. Each of these can support different RPC types, like unary (request and response) or oneway (request and receipt) RPC. A future release of YARPC will add support for other RPC types including variations on streaming and pubsub.

Index

• Constants
• Variables
• func CanonicalizeHeaderKey(k string) string
• func InjectClients(src transport.ClientConfigProvider, dest interface{})
• func IsBadRequestError(err error) bool
• func IsTimeoutError(err error) bool
• func IsUnexpectedError(err error) bool
• func OnewayInboundMiddleware(mw ...middleware.OnewayInbound) middleware.OnewayInbound
• func OnewayOutboundMiddleware(mw ...middleware.OnewayOutbound) middleware.OnewayOutbound
• func RegisterClientBuilder(f interface{}) (forget func())
• func StreamInboundMiddleware(mw ...middleware.StreamInbound) middleware.StreamInbound
• func StreamOutboundMiddleware(mw ...middleware.StreamOutbound) middleware.StreamOutbound
• func UnaryInboundMiddleware(mw ...middleware.UnaryInbound) middleware.UnaryInbound
• func UnaryOutboundMiddleware(mw ...middleware.UnaryOutbound) middleware.UnaryOutbound
• type Ack
• type Call
  • func CallFromContext(ctx context.Context) *Call
  • func (c *Call) Caller() string
  • func (c *Call) Encoding() transport.Encoding
  • func (c *Call) Header(k string) string
  • func (c *Call) HeaderNames() []string
  • func (c *Call) Procedure() string
  • func (c *Call) RoutingDelegate() string
  • func (c *Call) RoutingKey() string
  • func (c *Call) Service() string
  • func (c *Call) ShardKey() string
  • func (c *Call) WriteResponseHeader(k, v string) error
• type CallOption
  • func ResponseHeaders(h *map[string]string) CallOption
  • func WithHeader(k, v string) CallOption
  • func WithRoutingDelegate(rd string) CallOption
  • func WithRoutingKey(rk string) CallOption
  • func WithShardKey(sk string) CallOption
• type ClientConfig
• type Config
• type Dispatcher
  • func NewDispatcher(cfg Config) *Dispatcher
  • func (d *Dispatcher) ClientConfig(outboundKey string) transport.ClientConfig
  • func (d *Dispatcher) InboundMiddleware() InboundMiddleware
  • func (d *Dispatcher) Inbounds() Inbounds
  • func (d *Dispatcher) Introspect() introspection.DispatcherStatus
  • func (d *Dispatcher) MustOutboundConfig(outboundKey string) *transport.OutboundConfig
  • func (d *Dispatcher) Name() string
  • func (d *Dispatcher) OutboundConfig(outboundKey string) (oc *transport.OutboundConfig, ok bool)
  • func (d *Dispatcher) Register(rs []transport.Procedure)
  • func (d *Dispatcher) Router() transport.Router
  • func (d *Dispatcher) Start() error
  • func (d *Dispatcher) Stop() error
• type InboundMiddleware
• type Inbounds
• type LoggingConfig
• type MapRouter
  • func NewMapRouter(defaultService string) MapRouter
  • func (m MapRouter) Choose(ctx context.Context, req *transport.Request) (transport.HandlerSpec, error)
  • func (m MapRouter) Procedures() []transport.Procedure
  • func (m MapRouter) Register(rs []transport.Procedure)
• type MetricsConfig
• type OutboundMiddleware
• type Outbounds
• type RouterMiddleware
• type StreamOption

Examples

• Dispatcher (Minimal)
• Dispatcher.Register (JSON)
• Dispatcher.Register (Raw)

Constants

const Version = "1.27.2"

Version is the current version of YARPC.

Variables

var OpentracingTags = opentracing.Tags{
	"yarpc.version": Version,
	"go.version":    runtime.Version(),
}

OpentracingTags are tags with YARPC metadata.

var PackageVersions = []introspection.PackageVersion{
	{Name: "yarpc", Version: Version},
	{Name: "tchannel", Version: tchannel.VersionInfo},
	{Name: "thriftrw", Version: thriftrw.Version},
	{Name: "go", Version: runtime.Version()},
}

PackageVersions is a list of packages with corresponding versions.

Functions

func CanonicalizeHeaderKey

func CanonicalizeHeaderKey(k string) string

CanonicalizeHeaderKey canonicalizes the given header key to the same form used by the headers map returned by ResponseHeaders.

var headers map[string]string
res, err := client.Call(ctx, "hello", requestBody, ResponseHeaders(&headers))
email, ok := headers[CanonicalizeHeaderKey("User-Email-Address")]

func InjectClients

func InjectClients(src transport.ClientConfigProvider, dest interface{})

InjectClients injects clients from a Dispatcher into the given struct. dest must be a pointer to a struct with zero or more exported fields which hold YARPC client types. This includes json.Client, raw.Client, and any generated Thrift service client. Fields with nil values and a `service` tag will be populated with clients using that service`s ClientConfig.

Given,

type Handler struct {
	KeyValueClient keyvalueclient.Interface `service:"keyvalue"`
	UserClient json.Client `service:"users"`
	TagClient tagclient.Interface  // no tag; will be left unchanged
}

The call,

var h Handler
yarpc.InjectClients(dispatcher, &h)

Is equivalent to,

var h Handler
h.KeyValueClient = keyvalueclient.New(dispatcher.ClientConfig("keyvalue"))
h.UserClient = json.New(dispatcher.ClientConfig("users"))

Builder functions for different client types may be registered using the RegisterClientBuilder function.

This function panics if a field with an unknown type and nil value has the `service` tag.

func IsBadRequestError

func IsBadRequestError(err error) bool

IsBadRequestError returns true on an error returned by RPC clients if the request was rejected by YARPC because it was invalid.

res, err := client.Call(...)
if yarpc.IsBadRequestError(err) {
	fmt.Println("invalid request:", err)
}

Deprecated: use yarpcerrors.FromError(err).Code() == yarpcerrors.CodeInvalidArgument instead.

func IsTimeoutError

func IsTimeoutError(err error) bool

IsTimeoutError returns true on an error returned by RPC clients if the given error is a TimeoutError.

res, err := client.Call(...)
if yarpc.IsTimeoutError(err) {
	fmt.Println("request timed out:", err)
}

Deprecated: use yarpcerrors.FromError(err).Code() == yarpcerrors.CodeDeadlineExceeded instead.

func IsUnexpectedError

func IsUnexpectedError(err error) bool

IsUnexpectedError returns true on an error returned by RPC clients if the server panicked or failed with an unhandled error.

res, err := client.Call(...)
if yarpc.IsUnexpectedError(err) {
	fmt.Println("internal server error:", err)
}

Deprecated: use yarpcerrors.FromError(err).Code() == yarpcerrors.CodeInternal instead.

func OnewayInboundMiddleware

func OnewayInboundMiddleware(mw ...middleware.OnewayInbound) middleware.OnewayInbound

OnewayInboundMiddleware combines the given collection of unary inbound middleware in-order into a single OnewayInbound middleware.

func OnewayOutboundMiddleware

func OnewayOutboundMiddleware(mw ...middleware.OnewayOutbound) middleware.OnewayOutbound

OnewayOutboundMiddleware combines the given collection of unary outbound middleware in-order into a single OnewayOutbound middleware.

func RegisterClientBuilder

func RegisterClientBuilder(f interface{}) (forget func())

RegisterClientBuilder registers a builder function for a specific client type.

Functions must have one of the following signatures:

func(transport.ClientConfig) T
func(transport.ClientConfig, reflect.StructField) T

Where T is the type of the client. T MUST be an interface. In the second form, the function receives type information about the field being filled. It may inspect the struct tags to customize its behavior.

This function panics if a client for the given type has already been registered.

After a builder function for a client type is registered, these objects can be instantiated automatically using InjectClients.

A function to unregister the builder function is returned. Note that the function will clear whatever the corresponding type's builder function is at the time it is called, regardless of whether the value matches what was passed to this function or not.

func StreamInboundMiddleware

func StreamInboundMiddleware(mw ...middleware.StreamInbound) middleware.StreamInbound

StreamInboundMiddleware combines the given collection of unary inbound middleware in-order into a single StreamInbound middleware.

func StreamOutboundMiddleware

func StreamOutboundMiddleware(mw ...middleware.StreamOutbound) middleware.StreamOutbound

StreamOutboundMiddleware combines the given collection of unary outbound middleware in-order into a single StreamOutbound middleware.

func UnaryInboundMiddleware

func UnaryInboundMiddleware(mw ...middleware.UnaryInbound) middleware.UnaryInbound

UnaryInboundMiddleware combines the given collection of unary inbound middleware in-order into a single UnaryInbound middleware.

func UnaryOutboundMiddleware

func UnaryOutboundMiddleware(mw ...middleware.UnaryOutbound) middleware.UnaryOutbound

UnaryOutboundMiddleware combines the given collection of unary outbound middleware in-order into a single UnaryOutbound middleware.

Types

type Ack

type Ack interface {
	fmt.Stringer
}

Ack represents an acknowledgement from a oneway request.

type Call

type Call encoding.Call

Call provides information about the current request inside handlers. An instance of Call for the current request can be obtained by calling CallFromContext on the request context.

func Get(ctx context.Context, req *GetRequest) (*GetResponse, error) {
	call := yarpc.CallFromContext(ctx)
	fmt.Println("Received request from", call.Caller())
	if err := call.WriteResponseHeader("hello", "world"); err != nil {
		return nil, err
	}
	return response, nil
}

func CallFromContext

func CallFromContext(ctx context.Context) *Call

CallFromContext retrieves information about the current incoming request from the given context. Returns nil if the context is not a valid request context.

The object is valid only as long as the request is ongoing.

func (*Call) Caller

func (c *Call) Caller() string

Caller returns the name of the service making this request.

func (*Call) Encoding

func (c *Call) Encoding() transport.Encoding

Encoding returns the encoding for this request.

func (*Call) Header

func (c *Call) Header(k string) string

Header returns the value of the given request header provided with the request.

func (*Call) HeaderNames

func (c *Call) HeaderNames() []string

HeaderNames returns a sorted list of the names of user defined headers provided with this request.

func (*Call) Procedure

func (c *Call) Procedure() string

Procedure returns the name of the procedure being called.

func (*Call) RoutingDelegate

func (c *Call) RoutingDelegate() string

RoutingDelegate returns the routing delegate for this request.

func (*Call) RoutingKey

func (c *Call) RoutingKey() string

RoutingKey returns the routing key for this request.

func (*Call) Service

func (c *Call) Service() string

Service returns the name of the service being called.

func (*Call) ShardKey

func (c *Call) ShardKey() string

ShardKey returns the shard key for this request.

func (*Call) WriteResponseHeader

func (c *Call) WriteResponseHeader(k, v string) error

WriteResponseHeader writes headers to the response of this call.

type CallOption

type CallOption encoding.CallOption

CallOption defines options that may be passed in at call sites to other services.

These may be used to add or alter the request.

func ResponseHeaders

func ResponseHeaders(h *map[string]string) CallOption

ResponseHeaders specifies that headers received in response to this request should replace the given map.

Header keys in the map are normalized using the CanonicalizeHeaderKey function.

var resHeaders map[string]string
resBody, err := client.SetValue(ctx, key, value, yarpc.ResponseHeaders(&resHeaders))
value, ok := resHeaders[yarpc.CanonicalizeHeaderKey("foo")]

Note that the map is replaced completely. Entries it had before making the call will not be available afterwards.

headers := map[string]string{"hello": "world"}
resBody, err := client.SetValue(ctx, key, value, yarpc.ResponseHeaders(&headers))
_, ok := headers["hello"]
fmt.Println(ok)  // false

func WithHeader

func WithHeader(k, v string) CallOption

WithHeader adds a new header to the request. Header keys are case insensitive.

_, err := client.GetValue(ctx, reqBody, yarpc.WithHeader("Token", "10"))
// ==> {"token": "10"}

If multiple entries have the same normalized header name, newer entries override older ones.

func WithRoutingDelegate

func WithRoutingDelegate(rd string) CallOption

WithRoutingDelegate sets the routing delegate for the request.

func WithRoutingKey

func WithRoutingKey(rk string) CallOption

WithRoutingKey sets the routing key for the request.

func WithShardKey

func WithShardKey(sk string) CallOption

WithShardKey sets the shard key for the request.

type ClientConfig

type ClientConfig interface {
	transport.ClientConfigProvider
}

ClientConfig builds transport.ClientConfigs which specify the means of making a request from this service to another service by name.

type Config

type Config struct {
	// Name of the service. This is the name used by other services when
	// making requests to this service.
	Name string

	// Inbounds define how this service receives incoming requests from other
	// services.
	//
	// This may be nil if this service does not receive any requests.
	Inbounds Inbounds

	// Outbounds defines how this service makes requests to other services.
	//
	// This may be nil if this service does not send any requests.
	Outbounds Outbounds

	// Inbound and Outbound Middleware that will be applied to all incoming
	// and outgoing requests respectively.
	//
	// These may be nil if there is no middleware to apply.
	InboundMiddleware  InboundMiddleware
	OutboundMiddleware OutboundMiddleware

	// Tracer is meant to add/record tracing information to a request.
	//
	// Deprecated: The dispatcher does nothing with this property.  Set the
	// tracer directly on the transports used to build inbounds and outbounds.
	Tracer opentracing.Tracer

	// RouterMiddleware is middleware to control how requests are routed.
	RouterMiddleware middleware.Router

	// Configures logging.
	Logging LoggingConfig

	// Configures telemetry.
	Metrics MetricsConfig
}

Config specifies the parameters of a new Dispatcher constructed via NewDispatcher.

type Dispatcher

type Dispatcher struct {
	// contains filtered or unexported fields
}

Dispatcher encapsulates a YARPC application. It acts as the entry point to send and receive YARPC requests in a transport and encoding agnostic way.

Example (Minimal)

package main

import (
	"log"

	"go.uber.org/yarpc"
)

func main() {
	dispatcher := yarpc.NewDispatcher(yarpc.Config{Name: "myFancyService"})
	if err := dispatcher.Start(); err != nil {
		log.Fatal(err)
	}
	defer dispatcher.Stop()
}

func NewDispatcher

func NewDispatcher(cfg Config) *Dispatcher

NewDispatcher builds a new Dispatcher using the specified Config. At minimum, a service name must be specified.

Invalid configurations or errors in constructing the Dispatcher will cause panics.

func (*Dispatcher) ClientConfig

func (d *Dispatcher) ClientConfig(outboundKey string) transport.ClientConfig

ClientConfig provides the configuration needed to talk to the given service through an outboundKey. This configuration may be directly passed into encoding-specific RPC clients.

keyvalueClient := json.New(dispatcher.ClientConfig("keyvalue"))

This function panics if the outboundKey is not known.

func (*Dispatcher) InboundMiddleware

func (d *Dispatcher) InboundMiddleware() InboundMiddleware

InboundMiddleware returns the middleware applied to all inbound handlers. Router middleware and fallback handlers can use the InboundMiddleware to wrap custom handlers.

func (*Dispatcher) Inbounds

func (d *Dispatcher) Inbounds() Inbounds

Inbounds returns a copy of the list of inbounds for this RPC object.

The Inbounds will be returned in the same order that was used in the configuration.

func (*Dispatcher) Introspect

func (d *Dispatcher) Introspect() introspection.DispatcherStatus

Introspect returns detailed information about the dispatcher. This function acquires a lots of locks throughout and should only be called with some reserve. This method is public merely for use by the package yarpcmeta. The result of this function is internal to yarpc anyway.

func (*Dispatcher) MustOutboundConfig

func (d *Dispatcher) MustOutboundConfig(outboundKey string) *transport.OutboundConfig

MustOutboundConfig provides the configuration needed to talk to the given service through an outboundKey. This configuration may be directly passed into encoding-specific RPC clients.

keyvalueClient := json.New(dispatcher.MustOutboundConfig("keyvalue"))

This function panics if the outboundKey is not known.

func (*Dispatcher) Name

func (d *Dispatcher) Name() string

Name returns the name of the dispatcher.

func (*Dispatcher) OutboundConfig

func (d *Dispatcher) OutboundConfig(outboundKey string) (oc *transport.OutboundConfig, ok bool)

OutboundConfig provides the configuration needed to talk to the given service through an outboundKey. This configuration may be directly passed into encoding-specific RPC clients.

 outboundConfig, ok := dispatcher.OutboundConfig("keyvalue")
 if !ok {
   // do something
 }
	keyvalueClient := json.New(outboundConfig)

func (*Dispatcher) Register

func (d *Dispatcher) Register(rs []transport.Procedure)

Register registers zero or more procedures with this dispatcher. Incoming requests to these procedures will be routed to the handlers specified in the given Procedures.

Example (JSON)

package main

import (
	"context"
	"fmt"

	"go.uber.org/yarpc"
	"go.uber.org/yarpc/encoding/json"
)

// global dispatcher used in the registration examples
var dispatcher = yarpc.NewDispatcher(yarpc.Config{Name: "service"})

func main() {
	handler := func(ctx context.Context, key string) (string, error) {
		fmt.Println("key", key)
		return "value", nil
	}

	dispatcher.Register(json.Procedure("get", handler))
}

Example (Raw)

package main

import (
	"context"

	"go.uber.org/yarpc"
	"go.uber.org/yarpc/encoding/raw"
)

// global dispatcher used in the registration examples
var dispatcher = yarpc.NewDispatcher(yarpc.Config{Name: "service"})

func main() {
	handler := func(ctx context.Context, data []byte) ([]byte, error) {
		return data, nil
	}

	dispatcher.Register(raw.Procedure("echo", handler))
}

func (*Dispatcher) Router

func (d *Dispatcher) Router() transport.Router

Router returns the procedure router.

func (*Dispatcher) Start

func (d *Dispatcher) Start() error

Start starts the Dispatcher, allowing it to accept and processing new incoming requests.

This starts all inbounds and outbounds configured on this Dispatcher.

This function returns immediately after everything has been started. Servers should add a `select {}` to block to process all incoming requests.

if err := dispatcher.Start(); err != nil {
	log.Fatal(err)
}
defer dispatcher.Stop()

select {}

func (*Dispatcher) Stop

func (d *Dispatcher) Stop() error

Stop stops the Dispatcher.

This stops all outbounds and inbounds owned by this Dispatcher.

This function returns after everything has been stopped.

type InboundMiddleware

type InboundMiddleware struct {
	Unary  middleware.UnaryInbound
	Oneway middleware.OnewayInbound
	Stream middleware.StreamInbound
}

InboundMiddleware contains the different types of inbound middlewares.

type Inbounds

type Inbounds []transport.Inbound

Inbounds contains a list of inbound transports. Each inbound transport specifies a source through which incoming requests are received.

type LoggingConfig

type LoggingConfig struct {
	// Supplies a logger for the dispatcher. By default, no logs are
	// emitted.
	Zap *zap.Logger
	// If supplied, ExtractContext is used to log request-scoped
	// information carried on the context (e.g., trace and span IDs).
	ContextExtractor func(context.Context) zapcore.Field
}

LoggingConfig describes how logging should be configured.

type MapRouter

type MapRouter struct {
	// contains filtered or unexported fields
}

MapRouter is a Router that maintains a map of the registered procedures.

func NewMapRouter

func NewMapRouter(defaultService string) MapRouter

NewMapRouter builds a new MapRouter that uses the given name as the default service name.

func (MapRouter) Choose

func (m MapRouter) Choose(ctx context.Context, req *transport.Request) (transport.HandlerSpec, error)

Choose retrives the HandlerSpec for the service, procedure, and encoding noted on the transport request, or returns an unrecognized procedure error (testable with transport.IsUnrecognizedProcedureError(err)).

func (MapRouter) Procedures

func (m MapRouter) Procedures() []transport.Procedure

Procedures returns a list procedures that have been registered so far.

func (MapRouter) Register

func (m MapRouter) Register(rs []transport.Procedure)

Register registers the procedure with the MapRouter. If the procedure does not specify its service name, the procedure will inherit the default service name of the router. Procedures should specify their encoding, and multiple procedures with the same name and service name can exist if they handle different encodings. If a procedure does not specify an encoding, it can only support one handler. The router will select that handler regardless of the encoding.

type MetricsConfig

type MetricsConfig struct {
	// Metrics is a *"go.uber.org/net/metrics".Scope for recording stats.
	// YARPC does not push these metrics; pushing metrics from the root is an
	// external concern.
	Metrics *metrics.Scope
	// Tally scope used for pushing to M3 or StatsD-based systems. By
	// default, metrics are collected in memory but not pushed.
	// TODO deprecate this option for metrics configuration.
	Tally tally.Scope
}

MetricsConfig describes how telemetry should be configured. Scope and Tally are exclusive; choose one. If neither is present, metrics are not recorded, all instrumentation becomes no-ops. If both are present, we emit a warning and ignore Tally. If a metrics scope is preseent, we use that scope to record metrics and they are not pushed to Tally. If Tally is present, we use its metrics scope and push them periodically.

type OutboundMiddleware

type OutboundMiddleware struct {
	Unary  middleware.UnaryOutbound
	Oneway middleware.OnewayOutbound
	Stream middleware.StreamOutbound
}

OutboundMiddleware contains the different types of outbound middlewares.

type Outbounds

type Outbounds map[string]transport.Outbounds

Outbounds provides access to outbounds for a remote service. Outbounds define how requests are sent from this service to the remote service.

type RouterMiddleware

type RouterMiddleware middleware.Router

RouterMiddleware wraps the Router middleware

type StreamOption

type StreamOption encoding.StreamOption

StreamOption defines options that may be passed in at streaming function call sites.

These may be used to add or alter individual stream calls.