micro

package module
v4.0.0-...-699247e Latest Latest
Warning

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

Go to latest
Published: Feb 27, 2023 License: Apache-2.0 Imports: 23 Imported by: 0

README

Go Micro License Go.Dev reference Go Report Card Discord

Go Micro is a framework for distributed systems development.

‼️ We are working on go-micro v5 and would love to hear what you'd like to see in it, leave your thoughts in this form

Overview

Go Micro provides the core requirements for distributed systems development including RPC and Event driven communication. The Go 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.

  • RPC Client/Server - 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.

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

  • Event Streaming - PubSub is great for async notifications but for more advanced use cases event streaming is preferred. Offering persistent storage, consuming from offsets and acking. Go Micro includes support for NATS Jetstream and Redis streams.

  • 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 "github.com/justcy/go-micro/v4"

// create a new service
service := micro.NewService(
    micro.Name("helloworld"),
)

// initialise flags
service.Init()

// start the service
service.Run()

See the examples for detailed information on usage.

Toolkit

See github.com/go-micro for tooling.

Changelog

See CHANGELOG.md for release history.

License

Go Micro is Apache 2.0 licensed.

Documentation

Overview

Package micro is a pluggable framework for microservices

Index

Constants

This section is empty.

Variables

This section is empty.

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 Option

type Option func(*Options)

func Action

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

Action can be used to parse user provided cli options.

func AddListenOption

func AddListenOption(option server.Option) Option

Add opt to server option.

func Address

func Address(addr string) Option

Address sets the address of the server.

func AfterStart

func AfterStart(fn func() error) Option

AfterStart run funcs after service starts.

func AfterStop

func AfterStop(fn func() 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() error) Option

BeforeStart run funcs before service starts.

func BeforeStop

func BeforeStop(fn func() error) Option

BeforeStop run funcs before service stops.

func Broker

func Broker(b broker.Broker) Option

Broker to be used for service.

func Cache

func Cache(c cache.Cache) Option

func Client

func Client(c client.Client) Option

Client to be used for service.

func Cmd

func Cmd(c cmd.Cmd) Option

func Config

func Config(c config.Config) Option

Config sets the config 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 Flags

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

Flags that can be passed to service.

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 Logger

func Logger(l logger.Logger) Option

Logger sets the logger for the service.

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 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 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 trace.Tracer) Option

Tracer sets the tracer for the service.

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 {
	Auth      auth.Auth
	Broker    broker.Broker
	Cache     cache.Cache
	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
	Logger    logger.Logger
	// 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 Publisher

type Publisher = Event

Type alias to satisfy the deprecation.

type Service

type Service interface {
	// The service name
	Name() string
	// Init initializes 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 initializing 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
api
Package api is for building api gateways
Package api is for building api gateways
client
Package client provides an api client
Package client provides an api client
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 recognized versioned urls
Package vpath resolves using http path and recognized 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/acme/autocert
Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config.
Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config.
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
Package broker is an interface used for asynchronous messaging
Package broker is an interface used for asynchronous messaging
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
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
Protorpc provides a net/rpc proto-rpc codec.
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.
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
debug
handler
Package handler implements service debug handler embedded in go-micro services
Package handler implements service debug handler embedded in go-micro services
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
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.
Package events is for event streaming and storage
Package events is for event streaming and storage
Package log provides a log interface
Package log provides a log interface
Package metadata is a way of defining message headers
Package metadata is a way of defining message headers
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
Package runtime is a service runtime manager
Package runtime is a service runtime manager
kubernetes
Package kubernetes implements kubernetes micro runtime
Package kubernetes implements kubernetes micro runtime
local
Package local provides a local runtime
Package local provides a local runtime
local/build
Package build builds a micro runtime package
Package build builds a micro runtime package
local/build/docker
Package docker builds docker images
Package docker builds docker images
local/build/go
Package golang is a go package manager
Package golang is a go package manager
local/process
Package process executes a binary
Package process executes a binary
local/process/os
Package os runs processes locally
Package os runs processes locally
local/source
Package source retrieves source code
Package source retrieves source code
local/source/git
Package git provides a git source
Package git provides a git source
local/source/go
Package golang is a source for Go
Package golang is a source for Go
Package selector is a way to pick a list of service nodes
Package selector is a way to pick a list of service nodes
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 tests implements a testing framwork, and provides default tests.
Package tests implements a testing framwork, and provides default tests.
Package transport is an interface for synchronous connection based communication
Package transport is an interface for synchronous connection based communication
headers
headers is a package for internal micro global constants
headers is a package for internal micro global constants
util
addr
addr provides functions to retrieve local IP addresses from device interfaces.
addr provides functions to retrieve local IP addresses from device interfaces.
backoff
Package backoff provides backoff functionality
Package backoff provides backoff functionality
buf
cmd
Package cmd is an interface for parsing the command line
Package cmd is an interface for parsing the command line
ctx
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/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
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).
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
tls
Package web provides web based micro services
Package web provides web based micro services

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL