Skip to content
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

[logs] missing cookbook about logrotate #1161

Closed
brikou opened this issue Mar 16, 2012 · 11 comments
Closed

[logs] missing cookbook about logrotate #1161

brikou opened this issue Mar 16, 2012 · 11 comments
Labels
actionable Clear and specific issues ready for anyone to take them. hasPR A Pull Request has already been submitted for this issue. Logger

Comments

@brikou
Copy link
Contributor

brikou commented Mar 16, 2012

Configuring logrotate is maybe an off topic but it could be great to add a cookbook on how to configure logrotate to deal with logs (sometimes it can become huge)... Symfony needs more real cookbook about productions topics ;)

Cheer

@klaussilveira
Copy link
Contributor

Well, this depends on the focus that the documentation wants. If we document logrotate, we'll have to document other technologies involved with web applications in production.

Since there's already a cookbook about setting up Varnish, i don't think this is an issue. +1!

@Sgoettschkes
Copy link
Contributor

Any official comment for this one? I would write it, but of course only if there is a change it gets merged.

@weaverryan
Copy link
Member

Actually documenting something like logrotate I think is out of the scope of the documentation, though I'm not against mentioning something when it's useful.

However, monolog does have a RotatingFileHandler - talking about how to use this in a short article would be great. In fact, we really under-appreciate the monolog handlers I think - not that we should document them individually, but at least mentioning them - and the keys to use for each (with a link to the monolog docs) - would be a big step.

Thanks!

@ricardclau
Copy link
Contributor

+1 to this kind of documentation

@weaverryan
Copy link
Member

To be clear, the deliverable on this - in my opinion - would be to create a new cookbook article under "Logging" called "How to leverage Monolog handlers". In this document, we would mention every (or at least most) of the handlers in Monolog with a short description about what they do and a short quick example on how to use them.

@wouterj
Copy link
Member

wouterj commented Mar 29, 2013

@weaverryan that looks more like a reference, doesn't it? I think I prefer to put that in our references documentation.

@dbu
Copy link
Contributor

dbu commented Aug 25, 2014

it would not hurt to mention somewhere early in the doc that one needs to rotate the logs in app/logs/ - if people are not aware of that, they fill up their disk with logs... i don't think we need to document logrotate, but just mention it in the right place so people who have a clue notice the hint, and those who don't go look it up.

@javiereguiluz
Copy link
Member

As suggested by @weaverryan, there are two things to do:

  • Mention logrotate and the problem of the log file size: done in Added a note about log file sizes and the use of logrotate #5006 I've added this tip in the Cookbook because the Book doesn't really explain the log files anywhere, so it felt more natural to add it the cookbook.
  • We should decide if it's worth it to create a new Reference for Monolog Handlers. Opinions?

@wouterj
Copy link
Member

wouterj commented Feb 18, 2015

We should decide if it's worth it to create a new Reference for Monolog Handlers. Opinions?

This is now alreadyd ocumented in the API docs of Monolog. Besides this, we might want to move everything to the bundle docs: #4983

@javiereguiluz
Copy link
Member

@wouterj great! So after #5006 gets merged, this issue can be closed. Thanks.

@wouterj wouterj added the hasPR A Pull Request has already been submitted for this issue. label Feb 19, 2015
weaverryan added a commit that referenced this issue Mar 13, 2015
…e (javiereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Added a note about log file sizes and the use of logrotate

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | 2.3+
| Fixed tickets | #1161

Commits
-------

2d23a8d Linked "logrotate" to its official website
472c803 Minor rewording
b52d4af Added a note about log file sizes and the use of logrotate
@weaverryan
Copy link
Member

This can be closed technically.... though I'd love to see a note about rotating_file added in addition to #5006.

weaverryan added a commit that referenced this issue May 25, 2015
…aviereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Added a note about the rotating_file monolog handler

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | all
| Fixed tickets | #1161

Commits
-------

db1e798 Created a new section for rotating log files and explained the max_files configuration option
7345c17 Added XML and PHP configuration samples
31fd0db Added a note about the rotating_file monolog handler
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable Clear and specific issues ready for anyone to take them. hasPR A Pull Request has already been submitted for this issue. Logger
Projects
None yet
Development

No branches or pull requests

8 participants