Updating logging docs

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Updating logging docs

Lee Trout
Hey gang,

I finally got past 1.5 and I'm finding so many nice features in 1.7. Thanks to everyone!

To my surprise logging had an overhaul from #21714 [0] and I found the documentation a bit confusing / lacking of details.

Theres an explanation of merging settings in https://docs.djangoproject.com/en/1.7/topics/logging/#configuring-logging but no description of what the defaults are.

Visiting https://docs.djangoproject.com/en/1.7/topics/logging/#django-s-default-logging-configuration doesn't offer any more help to understanding the technical details.

I'd like to see a mention of the defaults existing in `django.utils.log.DEFAULT_LOGGING` at a minimum. Given the desire to understand the entire technical scope I think it would be worth repeating the default settings in the default logging configuration heading at the bottom of the page (and toss a comment in django.utils.log that if it's updated remember to update the docs).

Thoughts?

Thanks & Happy New Year!
Lee


--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at http://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CAABi-DrSoyo%3D-eYe%2BQDJ4qjHuSH_CVLaSei90yTQAcWN_YyUPA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Updating logging docs

Daniele Procida-3
On Tue, Dec 30, 2014, Lee Trout <[hidden email]> wrote:

>I'd like to see a mention of the defaults existing in
>`django.utils.log.DEFAULT_LOGGING` *at a minimum*. Given the desire to
>understand the entire technical scope I think it would be worth repeating
>the default settings in the default logging configuration heading at the
>bottom of the page (and toss a comment in django.utils.log that if it's
>updated remember to update the docs).
>
>Thoughts?

I think that logging needs a proper step-by-step how-to, not more topic or reference documentation. That would make the existing documentation far more meaningful.

It's something I've been meaning to look at for a couple of years at least, but I'm not actually any closer to it.

Daniele

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at http://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/20141230191812.1826892749%40mail.wservices.ch.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Updating logging docs

Tim Graham-2
In reply to this post by Lee Trout
Definitely would be welcome. Perhaps these tickets cover at least some of your points:

https://code.djangoproject.com/ticket/23394 - Need documentation for merging the project's logging configuration with Django's defaults
https://code.djangoproject.com/ticket/23784 -
Error reporting docs needs to state clearly that changing logging conf error emails are not sent out unless configuring it again

I'll be happy to review anything you'd like to draft.

On Tuesday, December 30, 2014 2:12:38 PM UTC-5, Lee Trout wrote:
Hey gang,

I finally got past 1.5 and I'm finding so many nice features in 1.7. Thanks to everyone!

To my surprise logging had an overhaul from #21714 [0] and I found the documentation a bit confusing / lacking of details.

Theres an explanation of merging settings in <a href="https://docs.djangoproject.com/en/1.7/topics/logging/#configuring-logging" target="_blank" onmousedown="this.href='https://www.google.com/url?q\75https%3A%2F%2Fdocs.djangoproject.com%2Fen%2F1.7%2Ftopics%2Flogging%2F%23configuring-logging\46sa\75D\46sntz\0751\46usg\75AFQjCNHTYcJt0FTgvhla4yz7dlxGd2tEYQ';return true;" onclick="this.href='https://www.google.com/url?q\75https%3A%2F%2Fdocs.djangoproject.com%2Fen%2F1.7%2Ftopics%2Flogging%2F%23configuring-logging\46sa\75D\46sntz\0751\46usg\75AFQjCNHTYcJt0FTgvhla4yz7dlxGd2tEYQ';return true;">https://docs.djangoproject.com/en/1.7/topics/logging/#configuring-logging but no description of what the defaults are.

Visiting <a href="https://docs.djangoproject.com/en/1.7/topics/logging/#django-s-default-logging-configuration" target="_blank" onmousedown="this.href='https://www.google.com/url?q\75https%3A%2F%2Fdocs.djangoproject.com%2Fen%2F1.7%2Ftopics%2Flogging%2F%23django-s-default-logging-configuration\46sa\75D\46sntz\0751\46usg\75AFQjCNF5YJZzxbmOZ1sfG2nWzbUG2j4vBg';return true;" onclick="this.href='https://www.google.com/url?q\75https%3A%2F%2Fdocs.djangoproject.com%2Fen%2F1.7%2Ftopics%2Flogging%2F%23django-s-default-logging-configuration\46sa\75D\46sntz\0751\46usg\75AFQjCNF5YJZzxbmOZ1sfG2nWzbUG2j4vBg';return true;">https://docs.djangoproject.com/en/1.7/topics/logging/#django-s-default-logging-configuration doesn't offer any more help to understanding the technical details.

I'd like to see a mention of the defaults existing in `django.utils.log.DEFAULT_LOGGING` at a minimum. Given the desire to understand the entire technical scope I think it would be worth repeating the default settings in the default logging configuration heading at the bottom of the page (and toss a comment in django.utils.log that if it's updated remember to update the docs).

Thoughts?

Thanks & Happy New Year!
Lee


[0] <a href="https://code.djangoproject.com/ticket/21714" target="_blank" onmousedown="this.href='https://www.google.com/url?q\75https%3A%2F%2Fcode.djangoproject.com%2Fticket%2F21714\46sa\75D\46sntz\0751\46usg\75AFQjCNGSk4RWAKMTqps1rsgDbY-2NSLX4Q';return true;" onclick="this.href='https://www.google.com/url?q\75https%3A%2F%2Fcode.djangoproject.com%2Fticket%2F21714\46sa\75D\46sntz\0751\46usg\75AFQjCNGSk4RWAKMTqps1rsgDbY-2NSLX4Q';return true;">https://code.djangoproject.com/ticket/21714

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at http://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/964c1077-7283-449d-88ab-049be477d3a9%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.