ex

module
v1.0.1148-e9b901e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 14, 2021 License: MIT

README

Go service building blocks

This repository contains a collection of packages designed to aid building reliable, observable, zero-downtime services using Go.

Documentation

Browse the docs at pkg.go.dev.

What is in here?

  • config/o11y Wiring code for the o11y package.
  • config/secret Don't store your secrets in a string that can be accidentally logged. Use a secret.String instead.
  • datadog A basic Datadog API client for retrieving metrics back from Datadog.
  • db Common patterns using when talking to an RDBMS. Only supports PostgreSQL at present.
  • httpclient A simple HTTP client that adds observability and resilience to the standard Go HTTP client.
  • httpserver Starting and stopping the standard Go http server cleanly.
  • httpserver/ginrouter A common base for configuring a Gin router instance.
  • httpserver/healthcheck A healthcheck HTTP server that can accept all the checks from a system.
  • o11y Observability that is currently backed by Honeycomb. It also supports outputting trace data as JSON and plain or colored text output.
  • o11y/honeycomb The honeycomb-backed implementation of o11y.
  • o11y/wrappers/o11ygin o11y middleware for the Gin router.
  • o11y/wrappers/o11ynethttp o11y middleware for the standard Go HTTP server.
  • rabbit Experimental RabbitMQ publishing client.
  • redis Wiring and observability for Redis.
  • system Manage the startup, running, metrics and shutdown of a Go service.
  • termination A handler to aid signal based service termination. (Used internally by the system package).
  • testing/compiler At CircleCI we aim to acceptance test whole compiled binaries. This package lets us do that.
  • testing/dbfixture Get a resettable unique database for each test.
  • testing/download Download releases of binaries for using in end to end service testing.
  • testing/fakemetrics A fake recording o11y metrics implementation.
  • testing/httprecorder Record HTTP requests inside an HTTP server, and search them.
  • testing/kongtest If you are using kong for your CLI parsing, this helps in writing golden tests for the CLI definition.
  • testing/rabbitfixture Get an isolated RabbitMQ VHost for your tests, so they don't interfere.
  • testing/redisfixture Get an isolated Redis DB for your tests, so they don't interfere.
  • testing/releases Helper to determine which binaries to download for end to end tests.
  • testing/runner Run a binary in an acceptance test (scan output for ports, wait for start).
  • testing/testcontext Setup a background context that includes o11y.
  • worker Run 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
o11y
Package o11y is the primary entrypoint for wiring up a standard configuration of the o11y observability system.
 Package o11y is the primary entrypoint for wiring up a standard configuration of the o11y observability system.
secret
Package secret contains a struct to store secrets in that won't accidentally let them be logged.
 Package secret contains a struct to store secrets in that won't accidentally let them be logged.
Package datadog contains a basic Datadog API client for retrieving metrics back from Datadog.
 Package datadog contains a basic Datadog API client for retrieving metrics back from Datadog.
Package db contains a variety of tools for working safely with databases.
 Package db contains a variety of tools for working safely with databases.
example module
Package httpclient contains a simple HTTP client that adds observability and resilience to the standard Go HTTP client.
 Package httpclient contains a simple HTTP client that adds observability and resilience to the standard Go HTTP client.
Package httpserver contains helpers for creating zero-downtime REST APIs.
 Package httpserver contains helpers for creating zero-downtime REST APIs.
ginrouter
Package ginrouter provides a common base for configuring a Gin router instance, wiring in the standard o11y wrappers.
 Package ginrouter provides a common base for configuring a Gin router instance, wiring in the standard o11y wrappers.
healthcheck
Package healthcheck contains a simple healthcheck handler.
 Package healthcheck contains a simple healthcheck handler.
internal
syncbuffer
Package o11y core of the ex observability system, currently backed by Honeycomb's libhoney.
 Package o11y core of the ex observability system, currently backed by Honeycomb's libhoney.
honeycomb
Package honeycomb implements o11y tracing.
 Package honeycomb implements o11y tracing.
wrappers/baggage
Package baggage contains the internal implementation of the o11y baggage.
 Package baggage contains the internal implementation of the o11y baggage.
wrappers/o11ygin
Package o11ygin contains middleware for the Gin router.
 Package o11ygin contains middleware for the Gin router.
wrappers/o11ynethttp
Package o11ynethttp contains middleware for the standard Go HTTP server.
 Package o11ynethttp contains middleware for the standard Go HTTP server.
Package rabbit contains an experimental RabbitMQ publishing client.
 Package rabbit contains an experimental RabbitMQ publishing client.
Package redis contains wiring and observability for the go-redis Redis client.
 Package redis contains wiring and observability for the go-redis Redis client.
Package rootcerts exists to support creating Docker images `FROM scratch`.
 Package rootcerts exists to support creating Docker images `FROM scratch`.
Package system manages the startup, running, metrics and shutdown of a Go service.
 Package system manages the startup, running, metrics and shutdown of a Go service.
Package termination contains a simple handler for termination signals.
 Package termination contains a simple handler for termination signals.
Package termination contains various helpers for writing high value tests.
 Package termination contains various helpers for writing high value tests.
compiler
Package compiler helps efficiently compile and cleanup your services in acceptance tests.
 Package compiler helps efficiently compile and cleanup your services in acceptance tests.
compiler/internal/cmd
compiler/internal/cmd2
dbfixture
Package dbfixture will setup a and reset a fresh database for each of your tests.
 Package dbfixture will setup a and reset a fresh database for each of your tests.
download
Package download helps download releases of binaries for using in end to end service testing.
 Package download helps download releases of binaries for using in end to end service testing.
fakemetrics
Package fakemetrics provides an implementation of the o11y metrics provider that will record all metrics you send it.
 Package fakemetrics provides an implementation of the o11y metrics provider that will record all metrics you send it.
httprecorder
Package httprecorder provides a simple way of recording and later retrieving all requests that are sent to an HTTP handler.
 Package httprecorder provides a simple way of recording and later retrieving all requests that are sent to an HTTP handler.
kongtest
Package kongtest helps write golden tests for your [Kong](https://github.com/alecthomas/kong) CLI parsing.
 Package kongtest helps write golden tests for your [Kong](https://github.com/alecthomas/kong) CLI parsing.
rabbitfixture
Package rabbitfixture will setup isolated RabbitMQ VHost for your tests, so they don't interfere.
 Package rabbitfixture will setup isolated RabbitMQ VHost for your tests, so they don't interfere.
redisfixture
Package redisfixture will setup an isolated Redis DB for your tests, so they don't interfere.
 Package redisfixture will setup an isolated Redis DB for your tests, so they don't interfere.
releases
Package releases is a helper to determine which binaries to download for end to end tests.
 Package releases is a helper to determine which binaries to download for end to end tests.
runner
Package runner allows you to run a binary in an acceptance test (scan output for ports, wait for start).
 Package runner allows you to run a binary in an acceptance test (scan output for ports, wait for start).
runner/internal/testservice
testcontext
Package testcontext provides a context with o11y wired in, setup for coloured logging and no-op metrics.
 Package testcontext provides a context with o11y wired in, setup for coloured logging and no-op metrics.
Package worker runs a service worker loop with observability and back-off for no work found.
 Package worker runs a service worker loop with observability and back-off for no work found.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.