README
¶
Go Micro 
Go Micro is a framework for distributed systems development.
Why this project
Since go-micro born that APIs change fast and associative projects has been removed. this project keep update with all dependencies up-to-date and made break changes without new major version. fork from asim/go-micro major version 2.
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.
Features
Go Micro abstracts away the details of distributed systems. Here are the main features.
-
Authentication - Auth is built in as a first class citizen. Authentication and authorization enable secure zero trust networking by providing every service an identity and certificates. This additionally includes rule based access control.
-
Dynamic Config - Load and hot reload dynamic config from anywhere. The config interface provides a way to load application level config from any source such as env vars, file, etcd. You can merge the sources and even define fallbacks.
-
Data Storage - A simple data store interface to read, write and delete records. It includes support for memory, file and CockroachDB by default. State and persistence becomes a core requirement beyond prototyping and Micro looks to build that into the framework.
-
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.
-
gRPC Transport - gRPC 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.
-
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 system is a HTTP event message broker.
-
Synchronization - Distributed systems are often built in an eventually consistent manner. Support for distributed locking and leadership are built in as a Sync interface. When using an eventually consistent database or scheduling use the Sync interface.
-
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.
Getting Started
To make use of Go Micro
import "c-z.dev/go-micro"
// create a new service
service := micro.NewService(
micro.Name("helloworld"),
)
// initialise flags
service.Init()
// start the service
service.Run()
License
Go Micro is Apache 2.0 licensed.
Documentation
¶
Overview ¶
Package micro is a pluggable framework for microservices
Index ¶
- Variables
- func NewContext(ctx context.Context, s Service) context.Context
- func RegisterHandler(s server.Server, h interface{}, opts ...server.HandlerOption) error
- func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error
- type Event
- type Function
- type Option
- func Action(a func(*cli.Context) error) Option
- func Address(addr string) Option
- func AfterStart(fn func() error) Option
- func AfterStop(fn func() error) Option
- func Auth(a auth.Auth) Option
- func BeforeStart(fn func() error) Option
- func BeforeStop(fn func() error) Option
- func Broker(b broker.Broker) Option
- func Client(c client.Client) Option
- func Cmd(c cmd.Cmd) Option
- func Config(c config.Config) Option
- func Context(ctx context.Context) Option
- func Flags(flags ...cli.Flag) Option
- func HandleSignal(b bool) Option
- func Metadata(md map[string]string) Option
- func Name(n string) Option
- func Profile(p profile.Profile) Option
- func RegisterInterval(t time.Duration) Option
- func RegisterTTL(t time.Duration) Option
- func Registry(r registry.Registry) Option
- func Runtime(r runtime.Runtime) Option
- func Selector(s selector.Selector) Option
- func Server(s server.Server) Option
- func Store(s store.Store) Option
- func Tracer(t trace.Tracer) Option
- func Transport(t transport.Transport) Option
- func Version(v string) Option
- func WrapCall(w ...client.CallWrapper) Option
- func WrapClient(w ...client.Wrapper) Option
- func WrapHandler(w ...server.HandlerWrapper) Option
- func WrapSubscriber(w ...server.SubscriberWrapper) Option
- type Options
- type Publisher
- type Service
Constants ¶
This section is empty.
Variables ¶
var HeaderPrefix = "Micro-"
Functions ¶
func NewContext ¶
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 Event ¶
type Event interface {
// Publish publishes a message to the event topic
Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error
}
Event is used to publish messages to a topic
func NewPublisher
deprecated
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 ¶
NewFunction returns a new Function for a one time executing Service
type Option ¶
type Option func(*Options)
func BeforeStart ¶
BeforeStart run funcs before service starts
func Context ¶
Context specifies a context for the service. Can be used to signal shutdown of the service and for extra option values.
func HandleSignal ¶
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 RegisterInterval ¶
RegisterInterval specifies the interval on which to re-register
func RegisterTTL ¶
RegisterTTL specifies the TTL to use when registering the service
func WrapCall ¶
func WrapCall(w ...client.CallWrapper) Option
WrapCall is a convenience method for wrapping a Client CallFunc
func WrapClient ¶
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 {
Auth auth.Auth
Broker broker.Broker
Cmd cmd.Cmd
Config config.Config
Client client.Client
Server server.Server
Store store.Store
Registry registry.Registry
Runtime runtime.Runtime
Transport transport.Transport
Profile profile.Profile
// 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
}
Options for micro service
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 ¶
FromContext retrieves a Service from the Context.
func NewService ¶
NewService creates and returns a new Service based on the packages within.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agent provides an interface for building robots
|
Package agent provides an interface for building robots |
|
command
Package command is an interface for defining bot commands
|
Package command is an interface for defining bot commands |
|
input
Package input is an interface for bot inputs
|
Package input is an interface for bot inputs |
|
handler
Package handler provides http handlers
|
Package handler provides http handlers |
|
handler/api
Package api provides an http-rpc handler which provides the entire http request over rpc
|
Package api provides an http-rpc handler which provides the entire http request over rpc |
|
handler/event
Package event provides a handler which publishes an event
|
Package event provides a handler which publishes an event |
|
handler/http
Package http is a http reverse proxy handler
|
Package http is a http reverse proxy handler |
|
handler/rpc
Package rpc is a go-micro rpc handler.
|
Package rpc is a go-micro rpc handler. |
|
handler/web
Package web contains the web handler including websocket support
|
Package web contains the web handler including websocket support |
|
resolver
Package resolver resolves a http request to an endpoint
|
Package resolver resolves a http request to an endpoint |
|
resolver/grpc
Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service
|
Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service |
|
resolver/host
Package host resolves using http host
|
Package host resolves using http host |
|
resolver/path
Package path resolves using http path
|
Package path resolves using http path |
|
resolver/vpath
Package vpath resolves using http path and recognised versioned urls
|
Package vpath resolves using http path and recognised versioned urls |
|
router
Package router provides api service routing
|
Package router provides api service routing |
|
router/registry
Package registry provides a dynamic api service router
|
Package registry provides a dynamic api service router |
|
server
Package server provides an API gateway server which handles inbound requests
|
Package server provides an API gateway server which handles inbound requests |
|
server/acme
Package acme abstracts away various ACME libraries
|
Package acme abstracts away various ACME libraries |
|
server/http
Package http provides a http server with features; acme, cors, etc
|
Package http provides a http server with features; acme, cors, etc |
|
Package auth provides authentication and authorization capability
|
Package auth provides authentication and authorization capability |
|
provider
Package provider is an external auth provider e.g oauth
|
Package provider is an external auth provider e.g oauth |
|
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 |
|
service
Package service provides the broker service client
|
Package service provides the broker service client |
|
Package client is an interface for an RPC client
|
Package client is an interface for an RPC client |
|
grpc
Package grpc provides a gRPC client
|
Package grpc provides a gRPC client |
|
mucp
Package mucp provides an mucp client
|
Package mucp provides an mucp client |
|
selector
Package selector is a way to pick a list of service nodes
|
Package selector is a way to pick a list of service nodes |
|
selector/dns
Package dns provides a dns SRV selector
|
Package dns provides a dns SRV selector |
|
selector/registry
Package registry uses the go-micro registry for selection
|
Package registry uses the go-micro registry for selection |
|
selector/router
Package router is a network/router selector
|
Package router is a network/router selector |
|
selector/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 |
|
cmd
|
|
|
protoc-gen-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 protorpc provides a net/rpc proto-rpc codec.
|
Package protorpc provides a net/rpc proto-rpc codec. |
|
text
Package text reads any text/* content-type
|
Package text reads any text/* content-type |
|
Package config is an interface for dynamic configuration.
|
Package config is an interface for dynamic configuration. |
|
cmd
Package cmd is an interface for parsing the command line
|
Package cmd is an interface for parsing the command line |
|
encoder
Package encoder handles source encoding formats
|
Package encoder handles source encoding formats |
|
loader
package loader manages loading from multiple sources
|
package loader manages loading from multiple sources |
|
reader
Package reader parses change sets and provides config values
|
Package reader parses change sets and provides config values |
|
secrets
Package secrets is an interface for encrypting and decrypting secrets
|
Package secrets is an interface for encrypting and decrypting secrets |
|
secrets/box
Package box is an asymmetric implementation of config/secrets using nacl/box
|
Package box is an asymmetric implementation of config/secrets using nacl/box |
|
secrets/secretbox
Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification
|
Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification |
|
source
Package source is the interface for sources
|
Package source is the interface for sources |
|
source/file
Package file is a file source.
|
Package file is a file source. |
|
source/memory
Package memory is a memory source
|
Package memory is a memory source |
|
Package debug provides micro debug packages
|
Package debug provides micro debug packages |
|
log
Package log provides debug logging
|
Package log provides debug logging |
|
log/memory
Package memory provides an in memory log buffer
|
Package memory provides an in memory log buffer |
|
profile
Package profile is for profilers
|
Package profile is for profilers |
|
profile/http
Package http enables the http profiler
|
Package http enables the http profiler |
|
profile/pprof
Package pprof provides a pprof profiler
|
Package pprof provides a pprof profiler |
|
service
Package service provides the service log
|
Package service provides the service log |
|
service/handler
Package handler implements service debug handler embedded in go-micro services
|
Package handler implements service debug handler embedded in go-micro services |
|
stats
Package stats provides runtime stats
|
Package stats provides runtime stats |
|
trace
Package trace provides an interface for distributed tracing
|
Package trace provides an interface for distributed tracing |
|
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. |
|
extension
|
|
|
Package logger provides a log interface
|
Package logger provides a log interface |
|
Package metadata is a way of defining message headers
|
Package metadata is a way of defining message headers |
|
Package plugin provides the ability to load plugins
|
Package plugin provides the ability to load plugins |
|
Package proxy is a transparent proxy built on the go-micro/server
|
Package proxy is a transparent proxy built on the go-micro/server |
|
grpc
Package grpc transparently forwards the grpc protocol using a go-micro client.
|
Package grpc transparently forwards the grpc protocol using a go-micro client. |
|
http
Package http provides a micro rpc to http proxy
|
Package http provides a micro rpc to http proxy |
|
mucp
Package mucp transparently forwards the incoming request using a go-micro client.
|
Package mucp transparently forwards the incoming request using a go-micro client. |
|
Package mdns is a multicast dns registry
|
Package mdns is a multicast dns registry |
|
cache
Package cache provides a registry cache
|
Package cache provides a registry cache |
|
etcd
Package etcd provides an etcd service registry
|
Package etcd provides an etcd service registry |
|
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 |
|
service
Package service uses the registry service
|
Package service uses the registry service |
|
Package router provides a network routing control plane
|
Package router provides a network routing control plane |
|
Package runtime is a service runtime manager
|
Package runtime is a service runtime manager |
|
Package server is an interface for a micro server
|
Package server is an interface for a micro server |
|
grpc
Package grpc provides a grpc server
|
Package grpc provides a grpc server |
|
mucp
Package mucp provides an mucp server
|
Package mucp provides an mucp server |
|
Package service encapsulates the client, server and other interfaces to provide a complete micro service.
|
Package service encapsulates the client, server and other interfaces to provide a complete micro service. |
|
mucp
Package mucp initialises a mucp service
|
Package mucp initialises a mucp service |
|
Package store is an interface for distributed data storage.
|
Package store is an interface for distributed data storage. |
|
cache
Package cache implements a faulting style read cache on top of multiple micro stores
|
Package cache implements a faulting style read cache on top of multiple micro stores |
|
memory
Package memory is an in-memory store store
|
Package memory is an in-memory store store |
|
service
Package service implements the store service interface
|
Package service implements the store service interface |
|
Package sync is an interface for distributed synchronization
|
Package sync is an interface for distributed synchronization |
|
etcd
Package etcd is an etcd implementation of lock
|
Package etcd is an etcd implementation of lock |
|
memory
Package memory provides a sync.Mutex implementation of the lock for local use
|
Package memory provides a sync.Mutex implementation of the lock for local use |
|
tests
|
|
|
Package transport is an interface for synchronous connection based communication
|
Package transport is an interface for synchronous connection based communication |
|
grpc
Package grpc provides a grpc transport
|
Package grpc provides a grpc transport |
|
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
|
|
|
backoff
Package backoff provides backoff functionality
|
Package backoff provides backoff functionality |
|
io
Package io is for io management
|
Package io is for io management |
|
jitter
Package jitter provides a random jitter
|
Package jitter provides a random jitter |
|
mux
Package mux provides proxy muxing
|
Package mux provides proxy muxing |
|
pki
Package pki provides PKI all the PKI functions necessary to run micro over an untrusted network including a CA
|
Package pki provides PKI all the PKI functions necessary to run micro over an untrusted network including a CA |
|
pool
Package pool is a connection pool
|
Package pool is a connection pool |
|
proto
Package proto contains utility functions for working with protobufs
|
Package proto contains utility functions for working with protobufs |
|
qson
Package qson implmenets decoding of URL query params into JSON and Go values (using JSON struct tags).
|
Package qson implmenets decoding of URL query params into JSON and Go values (using JSON struct tags). |
|
ring
Package ring provides a simple ring buffer for storing local data
|
Package ring provides a simple ring buffer for storing local data |
|
socket
Package socket provides a pseudo socket
|
Package socket provides a pseudo socket |
|
stream
Package stream encapsulates streams within streams
|
Package stream encapsulates streams within streams |
|
sync
Package syncs will sync multiple stores
|
Package syncs will sync multiple stores |
|
Package web provides web based micro services
|
Package web provides web based micro services |