README
¶
x
A set of packages for reuse within Heroku Go applications.
Commands
- protoc-gen-loggingtags: a protoc plugin to mark which message fields are safe to log
- s3env: utility to manage ENV vars in an S3 bucket
Development
The Makefile provides a few targets to help ensure the code is linted and tested.
$ make help
target help
------ ----
lint Runs golangci-lint. Override defaults with LINT_RUN_OPTS
test Runs go test. Override defaults with GOTEST_OPT
coverage Generates a coverage profile and opens a web browser with the results
proto Regenerate protobuf files
ci-lint Runs the ci based lint job locally.
ci-test Runs the ci based test job locally
ci-coverage Runs the ci based coverage job locally
'ci-' targets require the CircleCI cli tool: https://circleci.com/docs/2.0/local-cli/
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cleanurl provides utilities for scrubbing basic auth credentials from URLs.
|
Package cleanurl provides utilities for scrubbing basic auth credentials from URLs. |
|
cmd
|
|
|
protoc-gen-loggingtags
protoc-gen-loggingtags is a plugin for protoc which allows message fields to be annotated as safe to log.
|
protoc-gen-loggingtags is a plugin for protoc which allows message fields to be annotated as safe to log. |
|
Package cmdutil provides abstractions for building things which can be started and stopped as a part of a executable's process lifecycle.
|
Package cmdutil provides abstractions for building things which can be started and stopped as a part of a executable's process lifecycle. |
|
debug
Package debug wraps the gops agent for use as a cmdutil-compatible Server.
|
Package debug wraps the gops agent for use as a cmdutil-compatible Server. |
|
health
Package health provides cmdutil-compatible healthcheck utilities.
|
Package health provides cmdutil-compatible healthcheck utilities. |
|
https
Package https provides utilities for configuring and running HTTP servers over TLS.
|
Package https provides utilities for configuring and running HTTP servers over TLS. |
|
hypercmd
Package hypercmd provides utilities for creating "hyper commands", where multiple commands are bundled into a single executable to get faster builds and smaller binaries.
|
Package hypercmd provides utilities for creating "hyper commands", where multiple commands are bundled into a single executable to get faster builds and smaller binaries. |
|
metrics
Package metrics provides helpers for setting up metrics reporting.
|
Package metrics provides helpers for setting up metrics reporting. |
|
oc
Package oc provides a cmdutil.Server for opencensus.
|
Package oc provides a cmdutil.Server for opencensus. |
|
redispool
Package redispool supports setting up redis connection pools parameterized via environment variables.
|
Package redispool supports setting up redis connection pools parameterized via environment variables. |
|
rollbar
Package rollbar provides helpers for setting up rollbar error reporting.
|
Package rollbar provides helpers for setting up rollbar error reporting. |
|
service
Package service provides standardized command and HTTP setup by smartly composing the other cmdutil packages based on environment variables.
|
Package service provides standardized command and HTTP setup by smartly composing the other cmdutil packages based on environment variables. |
|
signals
Package signals provides a signal handler which is usable as a cmdutil.Server.
|
Package signals provides a signal handler which is usable as a cmdutil.Server. |
|
spaceca
Package spaceca provides helpers for setting up TLS from a CA configuration.
|
Package spaceca provides helpers for setting up TLS from a CA configuration. |
|
svclog
Package svclog provides logging facilities for standard services.
|
Package svclog provides logging facilities for standard services. |
|
go-kit
|
|
|
metrics
Package metrics is a largely a wrapper around the standard go-kit Provider type, with an extension for Cardinality estimators, for use on large sets.
|
Package metrics is a largely a wrapper around the standard go-kit Provider type, with an extension for Cardinality estimators, for use on large sets. |
|
metrics/l2met
Package l2met provides a basic log-based metrics provider for cases where a real provider is not available.
|
Package l2met provides a basic log-based metrics provider for cases where a real provider is not available. |
|
metrics/multiprovider
Package multiprovider allows multiple metrics.Providers to be composed together to report metrics to multiple places.
|
Package multiprovider allows multiple metrics.Providers to be composed together to report metrics to multiple places. |
|
metrics/provider/discard
Package discard is copied out of the go-kit metrics, provider package because importing that package brings in too many dependencies.
|
Package discard is copied out of the go-kit metrics, provider package because importing that package brings in too many dependencies. |
|
metrics/provider/librato
Package librato is a small wrapper around Librato's API for submitting metrics.
|
Package librato is a small wrapper around Librato's API for submitting metrics. |
|
metrics/provider/otel
Package otel is a wrapper around Open-Telemetry's API for submitting metrics.
|
Package otel is a wrapper around Open-Telemetry's API for submitting metrics. |
|
metrics/testmetrics
Package testmetrics is for testing provider metrics with a test Provider that adheres to the Provider interface
|
Package testmetrics is for testing provider metrics with a test Provider that adheres to the Provider interface |
|
metricsregistry
Package metricsregistry provides utilities for working with dynamically created metrics.
|
Package metricsregistry provides utilities for working with dynamically created metrics. |
|
runtimemetrics
Package runtimemetrics exposes a go-kit metrics collector for Go runtime metrics.
|
Package runtimemetrics exposes a go-kit metrics collector for Go runtime metrics. |
|
grpcmetrics
Package grpcmetrics provides interceptors for collecting metrics about grpc servers and clients.
|
Package grpcmetrics provides interceptors for collecting metrics about grpc servers and clients. |
|
testserver
Package testserver implements a simple gRPC server and client to use for testing.
|
Package testserver implements a simple gRPC server and client to use for testing. |
|
Package hcontext is a small set of helpers and utilities for managing values commonly kept in contexts in Heroku Go code.
|
Package hcontext is a small set of helpers and utilities for managing values commonly kept in contexts in Heroku Go code. |
|
Package hmetrics is a self-contained client for Heroku Go runtime metrics.
|
Package hmetrics is a self-contained client for Heroku Go runtime metrics. |
|
onload
Package onload automatically starts hmetrics reporting, ignoring errors and retrying reporting, backing off in 10 second increments.
|
Package onload automatically starts hmetrics reporting, ignoring errors and retrying reporting, backing off in 10 second increments. |
|
Package hmiddleware provides common HTTP middleware.
|
Package hmiddleware provides common HTTP middleware. |
|
httpmetrics
Package httpmetrics provides middleware for collecting metrics about http servers.
|
Package httpmetrics provides middleware for collecting metrics about http servers. |
|
Package loggingtags is an import target of code generated by protoc-gen-loggingtags.
|
Package loggingtags is an import target of code generated by protoc-gen-loggingtags. |
|
logplex
|
|
|
Package scrub defines helpers for removing sensitive data from HTTP headers and URLs to make them safe for logging.
|
Package scrub defines helpers for removing sensitive data from HTTP headers and URLs to make them safe for logging. |
|
testing
|
|
|
mustcert
Package mustcert generates certificates for TLS testing
|
Package mustcert generates certificates for TLS testing |
|
testenv
Package testenv exposes environment-dependent resources for testing.
|
Package testenv exposes environment-dependent resources for testing. |
|
testlog
Package testlog provides a test logger and helpers to check log output.
|
Package testlog provides a test logger and helpers to check log output. |
|
Package tickgroup allows a collection of goroutines to call a subtask every set time interval.
|
Package tickgroup allows a collection of goroutines to call a subtask every set time interval. |
|
Package tlsconfig provides a safe set of TLS configurations for the Mozilla recommended ciphersuites.
|
Package tlsconfig provides a safe set of TLS configurations for the Mozilla recommended ciphersuites. |
Click to show internal directories.
Click to hide internal directories.