fixes #342 add rfc option for syslogudp handler #343

gwinn · 2020-03-04T15:34:52Z

No description provided.

Tobion · 2020-03-09T15:29:28Z

DependencyInjection/Configuration.php

@@ -477,6 +478,7 @@ public function getConfigTreeBuilder()
                            ->scalarNode('title')->defaultNull()->end() // pushover
                            ->scalarNode('host')->defaultNull()->end() // syslogudp & hipchat
                            ->scalarNode('port')->defaultValue(514)->end() // syslogudp
+                            ->scalarNode('rfc')->defaultNull()->end() // syslogudp


should be an integerNode as SyslogUdpHandler constructor requires an int

also please add description and potential values like \Monolog\Handler\SyslogUdpHandler::RFC3164

Tobion · 2020-03-09T15:32:42Z

DependencyInjection/Configuration.php

@@ -157,6 +157,7 @@
 *   - [level]: level name or int value, defaults to DEBUG
 *   - [bubble]: bool, defaults to true
 *   - [ident]: string, defaults to
+ *   - [rfc]: string, defaults to


defaults to ...? it does not have a default. also it's an integer

It has, https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/SyslogUdpHandler.php#L47

But yes, it is not correct to describe it as string

gwinn · 2020-07-03T15:39:03Z

Can you review latest changes?

lyrixx

👍

DependencyInjection/Configuration.php

iyzoer · 2021-01-19T07:13:22Z

Hi! When can we expect a merge? This very important for me. It seems like nothing else prevents the merge.

HontoNoRoger · 2021-01-25T12:30:23Z

Also highly requested from my side, need it to select RFC5424e (time with miliseconds) for SyslogUDP logging.

dbrumann

It would be nice to have a test case in Tests/DependencyInjection/ConfigurationTest.php to see if the default is used when rfc is not set in config and another case for when an invalid number is picked.

dbrumann · 2021-01-25T13:58:24Z

DependencyInjection/Configuration.php

@@ -486,6 +488,10 @@ public function getConfigTreeBuilder()
                            ->scalarNode('title')->defaultNull()->end() // pushover
                            ->scalarNode('host')->defaultNull()->end() // syslogudp & hipchat
                            ->scalarNode('port')->defaultValue(514)->end() // syslogudp
+                            ->enumNode('rfc')
+                                ->values([SyslogUdpHandler::RFC5424, SyslogUdpHandler::RFC3164])


What about RFC5424e?

If we add this, we probably need to be careful, not to rely on the constant as UdpHandler in Monolog 1 does not support it

That's why i'm not sure about this RFC at this moment.
Should it be added at UdpHandler in Monolog 1? Or should it be added in some other place and imported alongside with SuslogUdpHandler for Monolog v1.x?

I am not sure how actively maintained v1 is, i.e. whether new features are accepted and if this is considered a new feature.

Both UdpHandler v1 and v2 will just ignore invalid values as far as I can tell. I think we can just allow users to put in whatever int they want, maybe add a comment for where to find the proper values (e.g. "see UdpHandler RFC-constants") and not bother with the constants at all. Not sure what others think about this, though.

edit: I just looked at the handlers again and it seems specifying an invalid int will at least trigger a notice about an illegal array offset, but I think that could be easily fixed using an array_key_exists()-check with a fallback.

Well, i think we should leave this story as is at this moment, we can add support for RFC5424e into another PR to speed up the acceptance of the current request

gwinn · 2021-02-01T17:12:20Z

It would be nice to have a test case in Tests/DependencyInjection/ConfigurationTest.php to see if the default is used when rfc is not set in config and another case for when an invalid number is picked.

Done

DependencyInjection/Configuration.php

DependencyInjection/MonologExtension.php

gwinn · 2021-03-25T10:23:38Z

Can I expect a review soon? It seems to me important and necessary to contribute to open source projects, especially if the proposed changes are needed not only by one developer, but, frankly, it is a little confusing how quickly the library development team considers proposals, this PR was created a year ago

jderusse · 2021-03-25T13:46:09Z

DependencyInjection/Configuration.php

@@ -486,6 +488,10 @@ public function getConfigTreeBuilder()
                            ->scalarNode('title')->defaultNull()->end() // pushover
                            ->scalarNode('host')->defaultNull()->end() // syslogudp & hipchat
                            ->scalarNode('port')->defaultValue(514)->end() // syslogudp
+                            ->enumNode('rfc')
+                                ->values([SyslogUdpHandler::RFC5424, SyslogUdpHandler::RFC3164])


using raw value (cf snippet bellow) would allow people to use the RFC, without triggering exception for composer 1

Suggested change

->values([SyslogUdpHandler::RFC5424, SyslogUdpHandler::RFC3164])

->values([SyslogUdpHandler::RFC5424, SyslogUdpHandler::RFC3164, 2 /* SyslogUdpHandler::RFC5424e */])

#343 (comment) here @Tobion suggest to not to use plain values, which point of view should I adhere to

It's always better to use constant, that's why @Tobion suggested to not use plain value when a constant exists.

In this case (and only for the value 2), we can not use constant, as the constant does not exist in monolog 1.
But we should not prevent people that use monolog 2 to use this value.
As a result, you should either remove this ENUM constraint and let people enter whatever they want, or allows this rfc by using a plain value.

Ok, i'll change it to scalarNode with default value

DependencyInjection/MonologExtension.php

jderusse

A last comment for my side ;-).

Don't forget to add an entry in the ChangeLog 🙏

DependencyInjection/MonologExtension.php

…ate ident field validation

Co-authored-by: Jérémy Derussé <jeremy@derusse.com>

gwinn · 2021-03-31T09:25:29Z

A last comment for my side ;-).

Don't forget to add an entry in the ChangeLog pray

done )

Tobion · 2021-04-21T22:06:19Z

DependencyInjection/Configuration.php

@@ -408,7 +410,7 @@ public function getConfigTreeBuilder()
                            ->booleanNode('use_locking')->defaultFalse()->end() // stream and rotating
                            ->scalarNode('filename_format')->defaultValue('{filename}-{date}')->end() //rotating
                            ->scalarNode('date_format')->defaultValue('Y-m-d')->end() //rotating
-                            ->scalarNode('ident')->defaultFalse()->end() // syslog and syslogudp
+                            ->scalarNode('ident')->defaultValue('php')->end() // syslog and syslogudp


This looks like a bc break. The https://github.com/Seldaek/monolog/blob/main/src/Monolog/Handler/SyslogHandler.php does not have 'php' as default value. So it used an empty string (casted from false) before.

But we talking about SyslogUdpHandler https://github.com/Seldaek/monolog/blob/main/src/Monolog/Handler/SyslogUdpHandler.php#L49

yes, but @Tobion is right here, this configuration is also used by both Syslog and SyslogUdp.
The change should keep compatibility with the 2 handlers.

Could you also please add a test to cover this case?

lyrixx approved these changes Mar 5, 2020

View reviewed changes

Tobion requested changes Mar 9, 2020

View reviewed changes

gwinn requested a review from Tobion March 9, 2020 16:07

lyrixx approved these changes Jul 6, 2020

View reviewed changes

Tobion requested changes Aug 15, 2020

View reviewed changes

DependencyInjection/Configuration.php Outdated Show resolved Hide resolved

DependencyInjection/Configuration.php Outdated Show resolved Hide resolved

Tobion mentioned this pull request Aug 15, 2020

SyslogUdpHandler - Allow setting "rfc" parameter #342

Open

gwinn force-pushed the master branch from 2481a71 to 648616f Compare January 13, 2021 11:03

gwinn requested review from Tobion and lyrixx January 13, 2021 11:16

dbrumann reviewed Jan 25, 2021

View reviewed changes

dbrumann approved these changes Jan 29, 2021

View reviewed changes

gwinn force-pushed the master branch 2 times, most recently from df1782a to c4393a5 Compare February 1, 2021 17:02

jderusse requested changes Mar 17, 2021

View reviewed changes

DependencyInjection/Configuration.php Outdated Show resolved Hide resolved

DependencyInjection/MonologExtension.php Show resolved Hide resolved

gwinn requested a review from jderusse March 25, 2021 09:54

jderusse requested changes Mar 25, 2021

View reviewed changes

gwinn force-pushed the master branch from dfeee20 to 0e5f93e Compare March 26, 2021 11:01

jderusse reviewed Mar 31, 2021

View reviewed changes

DependencyInjection/MonologExtension.php Outdated Show resolved Hide resolved

gwinn added 7 commits March 31, 2021 12:18

fixes symfony#342 add rfc option for syslogudp handler

041e932

update rfc check

040642a

update node type & parameter description

194b07e

make node is enum

b91d639

test for syslogudp configuration

68687b0

update test to check default value for rfc parameter

36191ef

fix intendation, check ident parameter emptiness

b6757e1

gwinn added 2 commits March 31, 2021 12:18

revert rfc field to scalar node (for SyslogUdpHandler::RFC5424e), upd…

4a21b0d

…ate ident field validation

update tests

5275fbd

gwinn force-pushed the master branch from 6e7e837 to 5275fbd Compare March 31, 2021 09:19

gwinn and others added 2 commits March 31, 2021 12:22

Update DependencyInjection/MonologExtension.php

ef995d2

Co-authored-by: Jérémy Derussé <jeremy@derusse.com>

update Changelog

0e3121d

update Changelog again, my bad :)

b8ae85a

jderusse approved these changes Mar 31, 2021

View reviewed changes

Tobion reviewed Apr 21, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fixes #342 add rfc option for syslogudp handler #343

fixes #342 add rfc option for syslogudp handler #343

gwinn commented Mar 4, 2020

Tobion Mar 9, 2020

Tobion Mar 9, 2020

Tobion Mar 9, 2020

gwinn Mar 9, 2020

gwinn commented Jul 3, 2020

lyrixx left a comment

iyzoer commented Jan 19, 2021

HontoNoRoger commented Jan 25, 2021

dbrumann left a comment

dbrumann Jan 25, 2021

gwinn Jan 28, 2021

dbrumann Jan 28, 2021 •

edited

gwinn Jan 29, 2021

gwinn commented Feb 1, 2021

gwinn commented Mar 25, 2021

jderusse Mar 25, 2021

gwinn Mar 26, 2021

jderusse Mar 26, 2021

gwinn Mar 26, 2021

jderusse left a comment

gwinn commented Mar 31, 2021

Tobion Apr 21, 2021

gwinn Apr 27, 2021

jderusse Apr 27, 2021

	->values([SyslogUdpHandler::RFC5424, SyslogUdpHandler::RFC3164])
	->values([SyslogUdpHandler::RFC5424, SyslogUdpHandler::RFC3164, 2 /* SyslogUdpHandler::RFC5424e */])

fixes #342 add rfc option for syslogudp handler #343

Are you sure you want to change the base?

fixes #342 add rfc option for syslogudp handler #343

Conversation

gwinn commented Mar 4, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gwinn commented Jul 3, 2020

lyrixx left a comment

Choose a reason for hiding this comment

iyzoer commented Jan 19, 2021

HontoNoRoger commented Jan 25, 2021

dbrumann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbrumann Jan 28, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gwinn commented Feb 1, 2021

gwinn commented Mar 25, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jderusse left a comment

Choose a reason for hiding this comment

gwinn commented Mar 31, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbrumann Jan 28, 2021 •

edited