go-kit/kit

transport/http ServerFinalizer should accept error for better logging support

Open

#807 opened on Dec 1, 2018

View on GitHub
 (14 comments) (2 reactions) (0 assignees)Go (27,422 stars) (2,446 forks)batch import
enhancementhelp wanted

Description

We have three systems where logs are sent: our internal ELK stack, NewRelic and Airbrake. Some of our endpoints send errors to all of this systems, some endpoints send errors to only one of it.

We want log entries to have both error message and http status code. And also some http request context (uri, method, user-agent, ip...)

The only place which has access to both error and http status is ServerErrorEncoder. But since different endpoints need different sets of log outputs, we would have to create multiple error encoders just for sake of logging. Also, ServerErrorEncoder is not a good place for logging, because we would like it to do only one job - encode errors.

ServerFinalizer seems to be a great place to send logs, but there is no access to actual error message.

Contributor guide

Tech stack
go
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programminggo kit basicsHTTP transport concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the `ServerFinalizer` type in `transport/http/server.go` to understand its current signature and usage. Review comments in the issue about logging in `ServerErrorEncoder`. The fix involves adding an `error` parameter to `ServerFinalizer` and updating all implementations. Look for any linked PRs or maintainer responses in the issue comments for additional context.