Request-ID Tracing #118
Request-ID Tracing #118
Conversation
pkg/util/log/middleware.go
Outdated
| ) | ||
|
|
||
| const ( | ||
| KubernikusRequestID = "Kubernikus-Request-Id" |
There was a problem hiding this comment.
Quoting the golang docs for WithValue:
The provided key must be comparable and should not be of type string or any other built-in type to avoid collisions between packages using context. Users of WithValue should define their own types for keys. ...
There was a problem hiding this comment.
The original blog post about Context gives an example on how they suggest this should be used: https://blog.golang.org/context#TOC_3.2.
There was a problem hiding this comment.
Thanks, good tip. Much better...
| func RequestIDHandler(next http.Handler) http.Handler { | ||
| return http.HandlerFunc(func(rw http.ResponseWriter, request *http.Request) { | ||
| if id := request.Context().Value(KubernikusRequestID); id == nil { | ||
| request = request.WithContext(context.WithValue(request.Context(), KubernikusRequestID, uuid.NewV4())) |
There was a problem hiding this comment.
For my taste there we should have the world context in this line more often. ;)
There was a problem hiding this comment.
i resisted the temptation to make this wish come true ;)
pkg/util/log/middleware.go
Outdated
| return http.HandlerFunc(func(rw http.ResponseWriter, request *http.Request) { | ||
| wrapper := makeWrapper(rw) | ||
|
|
||
| id := fmt.Sprintf("%s", request.Context().Value(KubernikusRequestID)) | ||
| request = request.WithContext(context.WithValue(request.Context(), "logger", kitlog.With(logger, "id", id))) | ||
|
|
There was a problem hiding this comment.
I know it annoying to handle this but we should handle the case were the there is no kubernikus request id in the context (because the requestid middleware is disabled).
There was a problem hiding this comment.
I'm omitting the id key now if the context does not contain the requestId.
|
rebased and squashed |
This adds a middleware that generates a UUID on each incoming API request. For a poor-man's tracing this
idis passed as value in a request specific logger.