Categorygithub.com/micro/go-micro
modulepackage
0.27.1
Repository: https://github.com/micro/go-micro.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
15
Dependents
1.3k
Files
491 SLOC

# README

Go Micro License GoDoc Travis CI Go Report Card

Go Micro is a framework for micro service development.

Read this in other languages: Simplified Chinese

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.

Plugins are available at github.com/micro/go-plugins.

Follow us on Twitter or join the Slack community.

Features

Go Micro abstracts away the details of distributed systems. Here are the main features.

  • 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. You can optionally set gossip using the SWIM protocol for p2p networks or consul for a resilient cloud-native setup.

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

  • Request/Response - 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. The default transport is http/1.1 or http2 when tls is enabled.

  • 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 is point-to-point http/1.1 or http2 when tls is enabled.

  • 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 the docs for detailed information on the architecture, installation and use of go-micro.

Sponsors

Sixt is an Enterprise Sponsor of Micro

# Packages

Package broker is an interface used for asynchronous messaging.
Package client is an interface for an RPC client.
Package cmd is an interface for parsing the command line.
Package codec is an interface for encoding messages.
Package errors provides a way to return detailed information for an RPC request error.
Package metadata is a way of defining message headers.
Package registry is an interface for service discovery.
Package selector is a way to pick a list of service nodes.
Package server is an interface for a micro server.
Package transport is an interface for synchronous communication.

# Functions

No description provided by the author
Address sets the address of the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Context specifies a context for the service.
No description provided by the author
FromContext retrieves a Service from the Context.
Metadata associated with the service.
Name of the service.
NewContext returns a new Context with the Service embedded within it.
NewFunction returns a new Function for a one time executing Service.
NewPublisher returns a new Publisher.
NewService creates and returns a new Service based on the packages within.
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.
Selector sets the selector for the service client.
No description provided by the author
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

No description provided by the author

# Interfaces

Function is a one time executing Service.
Publisher is syntactic sugar for publishing.
Service is an interface that wraps the lower level libraries within go-micro.

# Type aliases

No description provided by the author