feat: improve logs when a context is canceled in the proxy

jvillafanez commented 6 days ago

Description

Improve the logs.

With the PR and a custom logger in the context:

{"level":"error","service":"proxy","remoteAddr":"10.0.2.28","request-id":"","proto":"HTTP/1.1","method":"GET","path":"/js/chunks/List-D8_SE_xL.mjs","query":"","fragment":"","error":"context canceled","time":"2024-11-19T10:07:22Z","message":"error happened in MultiHostReverseProxy"}

With the PR and without logger in the context:

{"level":"error","service":"proxy","error":"context canceled","time":"2024-11-19T09:44:35Z","message":"error happened in MultiHostReverseProxy"}

Without PR:

2024/05/14 06:52:39 http: proxy error: context canceled

Related Issue

No open issue

Motivation and Context

Logs, at the very least, should have the same format

How Has This Been Tested?

Some of the "context canceled" logs happen randomly. However, it common to reproduce it by uploading several images and close the browser tab right after the upload happens, before thumbnails are generated.

Screenshots (if appropriate):

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] Technical debt
[ ] Tests only (no source changes)

Checklist:

[x] Code changes
[ ] Unit tests added
[ ] Acceptance tests added
[ ] Documentation ticket raised:

Additional considerations:

We can move the context_logger into the ocis-pkg in order to use it in as many services as possible.
- The context logger should provide basic common log information on any request made.
- It's easily accessible through the context. Request-oriented methods (which have access to the request's context, or are expected to use the request's context) should use this logger instead of the logger attached to the object's instance.
- Each service can also chain another logger through a second middleware in order to include additional and more specific information from the request (such as specific headers the service might expect)
If we want to use the context, we should include a Ctx or FromContext method in our ocis-pkg log. This should help to remove the direct zerolog dependency.
We can also remove the context logger and use the service's logger instead. However, other than "context canceled" there is barely any useful information we can get from the log (as shown in the "With the PR and without logger in the context" example in the description)

update-docs[bot] commented 6 days ago

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.