README

Go Micro License GoDoc Travis CI Go Report Card

Go Micro is a framework for microservice development.

Overview

Go Micro provides the core requirements for distributed systems development including RPC and Event driven communication. The micro philosophy is sane defaults with a pluggable architecture. We provide defaults to get you started quickly but everything can be easily swapped out.

Plugins are available at github.com/micro/go-plugins.

Follow us on Twitter or join the Slack community.

Features

Go Micro abstracts away the details of distributed systems. Here are the main features.

  • Service Discovery - Automatic service registration and name resolution. Service discovery is at the core of micro service development. When service A needs to speak to service B it needs the location of that service. The default discovery mechanism is multicast DNS (mdns), a zeroconf system.

  • Load Balancing - Client side load balancing built on service discovery. Once we have the addresses of any number of instances of a service we now need a way to decide which node to route to. We use random hashed load balancing to provide even distribution across the services and retry a different node if there's a problem.

  • Message Encoding - Dynamic message encoding based on content-type. The client and server will use codecs along with content-type to seamlessly encode and decode Go types for you. Any variety of messages could be encoded and sent from different clients. The client and server handle this by default. This includes protobuf and json by default.

  • Request/Response - RPC based request/response with support for bidirectional streaming. We provide an abstraction for synchronous communication. A request made to a service will be automatically resolved, load balanced, dialled and streamed. The default transport is http/1.1 or http2 when tls is enabled.

  • Async Messaging - PubSub is built in as a first class citizen for asynchronous communication and event driven architectures. Event notifications are a core pattern in micro service development. The default messaging is point-to-point http/1.1 or http2 when tls is enabled.

  • Pluggable Interfaces - Go Micro makes use of Go interfaces for each distributed system abstraction. Because of this these interfaces are pluggable and allows Go Micro to be runtime agnostic. You can plugin any underlying technology. Find plugins in github.com/micro/go-plugins.

Getting Started

See the docs for detailed information on the architecture, installation and use of go-micro.

Expand ▾ Collapse ▴

Documentation

Overview

Package micro is a pluggable framework for microservices

Index

Constants

This section is empty.

Variables

var (
	HeaderPrefix = "Micro-"
)

Functions

func NewContext

func NewContext(ctx context.Context, s Service) context.Context

NewContext returns a new Context with the Service embedded within it.

func RegisterHandler

func RegisterHandler(s server.Server, h interface{}, opts ...server.HandlerOption) error

RegisterHandler is syntactic sugar for registering a handler

func RegisterSubscriber

func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error

RegisterSubscriber is syntactic sugar for registering a subscriber

Types

type Function

type Function interface {
	// Inherits Service interface
	Service
	// Done signals to complete execution
	Done() error
	// Handle registers an RPC handler
	Handle(v interface{}) error
	// Subscribe registers a subscriber
	Subscribe(topic string, v interface{}) error
}

Function is a one time executing Service

func NewFunction

func NewFunction(opts ...Option) Function

NewFunction returns a new Function for a one time executing Service

type Option

type Option func(*Options)

func Action

func Action(a func(*cli.Context)) Option

func Address

func Address(addr string) Option

Address sets the address of the server

func AfterStart

func AfterStart(fn func() error) Option

func AfterStop

func AfterStop(fn func() error) Option

func BeforeStart

func BeforeStart(fn func() error) Option

func BeforeStop

func BeforeStop(fn func() error) Option

func Broker

func Broker(b broker.Broker) Option

func Client

func Client(c client.Client) Option

func Cmd

func Cmd(c cmd.Cmd) Option

func Context

func Context(ctx context.Context) Option

Context specifies a context for the service. Can be used to signal shutdown of the service. Can be used for extra option values.

func Flags

func Flags(flags ...cli.Flag) Option

func HandleSignal

func HandleSignal(b bool) Option

HandleSignal toggles automatic installation of the signal handler that traps TERM, INT, and QUIT. Users of this feature to disable the signal handler, should control liveness of the service through the context.

func Metadata

func Metadata(md map[string]string) Option

Metadata associated with the service

func Name

func Name(n string) Option

Name of the service

func RegisterInterval

func RegisterInterval(t time.Duration) Option

RegisterInterval specifies the interval on which to re-register

func RegisterTTL

func RegisterTTL(t time.Duration) Option

RegisterTTL specifies the TTL to use when registering the service

func Registry

func Registry(r registry.Registry) Option

Registry sets the registry for the service and the underlying components

func Selector

func Selector(s selector.Selector) Option

Selector sets the selector for the service client

func Server

func Server(s server.Server) Option

func Transport

func Transport(t transport.Transport) Option

Transport sets the transport for the service and the underlying components

func Version

func Version(v string) Option

Version of the service

func WrapCall

func WrapCall(w ...client.CallWrapper) Option

WrapCall is a convenience method for wrapping a Client CallFunc

func WrapClient

func WrapClient(w ...client.Wrapper) Option

WrapClient is a convenience method for wrapping a Client with some middleware component. A list of wrappers can be provided. Wrappers are applied in reverse order so the last is executed first.

func WrapHandler

func WrapHandler(w ...server.HandlerWrapper) Option

WrapHandler adds a handler Wrapper to a list of options passed into the server

func WrapSubscriber

func WrapSubscriber(w ...server.SubscriberWrapper) Option

WrapSubscriber adds a subscriber Wrapper to a list of options passed into the server

type Options

type Options struct {
	Broker    broker.Broker
	Cmd       cmd.Cmd
	Client    client.Client
	Server    server.Server
	Registry  registry.Registry
	Transport transport.Transport

	// Before and After funcs
	BeforeStart []func() error
	BeforeStop  []func() error
	AfterStart  []func() error
	AfterStop   []func() error

	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context

	Signal bool
}

type Publisher

type Publisher interface {
	Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error
}

Publisher is syntactic sugar for publishing

func NewPublisher

func NewPublisher(topic string, c client.Client) Publisher

NewPublisher returns a new Publisher

type Service

type Service interface {
	// The service name
	Name() string
	// Init initialises options
	Init(...Option)
	// Options returns the current options
	Options() Options
	// Client is used to call services
	Client() client.Client
	// Server is for handling requests and events
	Server() server.Server
	// Run the service
	Run() error
	// The service implementation
	String() string
}

Service is an interface that wraps the lower level libraries within go-micro. Its a convenience method for building and initialising services.

func FromContext

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

FromContext retrieves a Service from the Context.

func NewService

func NewService(opts ...Option) Service

NewService creates and returns a new Service based on the packages within.

Directories

Path Synopsis
agent Package agent provides an interface for building robots
agent/command Package command is an interface for defining bot commands
agent/input Package input is an interface for bot inputs
agent/input/discord
agent/input/slack
agent/input/telegram
agent/proto
api
api/handler Package handler provides http handlers
api/handler/api Package api provides an http-rpc handler which provides the entire http request over rpc
api/handler/broker Package broker provides a go-micro/broker handler
api/handler/cloudevents Package cloudevents provides a cloudevents handler publishing the event using the go-micro/client
api/handler/event Package event provides a handler which publishes an event
api/handler/file Package file serves file relative to the current directory
api/handler/http Package http is a http reverse proxy handler
api/handler/registry Package registry is a go-micro/registry handler
api/handler/rpc Package rpc is a go-micro rpc handler.
api/handler/udp Package udp reads and write from a udp connection
api/handler/unix Package unix reads from a unix socket expecting it to be in /tmp/path
api/handler/web Package web contains the web handler including websocket support
api/internal/proto
api/proto
api/resolver Package resolver resolves a http request to an endpoint
api/resolver/grpc Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service
api/resolver/host Package host resolves using http host
api/resolver/micro Package micro provides a micro rpc resolver which prefixes a namespace
api/resolver/path Package path resolves using http path
api/resolver/vpath Package vpath resolves using http path and recognised versioned urls
api/router Package router provides api service routing
api/router/registry Package registry provides a dynamic api service router
api/server Package server provides an API gateway server which handles inbound requests
api/server/acme Package acme abstracts away various ACME libraries
api/server/acme/autocert Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config.
api/server/acme/certmagic Package certmagic is the ACME provider from github.com/mholt/certmagic
api/server/http Package http provides a http server with features; acme, cors, etc
broker Package broker is an interface used for asynchronous messaging
broker/http Package http provides a http based message broker
broker/memory Package memory provides a memory broker
broker/nats Package nats provides a NATS broker
broker/service Package service provides the broker service client
broker/service/handler
broker/service/proto
client Package client is an interface for an RPC client
client/grpc Package grpc provides a gRPC client Package grpc provides a gRPC options
client/mock Package mock provides a mock client for testing
client/mucp Package mucp provides an mucp client
client/pool Package pool is a connection pool
client/proto
client/selector Package selector is a way to pick a list of service nodes
client/selector/dns Package dns provides a dns SRV selector
client/selector/registry Package registry uses the go-micro registry for selection
client/selector/router Package router is a network/router selector
client/selector/static Package static provides a static resolver which returns the name/ip passed in without any change
codec Package codec is an interface for encoding messages
codec/bytes Package bytes provides a bytes codec which does not encode or decode anything
codec/grpc Package grpc provides a grpc codec
codec/json Package json provides a json codec
codec/jsonrpc Package jsonrpc provides a json-rpc 1.0 codec
codec/proto Package proto provides a proto codec
codec/protorpc Package proto is a generated protocol buffer package.
codec/text Package text reads any text/* content-type
config Package config is an interface for dynamic configuration.
config/cmd Package cmd is an interface for parsing the command line
config/encoder Package encoder handles source encoding formats
config/encoder/hcl
config/encoder/json
config/encoder/toml
config/encoder/xml
config/encoder/yaml
config/loader package loader manages loading from multiple sources
config/loader/memory
config/options Package options provides a way to initialise options
config/reader Package reader parses change sets and provides config values
config/reader/json
config/source Package source is the interface for sources
config/source/cli
config/source/env
config/source/etcd
config/source/file Package file is a file source.
config/source/flag
config/source/memory Package memory is a memory source
debug Package debug provides micro debug packages
debug/buffer Package buffer provides a simple ring buffer for storing local data
debug/log Package log provides debug logging
debug/profile Package profile is for profilers
debug/profile/pprof Package pprof provides a pprof profiler
debug/service
debug/service/handler Pacjage handler implements service debug handler
debug/service/proto
debug/stats Package stats provides runtime stats
errors Package errors provides a way to return detailed information for an RPC request error.
metadata Package metadata is a way of defining message headers
monitor Package monitor monitors service health
network Package network is for creating internetworks
network/proto
network/resolver Package resolver resolves network names to addresses
network/resolver/dns Package dns resolves names to dns records
network/resolver/dnssrv Package dns srv resolves names to dns srv records
network/resolver/http Package http resolves names to network addresses using a http request
network/resolver/registry Package registry resolves names using the go-micro registry
network/resolver/static Package static is a static resolver
network/service/handler Package handler implements network RPC handler
plugin Package plugin provides the ability to load plugins Package plugin provides the ability to load plugins
proxy Package proxy is a transparent proxy built on the go-micro/server
proxy/grpc Package grpc transparently forwards the grpc protocol using a go-micro client.
proxy/http Package http provides a micro rpc to http proxy
proxy/mucp Package mucp transparently forwards the incoming request using a go-micro client.
registry Package mdns is a multicast dns registry Package registry is an interface for service discovery
registry/cache Package cache provides a registry cache
registry/etcd Package etcd provides an etcd service registry
registry/mdns Package mdns provides a multicast dns registry
registry/memory Package memory provides an in-memory registry
registry/service Package service uses the registry service
registry/service/handler
registry/service/proto
router Package router provides a network routing control plane
router/handler
router/proto
router/service
runtime Package runtime is a service runtime manager
runtime/build Package build builds a micro runtime package
runtime/build/docker Package docker builds docker images
runtime/build/go Package golang is a go package manager
runtime/kubernetes Package kubernetes implements kubernetes micro runtime
runtime/kubernetes/client Package client provides an implementation of a restricted subset of kubernetes API client
runtime/kubernetes/client/api
runtime/process Package process executes a binary
runtime/process/os Package os runs processes locally Package os runs processes locally
runtime/service
runtime/service/handler
runtime/service/proto
runtime/source Package source retrieves source code
runtime/source/git Package git provides a git source
runtime/source/go Package golang is a source for Go
server Package server is an interface for a micro server
server/grpc Package grpc provides a grpc server
server/grpc/proto
server/mock
server/mucp Package mucp provides an mucp server
server/proto
service Package service encapsulates the client, server and other interfaces to provide a complete micro service.
service/grpc
service/grpc/proto
service/mucp Package mucp initialises a mucp service
store Package store is an interface for distribute data storage.
store/cloudflare Package cloudflare is a store implementation backed by cloudflare workers kv Note that the cloudflare workers KV API is eventually consistent.
store/etcd Package etcd is an etcd v3 implementation of kv
store/memory Package memory is a in-memory store store
store/mock
store/postgresql Package postgresql implements a micro Store backed by sql
store/service Package service implements the store service interface
store/service/handler
store/service/proto
sync Package sync is a distributed synchronization framework
sync/event Package event provides a distributed log interface
sync/leader Package leader provides leader election
sync/leader/etcd
sync/lock Package lock provides distributed locking
sync/lock/etcd Package etcd is an etcd implementation of lock
sync/lock/http Package http adds a http lock implementation
sync/lock/http/server Package server implements the sync http server
sync/lock/memory Package memory provides a sync.Mutex implementation of the lock for local use
sync/task Package task provides an interface for distributed jobs
sync/task/broker Package broker provides a distributed task manager built on the micro broker
sync/task/local Package local provides a local task runner
sync/time Package time provides clock synchronization
sync/time/local Package local provides a local clock
sync/time/ntp Package ntp provides ntp synchronized time
transport Package transport is an interface for synchronous connection based communication
transport/grpc Package grpc provides a grpc transport
transport/grpc/proto
transport/http Package http returns a http2 transport using net/http
transport/memory Package memory is an in-memory transport
transport/quic Package quic provides a QUIC based transport
tunnel Package tunnel provides gre network tunnelling
tunnel/broker Package broker is a tunnel broker
tunnel/transport Package transport provides a tunnel transport
util/addr
util/backoff Package backoff provides backoff functionality
util/buf
util/ctx
util/file
util/grpc
util/http
util/io Package io is for io management
util/log Package log is a global internal logger
util/mux Package mux provides proxy muxing
util/net
util/socket Package socket provides a pseudo socket
util/test
util/tls
util/wrapper
web Package web provides web based micro services