Structured logging support for zerolog

[stephanie-anderson]

With the addition of structured logging for sentry with #1010 we also want to also instrument the logging libraries that we already support:

https://pkg.go.dev/github.com/rs/zerolog / https://docs.sentry.io/platforms/go/guides/zerolog/

[giortzisg]

In addition to the problem of not being able to use Hook for the zerolog integration (since the zerolog.Event is write only), we also have an issue with the Writer interface, since we can't extract context from it. That would mean that for linking the trace with the log, the user would need to create a new Writer every time they want to log something, which seems pretty counter intuitive.

Not sure on what our approach should be. @AbhiPrasad @cleptric.

[AbhiPrasad]

This is even the case when someone uses the context integration? https://github.com/rs/zerolog?tab=readme-ov-file#contextcontext-integration

[giortzisg]

Yes, the context passed on the logger is available only for Hooks.

A solution that might work would be to wrap the zerolog logger with our own implementation that matches theirs and extend it with our own WithCtx that injects ctx to our own sentry logger.

[AbhiPrasad]

A solution that might work would be to wrap the zerolog logger with our own implementation that matches theirs and extend it with our own WithCtx that injects ctx to our own sentry logger.

yeah that sounds good. Let's try experimenting with that. Let's do that with an initial PR before implementing logs.

[giortzisg]

Had a try with it but it doesn't look that extendable. Zerolog also exposes their Event type, that provides many methods to set attributes on it, and we would need to wrap each and every single function and pass the context, on our own custom event, which would be a mess to maintain whenever the zerolog API changes, so I don't think we can follow this approach either.

[AbhiPrasad]

could we make the wrapping work if we used something like https://github.com/DataDog/orchestrion?