README
¶
SpotHero Tools Library for Go
The SpotHero Tools Library is used internally at SpotHero across our Go programs. This library is a collection of common utilities and functions that we use to ensure common functionality and best practices within our organization.
We welcome community usage and collaboration.
Getting up and running
- Install Golang
- Clone this repository
maketo run lints and tests
Overview
This library contains common modules for use in all Go projects across SpotHero. To use this library simply import one of the packages in this library into your project and go modules will handle the rest.
Because this library is still under active development and is not yet 1.0, please expect that we may occasionally make backwards-incompatible changes.
Currently, this library supports the following features:
- CLI Utilities
- Kafka
- Support for consuming and producing metrics
- Schema Registry
- SQL Bindings for MySQL and Postgres
- CLI Support for SQL database configuration
- Avro Decoding
- HTTP Server and client tooling with instrumentation
- gRPC Server and client tooling with instrumentation
- Prometheus Metrics
- High-Performance Logging
- OpenTracing/Jaeger Support
- JSON Web Token (JWT) and Javascript Object Signing and Encryption (JOSE) Support
- Sentry Integration
In addition, all the above packages may automatically be integrated with Cobra/Viper CLIs for 12-factor application compatibility via the CLI module.
Usage
The packages in this library may be used together or independently. At SpotHero, our applications
all start from the Service ServerCmd which contains a "best-practice" configuration of a SpotHero
web server. This web-server includes a GRPC and HTTP Server, as well as full instrumentation with
tools such as Prometheus, Jaeger/OpenTracing, Sentry, and so on.
A simple example is provided under service/example_test.go which shows usage of this library to create a simple 12-factor Go Web application which has tracing, logging, metrics, sentry, and local caching enabled.
For production applications, we recommend separating the Cobra/Viper command portion into its own
cmd/ directory, and your application logic into a pkg/ directory as is standard with most Go
applications.
License
Apache 2.0
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli contains utilities for cobra.Command objects.
|
Package cli contains utilities for cobra.Command objects. |
|
Package currency contains utility functions for currencies.
|
Package currency contains utility functions for currencies. |
|
Package log wraps the go.uber.org/zap log package.
|
Package log wraps the go.uber.org/zap log package. |
|
Package pagination provides a simple pagination inteface for ordered items with string IDs.
|
Package pagination provides a simple pagination inteface for ordered items with string IDs. |
|
middleware
Package middleware provides hooks that are called when executing sql queries.
|
Package middleware provides hooks that are called when executing sql queries. |
|
Package time contains a drop in replacement for time.LoadLocation that uses caching.
|
Package time contains a drop in replacement for time.LoadLocation that uses caching. |