Improve request logger middleware.

* Add "from" key with client IP
* Only log controller and action in "started" log
* Use controller name instead of resource name

Author: raphael

context.go

@@ -12,6 +12,8 @@ import (
 const (
 	reqKey key = iota + 1
 	respKey
+	ctrlKey
+	actionKey
 	paramsKey
 	logKey
 	logContextKey
@@ -58,11 +60,32 @@ func NewContext(ctx context.Context, rw http.ResponseWriter, req *http.Request,
 	return ctx
 }
 
+// ActionContext creates a context with the given action name.
+func ActionContext(ctx context.Context, action string) context.Context {
+	return context.WithValue(ctx, actionKey, action)
+}
+
 // UseLogger sets the request context logger and returns the resulting new context.
 func UseLogger(ctx context.Context, logger Logger) context.Context {
 	return context.WithValue(ctx, logKey, logger)
 }
 
+// ContextController extracts the controller name from the given context.
+func ContextController(ctx context.Context) string {
+	if c := ctx.Value(ctrlKey); c != nil {
+		return c.(string)
+	}
+	return "<unknown>"
+}
+
+// ContextAction extracts the action name from the given context.
+func ContextAction(ctx context.Context) string {
+	if a := ctx.Value(actionKey); a != nil {
+		return a.(string)
+	}
+	return "<unknown>"
+}
+
 // ContextRequest extracts the request data from the given context.
 func ContextRequest(ctx context.Context) *RequestData {
 	if r := ctx.Value(reqKey); r != nil {

goagen/gen_main/generator.go

@@ -260,7 +260,7 @@ type {{ $ctrlName }} struct {
 
 // New{{ $ctrlName }} creates a {{ .Name }} controller.
 func New{{ $ctrlName }}(service *goa.Service) *{{ $ctrlName }} {
-	return &{{ $ctrlName }}{Controller: service.NewController("{{ .Name }}")}
+	return &{{ $ctrlName }}{Controller: service.NewController("{{ $ctrlName }}")}
 }
 `
 

middleware/log_request.go

@@ -5,6 +5,7 @@ import (
 	"encoding/base64"
 	"encoding/json"
 	"io"
+	"net"
 	"net/http"
 	"strings"
 	"time"
@@ -28,7 +29,8 @@ func LogRequest(verbose bool) goa.Middleware {
 			ctx = goa.LogWith(ctx, "req_id", reqID)
 			startedAt := time.Now()
 			r := goa.ContextRequest(ctx)
-			goa.LogInfo(ctx, "started", r.Method, r.URL.String())
+			goa.LogInfo(ctx, "started", r.Method, r.URL.String(), "from", from(req),
+				"ctrl", goa.ContextController(ctx), "action", goa.ContextAction(ctx))
 			if verbose {
 				if len(r.Params) > 0 {
 					logCtx := make([]interface{}, 2*len(r.Params))
@@ -76,3 +78,16 @@ func shortID() string {
 	io.ReadFull(rand.Reader, b)
 	return base64.StdEncoding.EncodeToString(b)
 }
+
+// from makes a best effort to compute the request client IP.
+func from(req *http.Request) string {
+	if f := req.Header.Get("X-Forwarded-For"); f != "" {
+		return f
+	}
+	f := req.RemoteAddr
+	ip, _, err := net.SplitHostPort(f)
+	if err != nil {
+		return f
+	}
+	return ip
+}

middleware/log_request_test.go

@@ -45,7 +45,7 @@ var _ = Describe("LogRequest", func() {
 		Ω(lg(ctx, rw, req)).ShouldNot(HaveOccurred())
 		Ω(logger.InfoEntries).Should(HaveLen(4))
 
-		Ω(logger.InfoEntries[0].Data).Should(HaveLen(4))
+		Ω(logger.InfoEntries[0].Data).Should(HaveLen(10))
 		Ω(logger.InfoEntries[0].Data[0]).Should(Equal("req_id"))
 		Ω(logger.InfoEntries[0].Data[2]).Should(Equal("POST"))
 		Ω(logger.InfoEntries[0].Data[3]).Should(Equal("/goo?param=value"))

service.go

@@ -148,11 +148,11 @@ func (service *Service) ListenAndServeTLS(addr, certFile, keyFile string) error
 
 // NewController returns a controller for the given resource. This method is mainly intended for
 // use by the generated code. User code shouldn't have to call it directly.
-func (service *Service) NewController(resName string) *Controller {
+func (service *Service) NewController(name string) *Controller {
 	return &Controller{
-		Name:    resName,
+		Name:    name,
 		Service: service,
-		Context: context.WithValue(service.Context, "ctrl", resName),
+		Context: context.WithValue(service.Context, ctrlKey, name),
 	}
 }
 
@@ -269,10 +269,9 @@ func (ctrl *Controller) MuxHandler(name string, hdlr Handler, unm Unmarshaler) M
 	for i := range chain {
 		middleware = chain[ml-i-1](middleware)
 	}
-	baseCtx := LogWith(ctrl.Context, "ctrl", ctrl.Name, "action", name)
 	return func(rw http.ResponseWriter, req *http.Request, params url.Values) {
 		// Build context
-		ctx := NewContext(baseCtx, rw, req, params)
+		ctx := NewContext(ActionContext(ctrl.Context, name), rw, req, params)
 
 		// Protect against request bodies with unreasonable length
 		if MaxRequestBodyLength > 0 {