Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Document Monolog log formats #11144

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
Pierstoval opened this issue Mar 12, 2019 · 3 comments
Closed

Document Monolog log formats #11144

Pierstoval opened this issue Mar 12, 2019 · 3 comments

Comments

@Pierstoval
Copy link
Contributor

I've been asked to contribute to this here symfony/recipes#552 (comment) , I think it could be interesting to set this issue as an easy-pick.

The goal is to retrieve the log formats:
https://github.com/symfony/symfony/blob/18cd3420a44abbeacf96758daeb3ac7b8cf87f10/src/Symfony/Bridge/Monolog/Formatter/ConsoleFormatter.php#L50-L54

And add a small block in the "Channel handlers" documentation file explaining the possible ones.

WDYT?

@wouterj
Copy link
Member

wouterj commented Mar 12, 2019

I short of remember we once discussed this with @Seldaek and decided it's no use to document all handlers and their settings: It's very likely to get outdated.

So I'm against documenting all monolog handlers, but we can add a short section about handlers that are provided by Symfony.

@Pierstoval
Copy link
Contributor Author

I create the issue mostly because of the recipe that I linked that adds a message about text formatting in the console logs. IMO if such handler has at least an example in a recipe (which is official stuff), maybe it should be documented?

@javiereguiluz
Copy link
Member

I agree with Wouter, this is the kind of documentation that is hard to maintain and keep it in sync with the code (hopefully the code includes PHPdoc annotations to describe its functionality and config options).

Moreover, even if Monolog is closely related to Symfony, it's a third-party project, so its doc is out of the scope of Symfony Docs. Sorry! ... and thanks for understanding!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants