How can we add monolog context to Sentry

[devnix]

Core or SDK?

Platform/SDK

Which part? Which one?

sentry/sentry-symfony package

Description

In the Symfony integration guide there is some documentation to integrate it with Monolog: https://docs.sentry.io/platforms/php/guides/symfony/

I'm going crazy between closed issues and non-working examples for old versions of the SDK to send a message with Monolog, adding the message's own context, for example:

$this->logger->error('Unexpected entity state.', ['state' => $state, 'entity' => $entity]);

Suggested Solution

Add a definitive documentation for current version to add the capacity to log Monolog's message context to Sentry's log

[imatwawana]

@stayallive is this something you can help with?

[getsentry-release]

Routing to @getsentry/team-webplatform for triage. ⏲️

[stayallive]

@Jean85 / @ste93cry since this is partly Symfony specific are you able to get me some info about how this should work or what should be explained (or maybe even PR this to the docs yourselfs) so we can document this?

[Jean85]

The point is that by default (and by design as said in ) we do not copy context from Monolog in the base SDK. So we need a basic example for the PHP SDK first, and the we can add on top how to fit that in a Symfony app.

I don't recall exactly what you need to do for the first step, but ping me for the second one.

[stayallive]

@Jean85 you mean just like this: https://docs.sentry.io/platforms/php/enriching-events/context/ or referring to Monolog specifically or are they the same?

[Jean85]

Yes I meant specific code related to Monolog.

Ok I've dug a bit here and there, and here's what I've found:

• there's a 3rd party package to do it with the older SDK: https://github.com/B-Galati/monolog-sentry-handler but it only adds the exception if found in the context: https://github.com/B-Galati/monolog-sentry-handler/blob/6e34b9e2ad4e196bd2cfe54187b795fea3060e05/src/SentryHandler.php#L97-L99
• This originated the package: add: breadcrumbs to monolog handler sentry-php#844
• This is the PR where we shut down the idea of parsing extra by default: Process args in "extra" key of recorded message sentry-php#848
• You already wrote it for Laravel! https://github.com/getsentry/sentry-laravel/blob/master/src/Sentry/Laravel/SentryHandler.php

So... Seeing such high demand, IMHO we could revisit this issue and add the implementation in the SDK, but NOT use it by default. At a first glance, your Laravel seems framework agnostic, so we could simply port it in the base SDK (along with tests) and make it optional; at that point, it would be straightforward to make it a configuration option in the Symfony bundle too.

WDYT @ste93cry?

[ste93cry]

it only adds the exception if found in the context

We do the same, the exception key is reserved by Monolog so it's one of the few things we can consider safe

so we could simply port it in the base SDK (along with tests) and make it optional

I'm not strongly opposed to this, but I also think that we had good reasons in the past to deny implementing this out-of-the-box. Moreover, it was @untitaker the first one to suggest that there were similar issues in the Python SDK that led to the decision of not going forward with such feature request. From what I saw in the past, the problem is mainly lack of knowledge about how to implement this on your own (well, it's actually quite simple so I'm not sure what's the issue here) or the laziness of the people in doing it. At the same time, there is clearly an high demand for supporting this. I think that:

• Documenting how to implement this would be a great improvement
• Making this feature available out of the box makes no sense to me, mainly because as already said here and there blindly copying the data from the logger context to Sentry extras to me is pontless