README
¶
Go kit 
Go kit is a programming toolkit for building microservices (or elegant monoliths) in Go. We solve common problems in distributed systems and application architecture so you can focus on delivering business value.
- Website: gokit.io
- Mailing list: go-kit
- Slack: gophers.slack.com #go-kit (invite)
Motivation
Go has emerged as the language of the server, but it remains underrepresented in so-called "modern enterprise" companies like Facebook, Twitter, Netflix, and SoundCloud. Many of these organizations have turned to JVM-based stacks for their business logic, owing in large part to libraries and ecosystems that directly support their microservice architectures.
To reach its next level of success, Go needs more than simple primitives and idioms. It needs a comprehensive toolkit, for coherent distributed programming in the large. Go kit is a set of packages and best practices, which provide a comprehensive, robust, and trustable way of building microservices for organizations of any size.
For more details, see the website, the motivating blog post and the video of the talk. See also the Go kit talk at GopherCon 2015.
Goals
- Operate in a heterogeneous SOA — expect to interact with mostly non-Go-kit services
- RPC as the primary messaging pattern
- Pluggable serialization and transport — not just JSON over HTTP
- Operate within existing infrastructures — no mandates for specific tools or technologies
Non-goals
- Supporting messaging patterns other than RPC (for now) — e.g. MPI, pub/sub, CQRS, etc.
- Re-implementing functionality that can be provided by adapting existing software
- Having opinions on operational concerns: deployment, configuration, process supervision, orchestration, etc.
Contributing
Please see CONTRIBUTING.md. Thank you, contributors!
Dependency management
Go kit is a library, designed to be imported into a binary package. Vendoring is currently the best way for binary package authors to ensure reliable, reproducible builds. Therefore, we strongly recommend our users use vendoring for all of their dependencies, including Go kit. To avoid compatibility and availability issues, Go kit doesn't vendor its own dependencies, and doesn't recommend use of third-party import proxies.
There are several tools which make vendoring easier, including dep, gb, glide, gvt, and govendor. In addition, Go kit uses a variety of continuous integration providers to find and fix compatibility problems as soon as they occur.
Related projects
Projects with a ★ have had particular influence on Go kit's design (or vice-versa).
Service frameworks
- gizmo, a microservice toolkit from The New York Times ★
- go-micro, a microservices client/server library ★
- gotalk, async peer communication protocol & library
- Kite, a micro-service framework
- gocircuit, dynamic cloud orchestration
Individual components
- afex/hystrix-go, client-side latency and fault tolerance library
- armon/go-metrics, library for exporting performance and runtime metrics to external metrics systems
- codahale/lunk, structured logging in the style of Google's Dapper or Twitter's Zipkin
- eapache/go-resiliency, resiliency patterns
- sasbury/logging, a tagged style of logging
- grpc/grpc-go, HTTP/2 based RPC
- inconshreveable/log15, simple, powerful logging for Go ★
- mailgun/vulcand, programmatic load balancer backed by etcd
- mattheath/phosphor, distributed system tracing
- pivotal-golang/lager, an opinionated logging library
- rubyist/circuitbreaker, circuit breaker library
- sirupsen/logrus, structured, pluggable logging for Go ★
- sourcegraph/appdash, application tracing system based on Google's Dapper
- spacemonkeygo/monitor, data collection, monitoring, instrumentation, and Zipkin client library
- streadway/handy, net/http handler filters
- vitess/rpcplus, package rpc + context.Context
- gdamore/mangos, nanomsg implementation in pure Go
Web frameworks
Additional reading
- Architecting for the Cloud — Netflix
- Dapper, a Large-Scale Distributed Systems Tracing Infrastructure — Google
- Your Server as a Function (PDF) — Twitter
Development supported by DigitalOcean.
Directories
¶
| Path | Synopsis |
|---|---|
|
auth
|
|
|
Package circuitbreaker implements the circuit breaker pattern.
|
Package circuitbreaker implements the circuit breaker pattern. |
|
Package endpoint defines an abstraction for RPCs.
|
Package endpoint defines an abstraction for RPCs. |
|
Package log provides a structured logger.
|
Package log provides a structured logger. |
|
level
Package level implements leveled logging on top of Go kit's log package.
|
Package level implements leveled logging on top of Go kit's log package. |
|
term
Package term provides tools for logging to a terminal.
|
Package term provides tools for logging to a terminal. |
|
Package metrics provides a framework for application instrumentation.
|
Package metrics provides a framework for application instrumentation. |
|
discard
Package discard provides a no-op metrics backend.
|
Package discard provides a no-op metrics backend. |
|
internal/convert
Package convert provides a way to use Counters, Histograms, or Gauges as one of the other types
|
Package convert provides a way to use Counters, Histograms, or Gauges as one of the other types |
|
internal/ratemap
Package ratemap implements a goroutine-safe map of string to float64.
|
Package ratemap implements a goroutine-safe map of string to float64. |
|
multi
Package multi provides adapters that send observations to multiple metrics simultaneously.
|
Package multi provides adapters that send observations to multiple metrics simultaneously. |
|
prometheus
Package prometheus provides Prometheus implementations for metrics.
|
Package prometheus provides Prometheus implementations for metrics. |
|
provider
Package provider provides a factory-like abstraction for metrics backends.
|
Package provider provides a factory-like abstraction for metrics backends. |
|
teststat
Package teststat provides helpers for testing metrics backends.
|
Package teststat provides helpers for testing metrics backends. |
|
Package sd provides utilities related to service discovery.
|
Package sd provides utilities related to service discovery. |
|
dnssrv
Package dnssrv provides an Instancer implementation for DNS SRV records.
|
Package dnssrv provides an Instancer implementation for DNS SRV records. |
|
lb
Package lb implements the client-side load balancer pattern.
|
Package lb implements the client-side load balancer pattern. |
|
Package tracing provides helpers and bindings for distributed tracing.
|
Package tracing provides helpers and bindings for distributed tracing. |
|
opencensus
Package opencensus provides Go kit integration to the OpenCensus project.
|
Package opencensus provides Go kit integration to the OpenCensus project. |
|
Package transport contains bindings to concrete transports.
|
Package transport contains bindings to concrete transports. |
|
amqp
Package amqp implements an AMQP transport.
|
Package amqp implements an AMQP transport. |
|
grpc
Package grpc provides a gRPC binding for endpoints.
|
Package grpc provides a gRPC binding for endpoints. |
|
http
Package http provides a general purpose HTTP binding for endpoints.
|
Package http provides a general purpose HTTP binding for endpoints. |
|
http/jsonrpc
Package jsonrpc provides a JSON RPC (v2.0) binding for endpoints.
|
Package jsonrpc provides a JSON RPC (v2.0) binding for endpoints. |
|
httprp
Package httprp provides an HTTP reverse-proxy transport.
|
Package httprp provides an HTTP reverse-proxy transport. |
|
util
|
|
|
conn
Package conn provides utilities related to connections.
|
Package conn provides utilities related to connections. |