micro

package module
v3.1.8 Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2021 License: Apache-2.0 Imports: 20 Imported by: 0

README

Micro License Doc Status Lint Slack

Micro is a standard library for microservices.

Overview

Micro provides the core requirements for distributed systems development including RPC and Event driven communication.

Features

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.

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

  • Transport - gRPC or http 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.

  • 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 - Micro makes use of Go interfaces for each system abstraction. Because of this these interfaces are pluggable and allows Micro to be runtime agnostic.

Getting Started

To be created.

License

Micro is Apache 2.0 licensed.

Documentation

Overview

Package micro is a pluggable framework for microservices

Index

Constants

This section is empty.

Variables

View Source 
var (
	// HeaderPrefix for all headers passed
	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 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 NewEvent 

func NewEvent(topic string, c client.Client) Event

NewEvent creates a new event publisher

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)

Option func

func Address 

func Address(addr string) Option

Address sets the address of the server

func AfterStart 

func AfterStart(fn func(context.Context) error) Option

AfterStart run funcs after service starts

func AfterStop 

func AfterStop(fn func(context.Context) error) Option

AfterStop run funcs after service stops

func Auth 

func Auth(a auth.Auth) Option

Auth sets the auth for the service

func BeforeStart 

func BeforeStart(fn func(context.Context) error) Option

BeforeStart run funcs before service starts

func BeforeStop 

func BeforeStop(fn func(context.Context) error) Option

BeforeStop run funcs before service stops

func Broker 

func Broker(b broker.Broker) Option

Broker to be used for service

func Client 

func Client(c client.Client) Option

Client to be used for service

func Configs added in v3.1.0 

func Configs(c ...config.Config) Option

Configs sets the configs for the service

func Context 

func Context(ctx context.Context) Option

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

func Logger 

func Logger(l logger.Logger) Option

Logger set the logger to use

func Metadata 

func Metadata(md metadata.Metadata) Option

Metadata associated with the service

func Meter added in v3.1.6 

func Meter(m meter.Meter) Option

Meter set the meter to use

func Name 

func Name(n string) Option

Name of the service

func Profile 

func Profile(p profile.Profile) Option

Profile to be used for debug profile

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 Router 

func Router(r router.Router) Option

Router sets the router

func Runtime 

func Runtime(r runtime.Runtime) Option

Runtime sets the runtime

func Selector 

func Selector(s selector.Selector) Option

Selector sets the selector for the service client

func Server 

func Server(s server.Server) Option

Server to be used for service

func Store 

func Store(s store.Store) Option

Store sets the store to use

func Tracer 

func Tracer(t tracer.Tracer) Option

Tracer sets the tracer for the service

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 {
	Auth     auth.Auth
	Broker   broker.Broker
	Logger   logger.Logger
	Meter    meter.Meter
	Configs  []config.Config
	Client   client.Client
	Server   server.Server
	Store    store.Store
	Registry registry.Registry
	Tracer   tracer.Tracer
	Router   router.Router
	Runtime  runtime.Runtime
	Profile  profile.Profile

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

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

Options for micro service

func NewOptions 

func NewOptions(opts ...Option) Options

NewOptions returns new Options filled with defaults and overrided by provided opts

type Service 

type Service interface {
	// The service name
	Name() string
	// Init initialises options
	Init(...Option) error
	// 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
	// Broker is for broker usage
	Broker() broker.Broker
	// Run the service
	Run() error
	// The service implementation
	String() string
}

Service is an interface that wraps the lower level libraries within 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
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/web
Package web contains the web handler including websocket support
 Package web contains the web handler including websocket support
internal/proto
proto
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/subdomain
Package subdomain is a resolver which uses the subdomain to determine the domain to route to.
 Package subdomain is a resolver which uses the subdomain to determine the domain to route to.
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
Package auth provides authentication and authorization capability
 Package auth provides authentication and authorization capability
Package broker is an interface used for asynchronous messaging
 Package broker is an interface used for asynchronous messaging
Package build is for building source into a package
 Package build is for building source into a package
Package client is an interface for an RPC client
 Package client is an interface for an RPC client
Package codec is an interface for encoding messages
 Package codec is an interface for encoding messages
Package config is an interface for dynamic configuration.
 Package config is an interface for dynamic configuration.
Package debug provides interfaces for service debugging
 Package debug provides interfaces for service debugging
log
Package log provides debug logging
 Package log provides debug logging
log/kubernetes
Package kubernetes is a logger implementing (github.com/unistack-org/micro/v3/debug/log).Log
 Package kubernetes is a logger implementing (github.com/unistack-org/micro/v3/debug/log).Log
log/memory
Package memory provides an in memory log buffer
 Package memory provides an in memory log buffer
log/noop
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 which writes output to /tmp/[name].{cpu,mem}.pprof
 Package pprof provides a pprof profiler which writes output to /tmp/[name].{cpu,mem}.pprof
stats
Package stats provides runtime stats
 Package stats provides runtime stats
stats/memory
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.
Package events contains interfaces for managing events within distributed systems
 Package events contains interfaces for managing events within distributed systems
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 metadata is a way of defining message headers Package metadata is a way of defining message headers
Package meter is for instrumentation
 Package meter is for instrumentation
Package model is an interface for data modelling Package model is an interface for data modelling
 Package model is an interface for data modelling Package model is an interface for data modelling
Package network is for creating internetworks
 Package network is for creating internetworks
transport
Package transport is an interface for synchronous connection based communication
 Package transport is an interface for synchronous connection based communication
tunnel
Package tunnel provides gre network tunnelling
 Package tunnel provides gre network tunnelling
tunnel/broker
Package broker is a tunnel broker
 Package broker is a tunnel broker
tunnel/transport
Package transport provides a tunnel transport
 Package transport provides a tunnel transport
Package proxy is a transparent proxy built on the micro/server Package proxy is a transparent proxy built on the micro/server
 Package proxy is a transparent proxy built on the micro/server Package proxy is a transparent proxy built on the micro/server
Package registry is an interface for service discovery
 Package registry is an interface for service discovery
Package resolver resolves network names to addresses
 Package resolver resolves network names to addresses
dns
Package dns resolves names to dns records
 Package dns resolves names to dns records
dnssrv
Package dns srv resolves names to dns srv records
 Package dns srv resolves names to dns srv records
http
Package http resolves names to network addresses using a http request
 Package http resolves names to network addresses using a http request
noop
Package noop is a noop resolver
 Package noop is a noop resolver
registry
Package registry resolves names using the micro registry
 Package registry resolves names using the micro registry
static
Package static is a static resolver
 Package static is a static resolver
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 selector is for node selection and load balancing
 Package selector is for node selection and load balancing
random
roundrobin
Package server is an interface for a micro server
 Package server is an interface for a micro server
Package store is an interface for distributed data storage.
 Package store is an interface for distributed data storage.
Package sync is an interface for distributed synchronization
 Package sync is an interface for distributed synchronization
Package tracer provides an interface for distributed tracing Package tracer provides an interface for distributed tracing
 Package tracer provides an interface for distributed tracing Package tracer provides an interface for distributed tracing
util
addr
auth
backoff
Package backoff provides backoff functionality
 Package backoff provides backoff functionality
buf
ctx
http
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
kubernetes/api
kubernetes/client
Package client provides an implementation of a restricted subset of kubernetes API client
 Package client provides an implementation of a restricted subset of kubernetes API client
mdns
net
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
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).
reflect
registry
ring
Package ring provides a simple ring buffer for storing local data
 Package ring provides a simple ring buffer for storing local data
router
scope
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
token
token/basic
token/jwt

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.