Merge pull request #2 from JSainsburyPLC/feature/add-build-version

Add build version

app.go

@@ -2,17 +2,19 @@ package xecho
 
 import (
 	"fmt"
+	"net/http"
+
 	"github.com/labstack/echo"
 	"github.com/newrelic/go-agent"
 	"github.com/newrelic/go-agent/_integrations/nrlogrus"
 	"github.com/sirupsen/logrus"
-	"net/http"
 )
 
 type Config struct {
 	ProjectName       string
 	AppName           string
 	EnvName           string
+	BuildVersion      string
 	LogLevel          logrus.Level
 	IsDebug           bool
 	NewRelicLicense   string
@@ -26,6 +28,7 @@ func NewConfig() Config {
 		ProjectName:       "",
 		AppName:           "",
 		EnvName:           "",
+		BuildVersion:      "",
 		LogLevel:          logrus.InfoLevel,
 		IsDebug:           false,
 		NewRelicLicense:   "",
@@ -45,10 +48,10 @@ func Echo(conf Config) *echo.Echo {
 	e := echo.New()
 	e.HideBanner = true
 	e.HidePort = true
-	e.Logger = appScopeLogger(logger, conf.AppName, conf.EnvName)
+	e.Logger = appScopeLogger(logger, conf.AppName, conf.EnvName, conf.BuildVersion)
 
 	// the order of these middleware is important - context should be first, error should be after logging ones
-	e.Use(ContextMiddleware(conf.AppName, conf.EnvName, logger, conf.IsDebug, newRelicApp))
+	e.Use(ContextMiddleware(conf.AppName, conf.EnvName, conf.BuildVersion, logger, conf.IsDebug, newRelicApp))
 	e.Use(PanicHandlerMiddleware(conf.ErrorHandler))
 	if conf.UseDefaultHeaders {
 		e.Use(DefaultHeadersMiddleware())

context.go

@@ -48,6 +48,7 @@ func (c *Context) AddNewRelicAttribute(key string, val interface{}) {
 func ContextMiddleware(
 	appName string,
 	envName string,
+	buildVersion string,
 	logger *logrus.Logger,
 	isDebug bool,
 	newRelicApp newrelic.Application,
@@ -64,9 +65,10 @@ func ContextMiddleware(
 				correlationID,
 				appName,
 				envName,
+				buildVersion,
 			)
 
-			cc := NewContext(c, newRelicApp, logger, correlationID, isDebug)
+			cc := NewContext(c, newRelicApp, logger, correlationID, isDebug, buildVersion)
 
 			return h(cc)
 		}
@@ -79,6 +81,7 @@ func NewContext(
 	logger *Logger,
 	correlationID string,
 	isDebug bool,
+	buildVersion string,
 ) *Context {
 	newRelicTx := newRelicApp.StartTransaction(
 		echoCtx.Request().URL.Path,
@@ -103,6 +106,7 @@ func NewContext(
 	customCtx.AddNewRelicAttribute("route", echoCtx.Path())
 	customCtx.AddNewRelicAttribute("correlationID", correlationID)
 	customCtx.AddNewRelicAttribute("ip", echoCtx.RealIP())
+	customCtx.AddNewRelicAttribute("buildVersion", buildVersion)
 
 	return customCtx
 }

context_test.go

@@ -22,7 +22,7 @@ func TestEchoHandler(t *testing.T) {
 
 func TestContextMiddleware(t *testing.T) {
 	ctx, _, _ := getEchoTestCtx()
-	mw := ContextMiddleware("testApp", "testEnv", NullLogger(), true, stubNewRelicApp())
+	mw := ContextMiddleware("testApp", "testEnv", "build-1.2.3", NullLogger(), true, stubNewRelicApp())
 	hCalled := false
 	h := EchoHandler(func(c *Context) error {
 		hCalled = true

logging.go

@@ -3,13 +3,14 @@ package xecho
 import (
 	"bytes"
 	"encoding/json"
-	"github.com/labstack/echo"
-	"github.com/labstack/gommon/log"
-	"github.com/sirupsen/logrus"
 	"io"
 	"io/ioutil"
 	"net/http"
 	"net/http/httputil"
+
+	"github.com/labstack/echo"
+	"github.com/labstack/gommon/log"
+	"github.com/sirupsen/logrus"
 )
 
 func RequestLoggerMiddleware() echo.MiddlewareFunc {
@@ -97,11 +98,13 @@ func appScopeLogger(
 	logger *logrus.Logger,
 	appName string,
 	envName string,
+	buildVersion string,
 ) *Logger {
 	entry := logger.WithFields(logrus.Fields{
-		"app":   appName,
-		"env":   envName,
-		"scope": "app",
+		"app":           appName,
+		"env":           envName,
+		"build_version": buildVersion,
+		"scope":         "app",
 	})
 	return &Logger{entry}
 }
@@ -114,10 +117,12 @@ func requestScopeLogger(
 	correlationID string,
 	appName string,
 	envName string,
+	buildVersion string,
 ) *Logger {
 	ctxLogger := logger.WithFields(logrus.Fields{
 		"app":            appName,
 		"env":            envName,
+		"build_version":  buildVersion,
 		"scope":          "request",
 		"correlation_id": correlationID,
 		"url":            r.RequestURI,