micro

package module
v0.23.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2019 License: Apache-2.0 Imports: 15 Imported by: 583

README

Go Micro License GoDoc Travis CI Go Report Card

Go Micro is a framework for micro service 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. You can optionally set gossip using the SWIM protocol for p2p networks or consul for a resilient cloud-native setup.

  • 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.

  • Sync Streaming - 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.

Sponsors

Sixt is an Enterprise Sponsor of Micro

Become a sponsor by backing micro on Patreon

Documentation

Overview

Package micro is a pluggable framework for microservices

Index

Constants

This section is empty.

Variables

View Source 
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 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 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 added in v0.3.0 

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
}

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 {
	Init(...Option)
	Options() Options
	Client() client.Client
	Server() server.Server
	Run() error
	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.

Source Files

View all Source files

Directories

Path Synopsis
api module
handler Module
handler/api Module
handler/event Module
handler/http Module
handler/rpc Module
handler/web Module
internal Module
internal/proto Module
proto Module
resolver Module
resolver/grpc Module
resolver/host Module
resolver/path Module
resolver/vpath Module
router Module
router/registry Module
router/static Module
router/util Module
server Module
server/acme Module
server/acme/autocert Module
server/cors Module
server/http Module
auth module
Package broker is an interface used for asynchronous messaging
 Package broker is an interface used for asynchronous messaging
http
Package http provides a http based message broker
 Package http provides a http based message broker
memory
Package memory provides a memory broker
 Package memory provides a memory broker
cache module
Package client is an interface for an RPC client
 Package client is an interface for an RPC client
mock
Package mock provides a mock client for testing
 Package mock provides a mock client for testing
rpc
Package rpc provides an rpc client
 Package rpc provides an rpc client
cmd
Package cmd is an interface for parsing the command line
 Package cmd is an interface for parsing the command line
dashboard Module
dashboard/config Module
dashboard/handler Module
dashboard/handler/account Module
dashboard/handler/client Module
dashboard/handler/registry Module
dashboard/handler/route Module
dashboard/handler/statistics Module
dashboard/util Module
dashboard/web Module
micro Module
micro/cli Module
micro/cli/call Module
micro/cli/describe Module
micro/cli/generate Module
micro/cli/new Module
micro/cli/run Module
micro/cli/services Module
micro/cli/stream Module
micro/debug Module
micro/debug/trace Module
micro/debug/trace/jaeger Module
micro/generator Module
micro/generator/template Module
protoc-gen-micro Module
protoc-gen-micro/examples Module
protoc-gen-micro/examples/greeter Module
protoc-gen-micro/generator Module
protoc-gen-micro/plugin Module
protoc-gen-micro/plugin/micro Module
Package codec is an interface for encoding messages
 Package codec is an interface for encoding messages
bytes
Package bytes provides a bytes codec which does not encode or decode anything
 Package bytes provides a bytes codec which does not encode or decode anything
grpc
Package grpc provides a grpc codec
 Package grpc provides a grpc codec
json
Package json provides a json codec
 Package json provides a json codec
jsonrpc
Package jsonrpc provides a json-rpc 1.0 codec
 Package jsonrpc provides a json-rpc 1.0 codec
proto
Package proto provides a proto codec
 Package proto provides a proto codec
protorpc
Package proto is a generated protocol buffer package.
 Package proto is a generated protocol buffer package.
text Module
config module
encoder Module
encoder/json Module
loader Module
loader/memory Module
reader Module
reader/json Module
secrets Module
secrets/box Module
secrets/secretbox Module
source Module
source/cli Module
source/env Module
source/file Module
source/flag Module
source/memory Module
debug module
handler Module
log Module
log/memory Module
log/noop Module
profile Module
profile/http Module
profile/pprof Module
proto Module
stats Module
trace Module
Package errors provides a way to return detailed information for an RPC request error.
 Package errors provides a way to return detailed information for an RPC request error.
events module
examples module
broker Module
broker/consumer Module
broker/producer Module
cache Module
cache/handler Module
cache/proto Module
client Module
client/codegen Module
client/dc_filter Module
client/dc_selector Module
client/pub Module
client/selector Module
client/wrapper Module
config Module
config/file Module
config/grpc Module
config/grpc/client Module
config/grpc/srv Module
config/modify Module
config/yaml Module
event Module
event/srv Module
event/srv/proto Module
filter Module
filter/version Module
flags Module
function Module
function/proto Module
gateway Module
gateway/proto Module
gateway/proto/hello Module
getip Module
getip/proto Module
graceful Module
greeter Module
greeter/cli Module
greeter/cli/sidecar Module
greeter/srv Module
greeter/srv/proto Module
greeter/srv/proto/hello Module
heartbeat Module
helloworld Module
helloworld/proto Module
http Module
http/cli Module
http/rpccli Module
http/srv Module
metadata Module
metadata/cli Module
metadata/srv Module
mocking Module
mocking/mock Module
noproto Module
noproto/client Module
pubsub Module
pubsub/cli Module
pubsub/srv Module
pubsub/srv/proto Module
redirect Module
roundrobin Module
secure Module
secure/cli Module
secure/srv Module
secure/srv/proto Module
secure/srv/proto/hello Module
server Module
server/codegen Module
server/handler Module
server/proto Module
server/proto/example Module
server/subscriber Module
server/wrapper Module
service Module
service/proto Module
sharding Module
shutdown Module
stream Module
stream/grpc Module
stream/grpc/client Module
stream/grpc/proto Module
stream/grpc/server Module
stream/rpc Module
stream/rpc/client Module
stream/rpc/server Module
stream/rpc/server/proto Module
waitgroup Module
wrapper Module
wrapper/cli Module
grpc module
http module
logger module
Package metadata is a way of defining message headers
 Package metadata is a way of defining message headers
mock module
mucp module
options module
plugins module
acme Module
acme/certmagic Module
auth Module
auth/jwt Module
auth/jwt/token Module
broker Module
broker/gocloud Module
broker/googlepubsub Module
broker/grpc Module
broker/grpc/proto Module
broker/http Module
broker/kafka Module
broker/memory Module
broker/mqtt Module
broker/nats Module
broker/nsq Module
broker/proxy Module
broker/rabbitmq Module
broker/redis Module
broker/segmentio Module
broker/snssqs Module
broker/sqs Module
broker/stan Module
broker/stomp Module
client Module
client/grpc Module
client/http Module
client/http/test Module
client/mock Module
client/mucp Module
codec Module
codec/bsonrpc Module
codec/json-iterator Module
codec/jsonrpc2 Module
codec/msgpackrpc Module
codec/segmentio Module
config Module
config/encoder Module
config/encoder/cue Module
config/encoder/hcl Module
config/encoder/toml Module
config/encoder/xml Module
config/encoder/yaml Module
config/source Module
config/source/configmap Module
config/source/consul Module
config/source/etcd Module
config/source/grpc Module
config/source/grpc/proto Module
config/source/mucp Module
config/source/mucp/proto Module
config/source/nacos Module
config/source/pkger Module
config/source/runtimevar Module
config/source/url Module
config/source/vault Module
events Module
events/nats Module
events/redis Module
logger Module
logger/apex Module
logger/logrus Module
logger/windowseventlog Module
logger/zap Module
logger/zerolog Module
proxy Module
proxy/http Module
registry Module
registry/cache Module
registry/consul Module
registry/etcd Module
registry/eureka Module
registry/eureka/mock Module
registry/gossip Module
registry/gossip/proto Module
registry/kubernetes Module
registry/kubernetes/client Module
registry/kubernetes/client/api Module
registry/kubernetes/client/mock Module
registry/kubernetes/client/watch Module
registry/mdns Module
registry/memory Module
registry/multi Module
registry/nacos Module
registry/nats Module
registry/proxy Module
registry/zookeeper Module
selector Module
selector/dns Module
selector/label Module
selector/registry Module
selector/shard Module
selector/static Module
server Module
server/grpc Module
server/grpc/proto Module
server/http Module
server/mucp Module
store Module
store/cockroach Module
store/consul Module
store/file Module
store/memcached Module
store/memory Module
store/mysql Module
store/redis Module
sync Module
sync/consul Module
sync/etcd Module
sync/memory Module
transport Module
transport/grpc Module
transport/grpc/proto Module
transport/http Module
transport/memory Module
transport/nats Module
transport/quic Module
transport/rabbitmq Module
transport/tcp Module
transport/utp Module
wrapper Module
wrapper/breaker Module
wrapper/breaker/gobreaker Module
wrapper/breaker/hystrix Module
wrapper/endpoint Module
wrapper/monitoring Module
wrapper/monitoring/prometheus Module
wrapper/monitoring/victoriametrics Module
wrapper/ratelimiter Module
wrapper/ratelimiter/ratelimit Module
wrapper/ratelimiter/uber Module
wrapper/select Module
wrapper/select/roundrobin Module
wrapper/select/shard Module
wrapper/select/version Module
wrapper/service Module
wrapper/trace Module
wrapper/trace/awsxray Module
wrapper/trace/datadog Module
wrapper/trace/opencensus Module
wrapper/trace/opentracing Module
wrapper/validator Module
pool module
Package mdns is a multicast dns registry Package registry is an interface for service discovery
 Package mdns is a multicast dns registry Package registry is an interface for service discovery
consul
gossip
Package Gossip provides a gossip registry based on hashicorp/memberlist
 Package Gossip provides a gossip registry based on hashicorp/memberlist
gossip/proto
Package gossip is a generated protocol buffer package.
 Package gossip is a generated protocol buffer package.
mdns
Package mdns provides a multicast dns registry
 Package mdns provides a multicast dns registry
memory
Package memory provides an in-memory registry
 Package memory provides an in-memory registry
cache Module
rpc module
runtime module
kubernetes Module
local Module
local/build Module
local/build/docker Module
local/build/go Module
local/git Module
local/process Module
local/process/os Module
local/source Module
local/source/git Module
local/source/go Module
Package selector is a way to pick a list of service nodes
 Package selector is a way to pick a list of service nodes
dns
Package dns provides a dns SRV selector
 Package dns provides a dns SRV selector
registry
Package registry uses the go-micro registry for selection
 Package registry uses the go-micro registry for selection
static
Package static provides a static resolver which returns the name/ip passed in without any change
 Package static provides a static resolver which returns the name/ip passed in without any change
Package server is an interface for a micro server
 Package server is an interface for a micro server
debug
debug/proto
Package debug is a generated protocol buffer package.
 Package debug is a generated protocol buffer package.
mock
rpc
Package rpc provides an rpc server
 Package rpc provides an rpc server
proto Module
services module
address Module
answer Module
cache Module
crypto Module
currency Module
db Module
email Module
emoji Module
evchargers Module
file Module
forex Module
function Module
geocoding Module
gifs Module
google Module
helloworld Module
holidays Module
id Module
image Module
ip Module
location Module
notes Module
otp Module
postcode Module
prayer Module
qr Module
quran Module
routing Module
rss Module
sentiment Module
sms Module
stock Module
stream Module
sunnah Module
thumbnail Module
time Module
twitter Module
url Module
user Module
vehicle Module
weather Module
youtube Module
store module
sync module
Package transport is an interface for synchronous communication
 Package transport is an interface for synchronous communication
http
Package http returns a http2 transport using net/http
 Package http returns a http2 transport using net/http
memory
Package memory is an in-memory transport
 Package memory is an in-memory transport
util module
addr Module
backoff Module
buf Module
ctx Module
file Module
file/proto Module
grpc Module
http Module
io Module
jitter Module
kubernetes Module
kubernetes/api Module
kubernetes/client Module
log Module
mdns Module
net Module
pki Module
pool Module
qson Module
registry Module
ring Module
signal Module
socket Module
stream Module
sync Module
test Module
tls Module
wrapper Module
web module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.