patron

README

patron

Patron is a framework for creating microservices, originally created by Sotiris Mantzaris (https://github.com/mantzas). This fork is maintained by Beat Engineering (https://thebeat.co)

Patron is french for template or pattern, but it means also boss which we found out later (no pun intended).

The entry point of the framework is the Service. The Service uses Components to handle the processing of sync and async requests. The Service starts by default an HTTP Component which hosts the debug, alive, ready and metric endpoints. Any other endpoints will be added to the default HTTP Component as Routes. Alongside Routes one can specify middleware functions to be applied ordered to all routes as MiddlewareFunc. The service set's up by default logging with zerolog, tracing and metrics with jaeger and prometheus.

Patron provides abstractions for the following functionality of the framework:

• service, which orchestrates everything
• components and processors, which provide an abstraction of adding processing functionality to the service
  • asynchronous message processing (RabbitMQ, Kafka, AWS SQS)
  • synchronous processing (HTTP)
  • gRPC support
• metrics and tracing
• logging

Patron provides the same defaults for making the usage as simple as possible. Patron needs Go 1.13 as a minimum.

How to Contribute

1. Contributor: An issue has to be created with a problem description and possible solutions using the github template. The better the problem and solution are described, the easier for the Curators and Others to understand it and the faster the process. In case of a bug, steps to reproduce will help a lot.
2. Curators and Others: The curators will engage in a discussion about the problem and the possible solution. Others can join the discussion to bring other solutions and insights at any point.
3. Curators: After the discussion mentioned above, it will be determined if the proposed solution will be implemented or not. Appropriate tags will be applied to the issue.
4. Contributor: The contributor will work as follows:
   • assign the issue to himself
   • create a fork
   • git clone the fork on your machine
   • enable signing your work
   • create a PR. use WIP to mark unfinished work e.g. WIP: Fixing a bug (fixes #1)
   • after development has finished remove the WIP if applied
5. Curators: The curators will conduct a full code review
6. Curators: After at least 2 curators have approved the PR, it will be merged to master
7. Curators: A release will follow after that at some point

PR's should have the following requirements:

• Tests are required (where applicable, terms may vary)
  • Unit
  • Component
  • Integration
• High code coverage
• Coding style (go fmt)
• Linting we use golangci-lint

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project and its community you agree to abide by those terms.

patron-cli

The framework supplies a cli in order to simplify repository generation with the following features:

• git repository creation
• cmd folder and main.go creation with build version support (go build -ldflags '-X main.version=1.0.0' main.go)
• go module support and vendoring
• Dockerfile with version support (docker build --build-arg version=1.0.0)

The latest version can be installed with

go get github.com/beatlabs/patron/cmd/patron

Below is an example of a service created with the cli that has a module name github.com/beatlabs/test and will be created in the test folder in the current directory.

patron -m "github.com/beatlabs/test" -p "test"

Service

The Service has the role of glueing all of the above together, which are:

• setting up logging
• setting up default HTTP component with the following endpoints configured:
  • profiling via pprof
  • liveness check
  • readiness check
• setting up termination by os signal
• setting up SIGHUP custom hook if provided by an option
• starting and stopping components
• handling component errors
• setting up metrics and tracing

The service has some default settings which can be changed via environment variables:

• Service HTTP port, for setting the default HTTP components port to 50000 with PATRON_HTTP_DEFAULT_PORT
• Log level, for setting zerolog with INFO log level with PATRON_LOG_LEVEL
• Tracing, for setting up jaeger tracing with
  • agent host 0.0.0.0 with PATRON_JAEGER_AGENT_HOST
  • agent port 6831 with PATRON_JAEGER_AGENT_PORT
  • sampler type probabilisticwith PATRON_JAEGER_SAMPLER_TYPE
  • sampler param 0.0 with PATRON_JAEGER_SAMPLER_PARAM, which means that traces are not initiated here.

Component

A Component is an interface that exposes the following API:

type Component interface {
  Run(ctx context.Context) error  
}

The above API gives the Service the ability to start and gracefully shutdown a component via context cancellation. Furthermore, the component describes itself by implementing the Info method and thus giving the service the ability to report the information of all components. The framework divides the components in 2 categories:

• synchronous, which are components that follow the request/response pattern and
• asynchronous, which consume messages from a source but don't respond anything back

The following component implementations are available:

• HTTP (sync)
• gRPC
• RabbitMQ consumer (async)
• Kafka consumer (async)
• AWS SQS (async)

Adding to the above list is as easy as implementing a Component and a Processor for that component.

HTTP Middlewares

A MiddlewareFunc preserves the default net/http middleware pattern. You can create new middleware functions and pass them to Service to be chained on all routes in the default Http Component.

type MiddlewareFunc func(next http.Handler) http.Handler

// Setup a simple middleware for CORS
newMiddleware := func(h http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        w.Header().Add("Access-Control-Allow-Origin", "*")
        // Next
        h.ServeHTTP(w, r)
    })
}

gRPC

On the server side, the gRPC component injects a UnaryInterceptor which handles tracing and log propagation. On the client side, we inject a UnaryInterceptor which handles tracing and log propagation.

Examples

Detailed examples can be found in the examples folder with the following components involved:

• HTTP Component, HTTP Tracing, HTTP middleware
• Kafka Component, HTTP Component, HTTP Authentication, Kafka Tracing
• Kafka Component, AMQP Tracing
• AMQP Component, AWS SNS
• AWS SQS
• gRPC

Processors

Synchronous

The implementation of the processor is responsible to create a Request by providing everything that is needed (Headers, Fields, decoder, raw io.Reader) pass it to the implementation by invoking the Process method and handle the Response or the error returned by the processor.

The sync package contains only a function definition along with the models needed:

type ProcessorFunc func(context.Context, *Request) (*Response, error)

The Request model contains the following properties (which are provided when calling the "constructor" NewRequest)

• Fields, which may contain any fields associated with the request
• Raw, the raw request data (if any) in the form of a io.Reader
• Headers, the request headers in the form of map[string]string
• decode, which is a function of type encoding.Decode that decodes the raw reader

An exported function exists for decoding the raw io.Reader in the form of

Decode(v interface{}) error

The Response model contains the following properties (which are provided when calling the "constructor" NewResponse)

• Payload, which may hold a struct of type interface{}

Middlewares per Route

Middlewares can also run per routes using the processor as Handler. So using the Route helpers:

// A route with ...MiddlewareFunc that will run for this route only + tracing
route := NewRoute("/index", "GET" ProcessorFunc, true, ...MiddlewareFunc)
// A route with ...MiddlewareFunc that will run for this route only + auth + tracing
routeWithAuth := NewAuthRoute("/index", "GET" ProcessorFunc, true, Authendicator, ...MiddlewareFunc)

Asynchronous

The implementation of the async processor follows exactly the same principle as the sync processor. The main difference is that:

• The Request is the Message and contains only data as []byte
• There is no Response, so the processor may return an error

type ProcessorFunc func(context.Context, *Message) error

Everything else is exactly the same.

Metrics and Tracing

Tracing and metrics are provided by Jaeger's implementation of the OpenTracing project. Every component has been integrated with the above library and produces traces and metrics. Metrics are provided with the default HTTP component at the /metrics route for Prometheus to scrape. Tracing will be sent to a jaeger agent which can be setup through environment variables mentioned in the config section. Sane defaults are applied for making the use easy. We have included some clients inside the trace package which are instrumented and allow propagation of tracing to downstream systems. The tracing information is added to each implementations header. These clients are:

• HTTP
• AMQP
• Kafka
• SQL

Correlation ID propagation

Patron receives and propagates a correlation ID. Much like the distributed tracing id, the correlation id is receiver on the entry points of the service e.g. HTTP, Kafka, etc. and is propagated via the provided clients. In case no correlation ID has been received, a new one is created.
The ID is usually received and sent via a header with key X-Correlation-Id.

Reliability

The reliability package contains the following implementations:

• Circuit Breaker

Circuit Breaker

The circuit breaker supports a half-open state which allows to probe for successful responses in order to close the circuit again. Every aspect of the circuit breaker is configurable via its settings.

Clients

The following clients have been implemented:

• http, with distributed tracing and optional circuit breaker
• sql, with distributed tracing
• kafka, with distributed tracing
• amqp, with distributed tracing

Logging

The log package is designed to be a leveled logger with field support.

The log package defines the logger interface and a factory function type that needs to be implemented in order to set up the logging in this framework.

  // instantiate the implemented factory func type and fields (map[string]interface{})
  err := log.Setup(factory, fields)
  // handle error

If the setup is omitted the package will not setup any logging!

From there logging is as simple as

  log.Info("Hello world!")

The implementations should support the following log levels:

• Debug, which should log the message with debug level
• Info, which should log the message with info level
• Warn, which should log the message with warn level
• Error, which should log the message with error level
• Panic, which should log the message with panic level and panics
• Fatal, which should log the message with fatal level and terminates the application

The first four (Debug, Info, Warn and Error) give the opportunity to differentiate the messages by severity. The last two (Panic and Fatal) do the same and do additional actions (panic and termination).

The package supports fields, which are logged along with the message, to augment the information further to ease querying in the log management system.

The following implementations are provided as sub-package and are by default wired up in the framework:

• zerolog, which supports the excellent zerolog library and is set up by default

Context Logging

Logs can be associated with some contextual data e.g. a request id. Every line logged should contain this id thus grouping the logs together. This is achieved with the usage of the context package as demonstrated below:

ctx := log.WithContext(r.Context(), log.Sub(map[string]interface{}{"requestID": uuid.New().String()}))

The context travels through the code as an argument and can be acquired as follows:

logger:=log.FromContext(ctx)
logger.Infof("request processed")

Benchmarks are provided to show the performance of this.

Every provided component creates a context logger which is then propagated in the context

Logger

The logger interface defines the actual logger.

type Logger interface {
  Fatal(...interface{})
  Fatalf(string, ...interface{})
  Panic(...interface{})
  Panicf(string, ...interface{})
  Error(...interface{})
  Errorf(string, ...interface{})
  Warn(...interface{})
  Warnf(string, ...interface{})
  Info(...interface{})
  Infof(string, ...interface{})
  Debug(...interface{})
  Debugf(string, ...interface{})
}

In order to be consistent with the design the implementation of the Fatal(f) have to terminate the application with an error and the Panic(f) need to panic.

Factory

The factory function type defines a factory for creating a logger.

type FactoryFunc func(map[string]interface{}) Logger

Security

The necessary abstraction is available to implement authentication in the following components:

• HTTP

HTTP

In order to use authentication, an authenticator has to be implemented following the interface:

type Authenticator interface {
  Authenticate(req *http.Request) (bool, error)
}

This authenticator can then be used to set up routes with authentication.

The following authenticator is available:

• API key authenticator, see examples

HTTP lifecycle endpoints

When creating a new HTTP component, Patron will automatically create a liveness and readiness route, which can be used to know the lifecycle of the application:

# liveness
GET /alive

# readiness
GET /ready

Both can return either a 200 OK or a 503 Service Unavailable status code (default: 200 OK).

It is possible to customize their behaviour by injecting an http.AliveCheck and/or an http.ReadyCheck OptionFunc to the HTTP component constructor.

Documentation

Overview

Package patron framework

Patron is a framework for creating microservices.

Patron is french for template or pattern, but it means also boss which we found out later (no pun intended).

The entry point of the framework is the Service. The Service uses Components to handle the processing of sync and async requests. The Service can setup as many Components it wants, even multiple HTTP components provided the port does not collide. The Service starts by default a HTTP component which hosts the debug, alive, ready and metric endpoints. Any other endpoints will be added to the default HTTP Component as Routes. The service set's up by default logging with zerolog, tracing and metrics with jaeger and prometheus.

Patron provides abstractions for the following functionality of the framework:

• service, which orchestrates everything
• components and processors, which provide a abstraction of adding processing functionality to the service
• asynchronous message processing (RabbitMQ, Kafka)
• synchronous processing (HTTP)
• metrics and tracing
• logging
• configuration management

Patron provides same defaults for making the usage as simple as possible. For more details please check out github repository https://github.com/beatlabs/patron.

Index

• func SetupLogging(name, version string) error
• type Builder
  • func New(name, version string) *Builder
  • func (b *Builder) Run(ctx context.Context) error
  • func (b *Builder) WithAliveCheck(acf http.AliveCheckFunc) *Builder
  • func (b *Builder) WithComponents(cc ...Component) *Builder
  • func (b *Builder) WithMiddlewares(mm ...http.MiddlewareFunc) *Builder
  • func (b *Builder) WithReadyCheck(rcf http.ReadyCheckFunc) *Builder
  • func (b *Builder) WithRoutesBuilder(rb *http.RoutesBuilder) *Builder
  • func (b *Builder) WithSIGHUP(handler func()) *Builder
• type Component

Functions

func SetupLogging

func SetupLogging(name, version string) error

SetupLogging sets up the default metrics logging.

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder gathers all required properties to construct a Patron service.

func New

func New(name, version string) *Builder

New initiates the Service builder chain. The builder contains default values for Alive/Ready checks, the SIGHUP handler and its version.

func (*Builder) Run

func (b *Builder) Run(ctx context.Context) error

Run starts up all service components and monitors for errors. If a component returns a error the service is responsible for shutting down all components and terminate itself.

func (*Builder) WithAliveCheck

func (b *Builder) WithAliveCheck(acf http.AliveCheckFunc) *Builder

WithAliveCheck overrides the default liveness check of the default HTTP component.

func (*Builder) WithComponents

func (b *Builder) WithComponents(cc ...Component) *Builder

WithComponents adds custom components to the Patron service.

func (*Builder) WithMiddlewares

func (b *Builder) WithMiddlewares(mm ...http.MiddlewareFunc) *Builder

WithMiddlewares adds generic middlewares to the default HTTP component.

func (*Builder) WithReadyCheck

func (b *Builder) WithReadyCheck(rcf http.ReadyCheckFunc) *Builder

WithReadyCheck overrides the default readiness check of the default HTTP component.

func (*Builder) WithRoutesBuilder

func (b *Builder) WithRoutesBuilder(rb *http.RoutesBuilder) *Builder

WithRoutesBuilder adds routes builder to the default HTTP component.

func (*Builder) WithSIGHUP

func (b *Builder) WithSIGHUP(handler func()) *Builder

WithSIGHUP adds a custom handler for when the service receives a SIGHUP.

type Component

type Component interface {
	Run(ctx context.Context) error
}

Component interface for implementing service components.