README
¶
Go service building blocks
This repository contains a collection of packages designed to aid building reliable, observable, zero-downtime services using Go.
What is in here?
conf/envLoad application config from environment variables (we are moving away from this).conf/o11yWiring code for theo11ypackage.conf/secretDon't store your secrets in a string that can be accidentally logged. Use asecret.Stringinstead.dbCommon patterns using when talking to an RDBMS. Currnetly only supports PostgreSQL.httpclientA simple HTTP client that adds observability and resilience to the standard Go HTTP client.httpserverStarting and stopping the standard Go http server cleanly.o11yObservability that is currently backed by Honeycomb. It also supports outputting trace data as JSON and plain or colored text output.systemManage the startup, running, metrics and shutdown of a Go service.terminationA handler to aid signal based service termination. (Used internally by thesystempackage).testing/compilerAt CircleCI we aim to acceptance test whole compiled binaries. This package lets us do that, while capturing test coverage for the binary.testing/downloadDownload releases of binaries for using in end to end service testing.testing/httprecorderRecord HTTP requests inside an HTTP server, and search them.testing/kongtestIf you are using kong for your CLI parsing, this helps in writing golden tests for the CLI definition.testing/releasesHelper to determine which binaries to download for end to end tests.testing/testcontextSetup a background context that includeso11y.workerRun a service worker loop with observability and back-off for no work found.
Who is this for?
These packages are intended to be used internally at CircleCI. While this code is licenced permissively with an MIT licence, this is not a true "open source" project, in that there is no active community using it.
No guaranteed API stability
While we do not intentionally aim to break compatibility, we make no promises that we will maintain a stable API if there are good reasons to break it.
Directories
¶
| Path | Synopsis |
|---|---|
|
config
|
|
|
env
Package env provides a few helpers to load in environment variables with defaults
|
Package env provides a few helpers to load in environment variables with defaults |
|
example
module
|
|
|
Package httpclient provides an http client instrumented with the ex/o11y package, and includes configurable timeouts, retries, authentication and connection pooling.
|
Package httpclient provides an http client instrumented with the ex/o11y package, and includes configurable timeouts, retries, authentication and connection pooling. |
|
Package o11y provides observability in the form of tracing and metrics
|
Package o11y provides observability in the form of tracing and metrics |
|
honeycomb
Package honeycomb implements o11y tracing.
|
Package honeycomb implements o11y tracing. |
|
wrappers/o11ynethttp
Package o11ynethttp provides common http middleware for tracing requests.
|
Package o11ynethttp provides common http middleware for tracing requests. |
|
testing
|
|
|
compiler
Package binary provides a convenient mechanism for building and running a service binary as part of an acceptance test suite.
|
Package binary provides a convenient mechanism for building and running a service binary as part of an acceptance test suite. |
Click to show internal directories.
Click to hide internal directories.