-
Notifications
You must be signed in to change notification settings - Fork 222
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
enhancement - update README, made it much more condensed/readable
- Loading branch information
1 parent
482d032
commit cae3dca
Showing
1 changed file
with
27 additions
and
227 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,252 +1,52 @@ | ||
| # Gizmo Microservice Toolkit [](https://godoc.org/github.com/NYTimes/gizmo) [](https://travis-ci.org/NYTimes/gizmo) [](https://coveralls.io/github/NYTimes/gizmo?branch=master) | ||
|
|
||
|  | ||
| <p align="center"> | ||
| <img src="https://lh3.googleusercontent.com/GZ8BtUP_lQJTibMTajjWeLogeXjT5ZzhT_aNRF4WSxNNKQcDDZ3a4k9HfZpXEnfx4T0-wfkv_qjA303Uz-BcJQWpQMHW0U3B-U7H8CI7dDrnxXm0LpCtRN1mrVUSgGAKRe4nSoZxxk-kUpKS_RefWesArYwVEJ62CPucDU5LlKVGUF8XihuWg5aRYQA_5Rwr16tJP5CZECaY0qG-5r6CmRy9gTYbczWmOiFisaQ2QJchYdTEQyrHh4ZH4zfoudOlSisSLQuZyRpVsI5i3uTsS1POL3cMvFoiE2vypv4p5m-G7ZCnFpsKVd4V5FSHE6iBhaJrFm6sF2MyJWBftQxuw4PzOB-wHXhTWwQHK5SWwPCxzgtMCvoC0ECUhx3aCa2Ga2t8Skf4linasSdkl98ttg_TDJTrkBx-W51FEP8CPH_0OZ0BNUOC6v3miAJcAw7eExtyYTK0-bYPOCW-SQ0ooFa_oOBUrddFNpvqh0wzbhGthXTfHnA9ILAm5g5bBAw0ZS8BVZSVLdRFQLgT7dCybNHxblAG9HSW5E14Jed-JvF6D1gxGqiZZnUQ0nByrPbRsoi-FFnr2fSFkeqRaR6JfXeMuKlJ59As6Owq3Q=w278-h306-no"/> | ||
| </p> | ||
|
|
||
| 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 | ||
| * structured logging containing basic request information | ||
| * useful metrics for endpoints | ||
| * graceful shutdowns | ||
| * basic interfaces to define our expectations and vocabulary | ||
| * Standardized configuration and logging | ||
| * Health check endpoints with configurable strategies | ||
| * Configuration for managing pprof endpoints and log levels | ||
| * Structured logging containing basic request information | ||
| * Useful metrics for endpoints | ||
| * Graceful shutdowns | ||
| * Basic interfaces to define expectations and vocabulary | ||
|
|
||
| In this toolkit, you will find: | ||
| ### Packages | ||
|
|
||
| ## The `config` packages | ||
| #### [`server`](https://godoc.org/github.com/NYTimes/gizmo/server) | ||
|
|
||
| The `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. | ||
| This package is the bulk of the toolkit and relies on `server.Config` to manage `Server` implementations. | ||
|
|
||
| The subpackages contain structs meant for managing common configuration options and credentials. There are currently configs for: | ||
| It offers 2 server implementations: | ||
|
|
||
| * Go Kit Metrics | ||
| * MySQL | ||
| * MongoDB | ||
| * Oracle | ||
| * PostgreSQL | ||
| * AWS (S3, DynamoDB, ElastiCache) | ||
| * GCP | ||
| * Gorilla's `securecookie` | ||
| 1. [`SimpleServer`](https://godoc.org/github.com/NYTimes/gizmo/server#SimpleServer), which is capable of handling basic HTTP and JSON requests via 5 of the available `Service` implementations: `SimpleService`, `JSONService`, `ContextService`, `MixedService` and a `MixedContextService`. | ||
|
|
||
| The package also has a generic `Config` type in the `config/combined` subpackage 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. | ||
| 2. [`RPCServer`](https://godoc.org/github.com/NYTimes/gizmo/server#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 `RPCService` implementation. | ||
|
|
||
| ## The `server` package | ||
| #### [`config`](https://godoc.org/github.com/NYTimes/gizmo/config) | ||
|
|
||
| This package is the bulk of the toolkit and relies on `server.Config` for any managing `Server` implementations. A server must implement the following interface: | ||
| The `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. | ||
|
|
||
| ```go | ||
| // Server is the basic interface that defines what expect from any server. | ||
| type Server interface { | ||
| Register(Service) error | ||
| Start() error | ||
| Stop() error | ||
| } | ||
| ``` | ||
| * There are also many structs for common configuration options and credentials of different Cloud Services and Databases. | ||
| * The package also has a generic `Config` type in the `config/combined` subpackage 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. | ||
|
|
||
| The package offers 2 server implementations: | ||
| #### [`pubsub`](https://godoc.org/github.com/NYTimes/gizmo/pubsub) | ||
|
|
||
| `SimpleServer`, which is capable of handling basic HTTP and JSON requests via 5 of the available `Service` implementations: `SimpleService`, `JSONService`, `ContextService`, `MixedService` and a `MixedContextService`. A service and these implementations will be defined below. | ||
| The `pubsub` package contains two (`publisher` and `subscriber`) generic interfaces for publishing data to queues as well as subscribing and consuming data from those queues. | ||
|
|
||
| `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 `RPCService` implementation. | ||
| #### [`pubsub/pubsubtest`](https://godoc.org/github.com/NYTimes/gizmo/pubsub/pubsubtest) | ||
|
|
||
| The `Service` interface is minimal to allow for maximum flexibility: | ||
| ```go | ||
| type Service interface { | ||
| Prefix() string | ||
| This package contains test implementations of the `pubsub.Publisher`, `pubsub.MultiPublisher`, and `pubsub.Subscriber` interfaces that will allow developers to easily mock out and test their `pubsub` implementations. | ||
|
|
||
| // Middleware provides a hook for service-wide middleware. | ||
| Middleware(http.Handler) http.Handler | ||
| } | ||
| ``` | ||
|
|
||
| The 5 service types that are accepted and hostable on the `SimpleServer`: | ||
|
|
||
| ```go | ||
| type SimpleService interface { | ||
| Service | ||
|
|
||
| // router - method - func | ||
| Endpoints() map[string]map[string]http.HandlerFunc | ||
| } | ||
|
|
||
| type JSONService interface { | ||
| Service | ||
|
|
||
| // Ensure that the route syntax is compatible with the router | ||
| // implementation chosen in cfg.RouterType. | ||
| // route - method - func | ||
| JSONEndpoints() map[string]map[string]JSONEndpoint | ||
| // JSONMiddleware provides a hook for service-wide middleware around JSONEndpoints. | ||
| JSONMiddleware(JSONEndpoint) JSONEndpoint | ||
| } | ||
|
|
||
| type MixedService interface { | ||
| Service | ||
|
|
||
| // route - method - func | ||
| Endpoints() map[string]map[string]http.HandlerFunc | ||
|
|
||
| // Ensure that the route syntax is compatible with the router | ||
| // implementation chosen in cfg.RouterType. | ||
| // route - method - func | ||
| JSONEndpoints() map[string]map[string]JSONEndpoint | ||
| // JSONMiddleware provides a hook for service-wide middleware around JSONEndpoints. | ||
| JSONMiddleware(JSONEndpoint) JSONEndpoint | ||
| } | ||
|
|
||
| type ContextService interface { | ||
| Service | ||
|
|
||
| // route - method - func | ||
| ContextEndpoints() map[string]map[string]ContextHandlerFunc | ||
| // ContextMiddleware provides a hook for service-wide middleware around ContextHandler | ||
| ContextMiddleware(ContextHandler) ContextHandler | ||
| } | ||
|
|
||
| type MixedContextService interface { | ||
| ContextService | ||
|
|
||
| // route - method - func | ||
| JSONEndpoints() map[string]map[string]JSONContextEndpoint | ||
| JSONContextMiddleware(JSONContextEndpoint) JSONContextEndpoint | ||
| } | ||
| ``` | ||
|
|
||
| Where `JSONEndpoint`, `JSONContextEndpoint`, `ContextHandler` and `ContextHandlerFunc` are defined as: | ||
|
|
||
| ```go | ||
| type JSONEndpoint func(*http.Request) (int, interface{}, error) | ||
|
|
||
| type JSONContextEndpoint func(context.Context, *http.Request) (int, interface{}, error) | ||
|
|
||
| type ContextHandler interface { | ||
| ServeHTTPContext(context.Context, http.ResponseWriter, *http.Request) | ||
| } | ||
|
|
||
| type ContextHandlerFunc func(context.Context, http.ResponseWriter, *http.Request) | ||
| ``` | ||
|
|
||
| Also, the one service type that works with an `RPCServer`: | ||
|
|
||
| ```go | ||
| type RPCService interface { | ||
| ContextService | ||
|
|
||
| Service() (grpc.ServiceDesc, interface{}) | ||
|
|
||
| // Ensure that the route syntax is compatible with the router | ||
| // implementation chosen in cfg.RouterType. | ||
| // route - method - func | ||
| JSONEndpoints() map[string]map[string]JSONContextEndpoint | ||
| // JSONMiddleware provides a hook for service-wide middleware around JSONContextEndpoints. | ||
| JSONMiddlware(JSONContextEndpoint) JSONContextEndpoint | ||
| } | ||
| ``` | ||
|
|
||
| The `Middleware(..)` functions offer each service a 'hook' to wrap each of its endpoints. This may be handy for adding additional headers or context to the request. This is also the point where other, third-party middleware could be easily plugged in (i.e. oauth, tracing, metrics, logging, etc.) | ||
|
|
||
| ## The `pubsub` packages | ||
|
|
||
| The base `pubsub` package contains three generic interfaces for publishing data to queues and subscribing and consuming data from those queues. | ||
|
|
||
| ```go | ||
| // Publisher is a generic interface to encapsulate how we want our publishers | ||
| // to behave. Until we find reason to change, we're forcing all publishers | ||
| // to emit protobufs. | ||
| type Publisher interface { | ||
| // Publish will publish a message. | ||
| Publish(ctx context.Context, key string, msg proto.Message) error | ||
| // Publish will publish a []byte message. | ||
| PublishRaw(ctx context.Context, key string, msg []byte) error | ||
| } | ||
|
|
||
| // MultiPublisher is an interface for publishers who support sending multiple | ||
| // messages in a single request, in addition to individual messages. | ||
| type MultiPublisher interface { | ||
| Publisher | ||
|
|
||
| // PublishMulti will publish multiple messages with a context. | ||
| PublishMulti(context.Context, []string, []proto.Message) error | ||
| // PublishMultiRaw will publish multiple raw byte array messages with a context. | ||
| PublishMultiRaw(context.Context, []string, [][]byte) error | ||
| } | ||
|
|
||
| // Subscriber is a generic interface to encapsulate how we want our subscribers | ||
| // to behave. For now the system will auto stop if it encounters any errors. If | ||
| // a user encounters a closed channel, they should check the Err() method to see | ||
| // what happened. | ||
| type Subscriber interface { | ||
| // Start will return a channel of raw messages. | ||
| Start() <-chan SubscriberMessage | ||
| // Err will contain any errors returned from the consumer connection. | ||
| Err() error | ||
| // Stop will initiate a graceful shutdown of the subscriber connection. | ||
| Stop() error | ||
| } | ||
| ``` | ||
|
|
||
| Where a `SubscriberMessage` is an interface that gives implementations a hook for acknowledging/delete messages. Take a look at the docs for each implementation in `pubsub` to see how they behave. | ||
|
|
||
| There are currently major 4 implementations of the `pubsub` interfaces: | ||
|
|
||
| For pubsub via Amazon's SNS/SQS, you can use the `pubsub/aws` package. | ||
|
|
||
| For pubsub via Google's Pubsub, you can use the `pubsub/gcp` package. This package offers 2 ways of publishing to Google PubSub. `gcp.NewPublisher` uses the RPC client and `gcp.NewHTTPPublisher` will publish over plain HTTP, which is useful for the App Engine standard environment. | ||
|
|
||
| For pubsub via Kafka topics, you can use the `pubsub/kafka` package. | ||
|
|
||
| For publishing via HTTP, you can use the `pubsub/http` package. | ||
|
|
||
| The `MultiPublisher` interface is only implemented by `pubsub/gcp`. | ||
|
|
||
| ## The `pubsub/pubsubtest` package | ||
|
|
||
| This package contains 'test' implementations of the `pubsub.Publisher`, `pubsub.MultiPublisher`, and `pubsub.Subscriber` interfaces that will allow developers to easily mock out and test their `pubsub` implementations: | ||
|
|
||
| ```go | ||
| type TestPublisher struct { | ||
| // Published will contain a list of all messages that have been published. | ||
| Published []TestPublishMsg | ||
|
|
||
| // GivenError will be returned by the TestPublisher on publish. | ||
| // Good for testing error scenarios. | ||
| GivenError error | ||
|
|
||
| // FoundError will contain any errors encountered while marshalling | ||
| // the protobuf struct. | ||
| FoundError error | ||
| } | ||
|
|
||
| type TestSubscriber struct { | ||
| // ProtoMessages will be marshalled into []byte used to mock out | ||
| // a feed if it is populated. | ||
| ProtoMessages []proto.Message | ||
|
|
||
| // JSONMEssages will be marshalled into []byte and used to mock out | ||
| // a feed if it is populated. | ||
| JSONMessages []interface{} | ||
|
|
||
| // GivenErrError will be returned by the TestSubscriber on Err(). | ||
| // Good for testing error scenarios. | ||
| GivenErrError error | ||
|
|
||
| // GivenStopError will be returned by the TestSubscriber on Stop(). | ||
| // Good for testing error scenarios. | ||
| GivenStopError error | ||
|
|
||
| // FoundError will contain any errors encountered while marshalling | ||
| // the JSON and protobuf struct. | ||
| FoundError error | ||
| } | ||
| ``` | ||
|
|
||
| ## The `web` package | ||
| #### [`web`](https://godoc.org/github.com/NYTimes/gizmo/web) | ||
|
|
||
| This package contains a handful of very useful functions for parsing types from request queries and payloads. | ||
|
|
||
| ## Examples | ||
| #### Examples | ||
|
|
||
| * Several reference implementations utilizing `server` and `pubsub` are available in the ['examples'](https://github.com/NYTimes/gizmo/tree/master/examples) subdirectory. | ||
| * Several reference implementations utilizing `server` and `pubsub` are available in the [`examples`](https://github.com/NYTimes/gizmo/tree/master/examples) subdirectory. | ||
|
|
||
| <sub>The Gizmo logo was based on the Go mascot designed by Renée French and copyrighted under the Creative Commons Attribution 3.0 license.</sub> |