api/v2: add path and method to API v2 logs #2261
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
simonpasquier
commented
May 18, 2020
| @@ -124,8 +124,6 @@ func NewAPI( | |||
| openAPI.SilenceGetSilencesHandler = silence_ops.GetSilencesHandlerFunc(api.getSilencesHandler) | |||
| openAPI.SilencePostSilencesHandler = silence_ops.PostSilencesHandlerFunc(api.postSilencesHandler) | |||
|
|
|||
| openAPI.Logger = func(s string, i ...interface{}) { level.Error(api.logger).Log(i...) } | |||
There was a problem hiding this comment.
After reading through the openapi code, it seems that it isn't used anywhere because we're not using *github.com/prometheus/alertmanager/api/v2/restapi.Server directly.
In any case the code here didn't work as expected, it should have been level.Error(api.logger).Log("msg", fmt.Sprintf(s, i...)).
api/v2/api.go
Outdated
| @@ -216,18 +214,20 @@ func (api *API) getAlertsHandler(params alert_ops.GetAlertsParams) middleware.Re | |||
| // are no alerts present | |||
| res = open_api_models.GettableAlerts{} | |||
| ctx = params.HTTPRequest.Context() | |||
|
|
|||
| logger = log.With(api.logger, "handler", "alerts", "methods", "GET") | |||
There was a problem hiding this comment.
do we have to hardcode those info?
There was a problem hiding this comment.
You could probably extract some of them from params.HTTPRequest.
There was a problem hiding this comment.
Thanks for the feedback! I've updated the code.
When an API v2 handler logged a message, the log wouldn't include the path and method. Since different handlers perform the same validations (e.g. matchers for alerts and silences), it isn't easy to know which handler was invoked (though the logged filename + line number provides a hint). Signed-off-by: Simon Pasquier <spasquie@redhat.com>
simonpasquier
force-pushed
the
add-handler-and-method-to-api-logs
branch
from
10e926f
to
2b845ab
Compare
simonpasquier
changed the title
mxinden
approved these changes
May 25, 2020
|
In prometheus/prometheus log |
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When an API v2 handler logged a message, the log wouldn't include the
path and method. Since different handlers perform the same
validations (e.g. matchers for alerts and silences), it isn't easy to
know which handler was invoked (though the logged filename + line number provides a hint).