Fix caller in logs

[schuellerf]

@lzap based on your #1174 I'd like to add the fix to show the correct caller (for the cases using echo_logrus.go)
I'd keep this as draft until yours is merged

Do you think this makes sense?

example log message is (just added some newlines for readabililaty)
before:

backend-1            | time="2024-05-07T09:08:36Z" level=error msg="RHEL entitlement not present in identity header"
func="github.com/osbuild/image-builder/internal/common.(*EchoLogrusLogger).Error"
file="/go/src/github.com/osbuild/image-builder/internal/common/echo_logrus.go:153"
distribution=centos-9 insights_id=eIBJqJJqkaz7 method=GET path="/api/image-builder/v1/architectures/:distribution" request_id=FbaXzyS1epxn

after:

backend-1            | time="2024-05-07T09:12:52Z" level=error msg="RHEL entitlement not present in identity header"
func="github.com/osbuild/image-builder/internal/v1.(*Identity).IsEntitled"
file="/go/src/github.com/osbuild/image-builder/internal/v1/server_identity.go:76"
distribution=centos-9 insights_id=XMckxfNStVNf method=GET path="/api/image-builder/v1/architectures/:distribution" request_id=yIP6lO4O6wmG

[schuellerf]

I'm not the golang expert - is this safe to return this pointer?
although the implementation of logrus does the same - it feels bad :-|

[lzap]

It is a good practice not to export context key types and values so other packages cannot modify the values. Here it is a mix - you export the value but not the type.

[lzap]

Yeah I noticed this as well. Tho the implementation seems fragile, creating a context value per request is fine, but per log entry? There can be many log entries per request, this could get out of control. Cannot you modify the caller on the fly directly? Or even better - turn off automatic caller adding and implement your own hook that will consider this wrapper instead.

Whatever you do, please make a unit test for this, do some logging directly through logrus as well as through the echo facade to ensure consistency.

[schuellerf]

Note: related implementation: osbuild/osbuild-composer#4132

[github-actions]

This PR is stale because it has been open 30 days with no activity. Remove "Stale" label or comment or this will be closed in 7 days.