Categorygithub.com/micro/go-micro/v2
modulepackage
2.9.1
Repository: https://github.com/micro/go-micro.git
Documentation: pkg.go.dev

# README

Go Micro License Go.Dev reference Travis CI Go Report Card

Go Micro is a framework for distributed systems 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

To make use of Go Micro

import "github.com/micro/go-micro/v2"

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

// initialise flags
service.Init()

// start the service
service.Run()

See the docs for detailed information on the architecture, installation and use of go-micro.

License

Go Micro is Apache 2.0 licensed.

# Packages

Package agent provides an interface for building robots.
No description provided by the author
Package auth provides authentication and authorization capability.
Package http provides a http based message broker.
Package client is an interface for an RPC client.
Package codec is an interface for encoding messages.
Package config is an interface for dynamic configuration.
Package debug provides micro debug packages.
Package errors provides a way to return detailed information for an RPC request error.
Package log provides a log interface.
Package metadata is a way of defining message headers.
Package network is for creating internetworks.
Package plugin provides the ability to load plugins.
Package proxy is a transparent proxy built on the go-micro/server.
Package registry is an interface for service discovery.
Package router provides a network routing control plane.
Package runtime is a service runtime manager.
Package server is an interface for a micro server.
Package service encapsulates the client, server and other interfaces to provide a complete micro service.
Package store is an interface for distributed data storage.
Package sync is an interface for distributed synchronization.
Package transport is an interface for synchronous connection based communication.
Package tunnel provides gre network tunnelling.
No description provided by the author
Package web provides web based micro services.

# Functions

Action can be used to parse user provided cli options.
Address sets the address of the server.
AfterStart run funcs after service starts.
AfterStop run funcs after service stops.
Auth sets the auth for the service.
BeforeStart run funcs before service starts.
BeforeStop run funcs before service stops.
Broker to be used for service.
Client to be used for service.
No description provided by the author
Config sets the config for the service.
Context specifies a context for the service.
Flags that can be passed to service.
FromContext retrieves a Service from the Context.
HandleSignal toggles automatic installation of the signal handler that traps TERM, INT, and QUIT.
Metadata associated with the service.
Name of the service.
NewContext returns a new Context with the Service embedded within it.
NewEvent creates a new event publisher.
NewFunction returns a new Function for a one time executing Service.
Deprecated: NewPublisher returns a new Publisher.
NewService creates and returns a new Service based on the packages within.
Profile to be used for debug profile.
RegisterHandler is syntactic sugar for registering a handler.
RegisterInterval specifies the interval on which to re-register.
RegisterSubscriber is syntactic sugar for registering a subscriber.
RegisterTTL specifies the TTL to use when registering the service.
Registry sets the registry for the service and the underlying components.
Runtime sets the runtime.
Selector sets the selector for the service client.
Server to be used for service.
Store sets the store to use.
Tracer sets the tracer for the service.
Transport sets the transport for the service and the underlying components.
Version of the service.
WrapCall is a convenience method for wrapping a Client CallFunc.
WrapClient is a convenience method for wrapping a Client with some middleware component.
WrapHandler adds a handler Wrapper to a list of options passed into the server.
WrapSubscriber adds a subscriber Wrapper to a list of options passed into the server.

# Variables

No description provided by the author

# Structs

Options for micro service.

# Interfaces

Event is used to publish messages to a topic.
Function is a one time executing Service.
Service is an interface that wraps the lower level libraries within go-micro.

# Type aliases

No description provided by the author
Type alias to satisfy the deprecation.