Docs confusing about what kind of integration / logging to use and how

[aleho]

Problem Statement

Trying to understand what this bundle does by reading the code I'm still not sure what kind of setup and integration I want for different types of projects.

There's:

• register_error_listener
• register_error_handler
• enable_logs
• ignore_exceptions
• Sentry\Monolog\Handler; Monolog handler sentry
• Sentry\SentryBundle\Monolog\LogsHandler; Monolog handler sentry_logs

Not even the recipe or reading the docs multiple times helps to clearly understand which setup results in which behavior. To make matters even worse, migrating to Symfony 8 and Monolog bundle 4, I think I managed to configure one of our applications running on FrankenPHP workers to build a huge memory leak resulting in segfaults.

Out of the box the error handler (whichever that is, I lost track) logs completely valid exceptions as errors. In Symfony it's totally normal to have a NotFoundHttpException or all the other 4xx being thrown which never is an actual exception, but our logs would be full of them without a big list of ignore_exception entries I have to maintain across projects. That's especially nice if you forgot for one project and some AI scaper goes wild and produces a ton of 404s or 403s, completely exhausting your monthly Sentry budget within minutes.

Solution Brainstorm

There should be more detailed documentation on the behavior of each configuration value and Monolog handler. E.e., an annotated full configuration example for both handlers.

It would also be helpful to understand when these handlers log. On shutdown? Monolog reset()? Do they even play nice with FrankenPHP or Symfony ResetInterface?

Apart from that, information on the amount of logging data being collected and sent and also the performance impact would be very much welcome. E.g., the amount of spans created in one of our apps has about 1000 times higher pressure on CPU and memory than any other code according to a profiling session in XDebug after a few requests in a FrankenPHP worker. This is absolutely not acceptable if you only want error logging but might be totally fine in an application where you have to monitor performance regressions.

[linear]

SYMFONY-39

[Litarnus]

Hi @aleho! Thanks for opening the issue. Since this issue contains multiple things, I'm going to try to group them.

Documentation

We have a documentation page for our configuration options located here: https://docs.sentry.io/platforms/php/guides/symfony/configuration/options/.
This is where we generally document available options for each SDK

It does not include register_error_listener or register_error_handler, which is something we can definitely improve.

Different Handlers

Sentry didn't have native logs support for most of it's time and the feature launched only a few months ago. To have some sort of Log-like behaviour, Sentry had different mechanisms such as Sentry\Monolog\Handler which would convert the configured log levels to Sentry errors so they can be viewed as issues. Sentry\SentryBundle\Monolog\LogsHandler is the handler that uses the Sentry Logs feature. Because of backwards compatibility, we kept both handlers although the first one is not that useful anymore.

Handling Valid Exceptions

We have issues to change the default behaviour or make it easier to ignore certain status codes: #957 and #958

FrankenPHP

The PHP SDKs currently don't work particularly well with FrankenPHP. We are aware that this is a limitation and we will address it in the near future. I unfortunately cannot give you an exact timeline for this.

Flush timings

We generally flush resources at the end of requests or commands to leverage fastcgi_finish_request. It is solved through EventListeners and not Symfony ResetInterface. This is an implementation detail and might change though, especially when trying to add first class support for FrankenPHP.

Amount of data collected

For the logging protocol, please have a look at the documentation. It also shows the default attributes that get collected for each log message. We will only collect data that was logged through monolog or directly using e.g. \Sentry\logger()->info('A simple log message');.

We offer a before_send_log callback which allows you to inspect, modify or reject every log item before it's sent to Sentry.

Performance & Benchmarks

I don't think that we can give meaningful performance impact metrics since it depends a lot on the application itself and what operations it performs. It all boils down to your application performing instrumented tasks such as DB Queries, HTTP Requests, cache operations, etc. The more of those things happen, the more the impact. If you're doing computation heavy tasks that are not instrumented, then the impact is low.
It also depends on your configuration options, such as tracing, sample_rate, etc. If your sample rate is low, then the impact will be lower since it will instrument fewer requests.

It would be great if you could provide us more details about your performance analysis so we can investigate this. It's perfectly fine if you're not comfortable sharing it though.

I hope I could clarify things for you and please let me know if I missed something important.

[peldax]

I completely agree.

We have been using Sentry with Laravel projects for some time and configuration is very simple and mostly out of the box. It includes traces and other various information.

For Symfony and Monolog I am lost on what to configure and where. The documentation is chaotic and distributed into too many pages. It would be very helpful if there was some complete configuration example for cases with and without Monolog with default values and annotations on what the setting actually does.

[Litarnus]

Hi @peldax! Can you provide some examples for which you would like to see configuration examples in the docs?
Also, can you tell me what you were trying to setup and what was distributed into too many pages?

As for what the settings do, you can look at the Options Page. Many options are shared between all PHP SDKs.

If you're thinking of particular settings that are not explained well enough, please send me the docs page or tell me which one you mean