[HttpKernel] Add support for configuring log level, and status code by exception class #42244

lyrixx · 2021-07-23T14:50:04Z

Q	A
Branch?	5.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Fix #38901
License	MIT
Doc PR

Usage:

# config/packages/framework.yaml
framework:
    exceptions:
        Symfony\Component\HttpKernel\Exception\BadRequestHttpException:
            log_level: debug
            status_code: 422

Nyholm

Thank you for this PR.

I think @derrabus made some really good arguments in #38901 (comment)

I agree that updating logging level should be simpler.
I recognise that this is highly dependent on your app. (Think website vs API vs internal API)
Im not sure this is the best way forward. I appriciate the work and I realise it is not like me to ask for more discussion before merging a PR, but this time I would like to do that anyways.

On the top of my head (not sure if it is good or bad, I just want to start thinking on alternative solutions). What if made some better integration with an "exception handler"? Ie create an AbstractErrorListener base class and let the default ErrorHandler extend from it. Now we can add config for "default error listener" and use normal PHP logic to decide what do do when an exception is called.

hm..

src/Symfony/Component/HttpKernel/EventListener/ErrorListener.php

Nyholm · 2021-07-24T06:25:17Z

src/Symfony/Component/HttpKernel/EventListener/ErrorListener.php

+        foreach ($this->exceptionsMapping  as $exception => $config) {
+            if ($throwable instanceof $exception && $config['status_code']) {
+                $response->setStatusCode($config['status_code']);
+                break;


This means that the order you define the exceptions in your config is important. I don't mind, but this should be documented.

lyrixx · 2021-07-26T08:57:23Z

@Nyholm yeah, I agree with @derrabus comment. That's why I did not change the current Symfony behavior.

But now, everything is configurable, that's what many people want.

About a solution in pure PHP to decide or not... I'm not really convinced. The solution I propose fit my needs and is simple to use. Do you have real use case where it does not fit and you would need PHP to configure it?

lyrixx · 2021-09-01T09:44:37Z

@Nyholm I have fixed your comments, thanks.

I think the PR is ready now

lyrixx · 2021-09-22T08:47:02Z

Hello @symfony/mergers

The initial issue got 8 👍🏼, 4 ❤️ and, this PR got 5 ❤️ and @dunglas commented "A big +1 on my side." on the issue.

So without feedback, I'm planning to merge this PR by the end of the month, before the feature freeze.
If you are against it, it's time to raise your voice :)

fabpot

Can you start documenting this in docs?

…y exception class

fabpot · 2021-09-29T13:41:13Z

Thank you @lyrixx.

lyrixx · 2021-09-29T13:56:52Z

Can you start documenting this in docs?

I'll do that ASAP :)

apfelbox · 2021-09-29T14:07:15Z

It would have been nice to have system in place, to convert these exceptions in code, instead of just config. This way it might be possible to log for example a request to /missing/url as error, while /favicon.ico is not logged at all.

This way it's all or nothing.

JohJohan · 2021-10-11T17:18:49Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

+                                ->info('The status code of the response. Null to let Symfony decide.')
+                                ->validate()
+                                    ->ifTrue(function ($v) { return !\in_array($v, range(100, 499)); })
+                                    ->thenInvalid('The log level is not valid. Pick one among between 100 et 599.')


I think the invalid message is inconsistent with the check range(100, 499) while invalid message contains text like 100 et 599

Can you please send a PR? Let's also replace this range() by two comparisons.

Check see: #43399

…e to compare (JohJohan) This PR was merged into the 5.4 branch. Discussion ---------- [HttpKernel] Fix incorrect invalid message and change range to compare | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | | License | MIT | Doc PR | Fix invlid config message and change range to two comparisons #42244 (comment) Commits ------- e5a7f83 [HttpKernel] Fix incorrect invalid message and change range to compare

theofidry · 2021-11-03T05:27:50Z

src/Symfony/Component/HttpKernel/EventListener/ErrorListener.php


            throw $e;
        }

+        foreach ($this->exceptionsMapping as $exception => $config) {
+            if ($throwable instanceof $exception && $config['status_code']) {
+                $response->setStatusCode($config['status_code']);


does this work? The response is rendered L71 before this happens so whilst the response will have the correct status code the page rendered may not be matching. For example the ErrorController will render a page for a 500 although the status code will be altered here

I don't undestant. The status code you write in the configuration is the one you want.
It is not used to "match" something. It overrides the current value.

It overrides the current value

Of the created response.

In the case you are dealing with an API, you probably do not care. However, if you are dealing with an HTML response, then you probably have a different template if it's a 400 or a 500. From what I see here although you override the status code from a 500 to a 400 for example, the rendered page would still look like you had a 500 (and with the default template it shows the status code, i.e. 500).

We might need to update HtmlErrorRenderer to take this new exceptions mapping into account.

gnutix · 2022-02-16T12:12:36Z

@lyrixx Is there any plan for this feature to cover errors handled in ErrorHandler ? In our app, because of huge exports of data, we may have either OutOfMemoryError or FatalError (with a message containing "Maximum execution", that represents timeouts) that we don't want to see logged with a "critical" level and have dedicated HTTP status codes (507 for OutOfMemory and 504 for timeouts). But using this mapping in the configuration for OutOfMemoryError doesn't change the criticality of the logged Fatal Error and I don't see how I could filter the FatalError only with the custom message.

theofidry · 2022-02-16T13:01:36Z

For what it's worth I did try to fix the issue found in #42244 (comment) but could not. I can't say I'm too happy about it because it means the feature really doesn't work as advertised. But given the lack of solution the best that may be done at this point is to document it.

yceruto · 2022-02-16T17:45:02Z

@theofidry FYI this feature was adjusted here #44649, so your previous comment about the status code for HTML response/page should be ok now

theofidry · 2022-02-16T18:43:14Z

wow cool, thanks for the notif

razvanalin · 2024-01-05T11:18:26Z

I'm testing a feature to log the Cars\Exceptions\CarsNotFoundException exception as an info message with a 404 status code, but it's not working as expected.

This is my framework exception configuration:

framework:
    exceptions:
        Cars\Exceptions\CarsNotFoundException:
            log_level: info
            status_code: 404

However, the logger is marking it as CRITICAL:

[2024-01-05T11:51:44.155556+01:00] php.CRITICAL: Uncaught Exception: Not found car with id 9991057X1 {"exception":"[object] (Symfony\\Component\\HttpKernel\\Exception\\HttpException(code: 0): Not found car with id 9991057X1 at /var/www/code/Cars/vendor/symfony/http-kernel/EventListener/ErrorListener.php:70)\n[previous exception] [object] (Cars\\Exceptions\\CarsNotFoundException(code: 404): Not found cars with id 9991057X1"} []

I want to configure the exception to log as info with a 404 status code. Currently, my code throws Cars\Exceptions\CarsNotFoundException, and the kernel.exception listener changes it to Symfony\Component\HttpKernel\Exception\HttpException. I don't want to log all HttpException instances as info, only the CarsNotFoundException

framework:
    exceptions:
        Cars\Exceptions\CarsNotFoundException:
            log_level: info
            status_code: 404
        Symfony\Component\HttpKernel\Exception\HttpException:
            log_level: info
            status_code: 404

Can I achieve this without changing HttpException ?

Thank you.

OskarStark · 2024-01-05T12:42:39Z

Please open a new issue with the problem and add a reference to this PR, thanks

carsonbot added Status: Needs Review Feature HttpKernel labels Jul 23, 2021

lyrixx changed the title ~~[HttpKernel] Add support for configuration log, logLevel, and status code by exception classx~~ [HttpKernel] Add support for configuration log, logLevel, and status code by exception class Jul 23, 2021

lyrixx force-pushed the log-and-exception branch from aec873b to 3d3d7b1 Compare July 23, 2021 15:47

lyrixx changed the title ~~[HttpKernel] Add support for configuration log, logLevel, and status code by exception class~~ [HttpKernel] Add support for configuring log level, and status code by exception class Jul 23, 2021

lyrixx force-pushed the log-and-exception branch 2 times, most recently from 06aec50 to b564507 Compare July 23, 2021 16:07

Nyholm reviewed Jul 24, 2021

View reviewed changes

chalasr added this to the 5.4 milestone Aug 6, 2021

lyrixx force-pushed the log-and-exception branch from b564507 to 3b1cf07 Compare September 1, 2021 09:44

lyrixx force-pushed the log-and-exception branch from 3b1cf07 to f377e39 Compare September 1, 2021 15:24

lyrixx requested review from chalasr, dunglas, fabpot and nicolas-grekas September 9, 2021 08:15

fabpot approved these changes Sep 29, 2021

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 29, 2021

[HttpKernel] Add support for configuring log level, and status code b…

94c4de3

…y exception class

fabpot force-pushed the log-and-exception branch from f377e39 to 94c4de3 Compare September 29, 2021 13:41

fabpot mentioned this pull request Sep 29, 2021

[HttpKernel] Add support for configuring log level, and status code by … symfony/symfony-docs#15874

Closed

fabpot merged commit e026dc5 into symfony:5.4 Sep 29, 2021

lyrixx deleted the log-and-exception branch September 29, 2021 13:56

g105b mentioned this pull request Sep 30, 2021

Set HTTP error code per exception in config phpgt/WebEngine#470

Open

JohJohan reviewed Oct 11, 2021

View reviewed changes

JohJohan mentioned this pull request Oct 11, 2021

[HttpKernel] Fix incorrect invalid message and change range to compare #43399

Merged

theofidry reviewed Nov 3, 2021

View reviewed changes

This was referenced Nov 5, 2021

Release v5.4.0-BETA1 #43937

Merged

Release v6.0.0-BETA1 #43939

Merged

micheh mentioned this pull request Dec 3, 2021

[HttpKernel] Wrong template is rendered when configuring an exception status code #44433

Closed

MatTheCat mentioned this pull request Nov 14, 2022

[FrameworkBundle] Configuring framework exceptions does not work with config builders #48191

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HttpKernel] Add support for configuring log level, and status code by exception class #42244

[HttpKernel] Add support for configuring log level, and status code by exception class #42244

lyrixx commented Jul 23, 2021 •

edited

Loading

Nyholm left a comment

Nyholm Jul 24, 2021

lyrixx commented Jul 26, 2021

lyrixx commented Sep 1, 2021

lyrixx commented Sep 22, 2021

fabpot left a comment

fabpot commented Sep 29, 2021

lyrixx commented Sep 29, 2021

apfelbox commented Sep 29, 2021

JohJohan Oct 11, 2021

nicolas-grekas Oct 11, 2021

JohJohan Oct 11, 2021

theofidry Nov 3, 2021

lyrixx Nov 8, 2021

theofidry Nov 8, 2021 •

edited

Loading

yceruto Nov 8, 2021 •

edited

Loading

gnutix commented Feb 16, 2022

theofidry commented Feb 16, 2022

yceruto commented Feb 16, 2022 •

edited

Loading

theofidry commented Feb 16, 2022

razvanalin commented Jan 5, 2024 •

edited

Loading

OskarStark commented Jan 5, 2024

[HttpKernel] Add support for configuring log level, and status code by exception class #42244

[HttpKernel] Add support for configuring log level, and status code by exception class #42244

Conversation

lyrixx commented Jul 23, 2021 • edited Loading

Nyholm left a comment

Choose a reason for hiding this comment

Nyholm Jul 24, 2021

Choose a reason for hiding this comment

lyrixx commented Jul 26, 2021

lyrixx commented Sep 1, 2021

lyrixx commented Sep 22, 2021

fabpot left a comment

Choose a reason for hiding this comment

fabpot commented Sep 29, 2021

lyrixx commented Sep 29, 2021

apfelbox commented Sep 29, 2021

JohJohan Oct 11, 2021

Choose a reason for hiding this comment

nicolas-grekas Oct 11, 2021

Choose a reason for hiding this comment

JohJohan Oct 11, 2021

Choose a reason for hiding this comment

theofidry Nov 3, 2021

Choose a reason for hiding this comment

lyrixx Nov 8, 2021

Choose a reason for hiding this comment

theofidry Nov 8, 2021 • edited Loading

Choose a reason for hiding this comment

yceruto Nov 8, 2021 • edited Loading

Choose a reason for hiding this comment

gnutix commented Feb 16, 2022

theofidry commented Feb 16, 2022

yceruto commented Feb 16, 2022 • edited Loading

theofidry commented Feb 16, 2022

razvanalin commented Jan 5, 2024 • edited Loading

OskarStark commented Jan 5, 2024

lyrixx commented Jul 23, 2021 •

edited

Loading

theofidry Nov 8, 2021 •

edited

Loading

yceruto Nov 8, 2021 •

edited

Loading

yceruto commented Feb 16, 2022 •

edited

Loading

razvanalin commented Jan 5, 2024 •

edited

Loading