This toolkit provides packages to put together server and pubsub daemons with the following features:
- Standardized configuration and logging
- Health check endpoints with configurable strategies
- Configuration for managing pprof endpoints and log levels
- Basic interfaces to define expectations and vocabulary
- Structured logging containing basic request information
- Useful metrics for endpoints
- Graceful shutdowns
server package is the bulk of the toolkit and relies on
server.Config to manage
It offers 2 server implementations:
SimpleServer, which is capable of handling basic HTTP and JSON requests via 5 of the available
RPCServer, which is capable of serving a gRPC server on one port and JSON endpoints on another. This kind of server can only handle the
server/kit package embodies Gizmo's goals to combine with go-kit.
- In this package you'll find:
- A more opinionated server with fewer choices.
- go-kit used for serving HTTP/JSON & gRPC used for serving HTTP2/RPC
- Monitoring and metrics are automatically registered if running within App Engine.
- Logs go to stdout locally or directly to Stackdriver when in GCP.
- Using Go's 1.8 graceful HTTP shutdown.
- Services using this package are expected to deploy to GCP.
auth package provides primitives for verifying inbound authentication tokens:
PublicKeySourceinterface is meant to provide
*rsa.PublicKeysfrom JSON Web Key Sets.
Verifierstruct composes key source implementations with custom decoders and verifier functions to streamline server side token verification.
auth/gcp package provides 2 Google Cloud Platform based
- The "Identity" key source and token source rely on GCP's identity JWT mechanism for asserting instance identities. This is the preferred method for asserting instance identity on GCP.
- The "IAM" key source and token source rely on GCP's IAM services for signing and verifying JWTs. This method can be used outside of GCP, if needed and can provide a bridge for users transitioning from the 1st generation App Engine (where Identity tokens are not available) runtime to the 2nd.
config package contains a handful of useful functions to load to configuration structs from JSON files, JSON blobs in Consul k/v, or environment variables.
- There are also many structs for common configuration options and credentials of different Cloud Services and Databases.
- The package also has a generic
Configtype in the
config/combinedsubpackage that contains all of the above types. It's meant to be a 'catch all' convenience struct that many applications should be able to use.
pubsub package contains two (
subscriber) generic interfaces for publishing data to queues as well as subscribing and consuming data from those queues.
There are 4 implementations of
For pubsub via Amazon's SNS/SQS, you can use the
For pubsub via Google's Pubsub, you can use the
For pubsub via Kafka topics, you can use the
For publishing via HTTP, you can use the
pubsub/pubsubtest package contains test implementations of the
pubsub.Subscriber interfaces that will allow developers to easily mock out and test their
web package has a handful of very useful functions for parsing types from request queries and payloads.
- Several reference implementations utilizing
pubsubare available in the
- There are also examples within the GoDoc: here
If you experience any issues please create an issue and/or reach out on the #gizmo channel in the Gophers Slack Workspace with what you've found.
The Gizmo logo was based on the Go mascot designed by Renée French and copyrighted under the Creative Commons Attribution 3.0 license.