Skip to content

Remove an unneeded logging article #8770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

Remove an unneeded logging article #8770

wants to merge 5 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Nov 29, 2017

This is related to #8684. Sorry for the spelling error in the commit, didn't had my coffee yet ;)

@ghost
Copy link
Author

ghost commented Nov 29, 2017

Build failure is unrelated to this PR. This has been fixed in #8772.

@xabbuh
Copy link
Member

xabbuh commented Nov 30, 2017

This looks good. Can you also add an entry to the redirection map?

@xabbuh xabbuh added this to the 4.0 milestone Nov 30, 2017
Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea, but I'm not sure about the proposal. This is a very unimportant option. It doesn't deserve an entire section in my opinion. What if we just add a very short mention to it in this reference: https://symfony.com/doc/current/reference/configuration/monolog.html ?

@weaverryan
Copy link
Member

Yea, I agree. We just need to add use_microseconds to the "Full Default configuration" with maybe one line of # comments above it to give a short description. That would actually be AWESOME

@ghost
Copy link
Author

ghost commented Dec 1, 2017

I am unsure about the comments. They are long right now, and that is the incorrect way according to the feedback @weaverryan gave in #8770 (comment). See commit 4b3ed43 about the changes.

I'd love to get better comment texts to include instead of these long lines cluttering the article since this is such a small change.

datetime field of the log messages from
microsecond to second. Avoiding a call to the
microtime(true) function and the subsequent parsing. -->
<monolog:config use-microseconds="true">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to put the comments in XML also. We typically just put the comments in YAML - it's the most visible and avoids duplication :)

# the precision in the datetime field of the log messages from
# microsecond to second. Avoiding a call to the microtime(true)
# function and the subsequent parsing.
use_microseconds: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree! This is a little long :). How about:

Set to false to use seconds (instead of microseconds) in the logs (gives a small performance boost)

Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ricknox thanks for this contribution and for your patience during the review process.

@ghost
Copy link
Author

ghost commented Dec 4, 2017

@javiereguiluz No problem. It is good that we all pay attention so that the quality of the documentation remains high.

@weaverryan
Copy link
Member

Great improvement! Thank you Ricardo!

@weaverryan weaverryan closed this in fd6e762 Dec 5, 2017
@ghost ghost deleted the docfix/logging branch December 5, 2017 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants