README
¶
Go Micro 
Go Micro is a framework for microservices 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.
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. Find plugins in github.com/micro/go-plugins.
Getting Started
See pkg.go.dev for usage.
License
Go Micro is Apache 2.0 licensed.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
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/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 |
|
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/acme/certmagic
Package certmagic is the ACME provider from github.com/caddyserver/certmagic
|
Package certmagic is the ACME provider from github.com/caddyserver/certmagic |
|
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 |
|
jwt
Package jwt is a jwt implementation of the auth interface
|
Package jwt is a jwt implementation of the auth interface |
|
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 |
|
Package build is for building source into a package
|
Package build is for building source into a package |
|
docker
Package docker builds docker images
|
Package docker builds docker images |
|
golang
Package golang is a go package manager
|
Package golang is a go package manager |
|
tar
Package tar basically tarballs source code
|
Package tar basically tarballs source code |
|
Package cache is a caching interface
|
Package cache is a caching interface |
|
memory
Package memory is an in memory cache
|
Package memory is an in memory cache |
|
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 options
|
Package grpc provides a gRPC client Package grpc provides a gRPC options |
|
mucp
Package mucp provides a transport agnostic RPC client
|
Package mucp provides a transport agnostic 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. |
|
env
Package env provides config from environment variables
|
Package env provides config from environment variables |
|
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/micro/go-micro/v3/debug/log).Log
|
Package kubernetes is a logger implementing (github.com/micro/go-micro/v3/debug/log).Log |
|
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 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 |
|
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 metrics is for instrumentation and debugging
|
Package metrics is for instrumentation and debugging |
|
Package model is an interface for data modelling
|
Package model is an interface for data modelling |
|
mud
Package mud is the micro data model implementation
|
Package mud is the micro data model implementation |
|
sql
Package sql is the micro data model implementation
|
Package sql is the micro data model implementation |
|
Package network is for creating internetworks
|
Package network is for creating internetworks |
|
resolver
Package resolver resolves network names to addresses
|
Package resolver resolves network names to addresses |
|
resolver/dns
Package dns resolves names to dns records
|
Package dns resolves names to dns records |
|
resolver/dnssrv
Package dns srv resolves names to dns srv records
|
Package dns srv resolves names to dns srv records |
|
resolver/http
Package http resolves names to network addresses using a http request
|
Package http resolves names to network addresses using a http request |
|
resolver/noop
Package noop is a noop resolver
|
Package noop is a noop resolver |
|
resolver/registry
Package registry resolves names using the go-micro registry
|
Package registry resolves names using the go-micro registry |
|
resolver/static
Package static is a static resolver
|
Package static is a static resolver |
|
transport
Package transport is an interface for synchronous connection based communication
|
Package transport is an interface for synchronous connection based communication |
|
transport/grpc
Package grpc provides a grpc transport
|
Package grpc provides a grpc transport |
|
transport/memory
Package memory is an in-memory transport
|
Package memory is an in-memory transport |
|
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 go-micro/server Package proxy is a transparent proxy built on the go-micro/server
|
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 is a grpc proxy built for the go-micro/server
|
Package grpc is a grpc proxy built for the go-micro/server |
|
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 registry is an interface for service discovery
|
Package registry is an interface for service discovery |
|
cache
Package cache provides a registry cache
|
Package cache provides a registry cache |
|
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 |
|
noop
Package noop is a registry which does nothing
|
Package noop is a registry which does nothing |
|
Package router provides a network routing control plane
|
Package router provides a network routing control plane |
|
kubernetes
Package kubernetes is a kubernetes router which uses the service name and network to route
|
Package kubernetes is a kubernetes router which uses the service name and network to route |
|
mdns
Package mdns is an mdns router
|
Package mdns is an mdns router |
|
static
Package static is a static router which returns the service name as the address + port
|
Package static is a static router which returns the service name as the address + port |
|
Package runtime is a service runtime manager Package runtime is a service runtime manager
|
Package runtime is a service runtime manager Package runtime is a service runtime manager |
|
kubernetes
Package kubernetes implements kubernetes micro runtime Package kubernetes taken from https://github.com/micro/go-micro/blob/master/debug/log/kubernetes/kubernetes.go There are some modifications compared to the other files as this package doesn't provide write functionality.
|
Package kubernetes implements kubernetes micro runtime Package kubernetes taken from https://github.com/micro/go-micro/blob/master/debug/log/kubernetes/kubernetes.go There are some modifications compared to the other files as this package doesn't provide write functionality. |
|
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
|
Package os runs processes locally Package os runs processes locally |
|
local/source
Package source retrieves source code
|
Package source retrieves source code |
|
local/source/go
Package golang is a source for Go
|
Package golang is a source for Go |
|
local/test/bar
Package main is used to test the local runtime, specifically the entrypoint function
|
Package main is used to test the local runtime, specifically the entrypoint function |
|
local/test/cmd/test
Package main is used to test the local runtime, specifically the entrypoint function
|
Package main is used to test the local runtime, specifically the entrypoint function |
|
local/test/foo/cmd/bar
Package main is used to test the local runtime, specifically the entrypoint function
|
Package main is used to test the local runtime, specifically the entrypoint function |
|
local/test/foo/cmd/baz
Package main is used to test the local runtime, specifically the entrypoint function
|
Package main is used to test the local runtime, specifically the entrypoint function |
|
Package selector is for node selection and load balancing
|
Package selector is for node selection and load balancing |
|
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 a transport agnostic RPC server
|
Package mucp provides a transport agnostic RPC 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. |
|
file
Package local is a file system backed store
|
Package local is a file system backed store |
|
memory
Package memory is a in-memory store store
|
Package memory is a in-memory store store |
|
Package sync is an interface for distributed synchronization
|
Package sync is an interface for distributed synchronization |
|
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 |
|
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 |
|
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 |
|
log
Package log is a global internal logger DEPRECATED: this is frozen package, use github.com/micro/go-micro/v3/logger
|
Package log is a global internal logger DEPRECATED: this is frozen package, use github.com/micro/go-micro/v3/logger |
|
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 |
|
plugin
Package plugin provides the ability to load plugins Package plugin provides the ability to load plugins
|
Package plugin provides the ability to load plugins Package plugin provides the ability to load plugins |
|
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 |
Click to show internal directories.
Click to hide internal directories.