[Django] #30316: Include default logging dictConfig in documentation
Django
-----------------------------------------+------------------------
Reporter: Andrew Badr | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: 2.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
When people want to customize Django's logging, my guess is that they'll
most often want to start by changing something about the default logging
setup. Toward this end, it would be helpful if the Django dogs included a
dictConfig for the default logging setup. Instead, the docs *describe* the
default settings (https://docs.djangoproject.com/en/2.1/topics/logging
/#default-logging-configuration), and give dictConfigs for several other
possible configurations for logging
(https://docs.djangoproject.com/en/2.1/topics/logging/#configuring-
logging).
--
Ticket URL: <https://code.djangoproject.com/ticket/30316>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Andrew Badr | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: 2.2
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
-------------------------------+--------------------------------------
Changes (by Andrew Badr):
* needs_docs: 0 => 1
* easy: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/30316#comment:1>
Django
Reporter: Andrew Badr | Owner: nobody
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
--------------------------------------+------------------------------------
Changes (by Carlton Gibson):
* component: Uncategorized => Documentation
* version: 2.2 => master
* type: Uncategorized => Cleanup/optimization
* stage: Unreviewed => Accepted
Comment:
I don't think copying the full config would be great. There are already
lots of examples in the doc for people to use.
However... getting people to look at the source is always worth is so a
single line link to `django/utils/log.py` — ''"For Reference the default
logging config is defined in..."'' (See
a68c029e224cebe540da7447dbbd27993b4aa793 for `source` extlink examples.) —
would be good.
--
Ticket URL: <https://code.djangoproject.com/ticket/30316#comment:2>
Django
--------------------------------------+------------------------------------
Reporter: Andrew Badr | Owner: nobody
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
--------------------------------------+------------------------------------
--
Ticket URL: <https://code.djangoproject.com/ticket/30316#comment:3>
Django
-------------------------------------+-------------------------------------
Reporter: Andrew Badr | Owner: Ahisahar
Type: | Pretel
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by Ahisahar Pretel):
* status: new => assigned
* owner: nobody => Ahisahar Pretel
Comment:
Hi, this is my first easy picking fix. I will assign the issue to myself
and submit the PR this evening if that is ok.
--
Ticket URL: <https://code.djangoproject.com/ticket/30316#comment:4>
Django
-------------------------------------+-------------------------------------
Reporter: Andrew Badr | Owner: Ahisahar
Type: | Pretel
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Description changed by jonnung:
Old description:
> When people want to customize Django's logging, my guess is that they'll
> most often want to start by changing something about the default logging
> setup. Toward this end, it would be helpful if the Django dogs included a
> dictConfig for the default logging setup. Instead, the docs *describe*
> the default settings
> (https://docs.djangoproject.com/en/2.1/topics/logging/#default-logging-
> configuration), and give dictConfigs for several other possible
> configurations for logging
> (https://docs.djangoproject.com/en/2.1/topics/logging/#configuring-
> logging).
New description:
When people want to customize Django's logging, my guess is that they'll
most often want to start by changing something about the default logging
setup. Toward this end, it would be helpful if the Django docs included a
dictConfig for the default logging setup. Instead, the docs *describe* the
default settings (https://docs.djangoproject.com/en/2.1/topics/logging
/#default-logging-configuration), and give dictConfigs for several other
possible configurations for logging
(https://docs.djangoproject.com/en/2.1/topics/logging/#configuring-
logging).
--
--
Ticket URL: <https://code.djangoproject.com/ticket/30316#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: Andrew Badr | Owner: Ahisahar
Type: | Pretel
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by Ahisahar Pretel):
* has_patch: 0 => 1
Comment:
Patch link https://github.com/django/django/pull/11338
--
Ticket URL: <https://code.djangoproject.com/ticket/30316#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Andrew Badr | Owner: Ahisahar
Type: | Pretel
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* needs_docs: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/30316#comment:7>
Django
-------------------------------------+-------------------------------------
Reporter: Andrew Badr | Owner: Ahisahar
Type: | Pretel
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"717362d810955b9514e2ccd989f8a1647c9d7a00" 717362d8]:
{{{
#!CommitTicketReference repository=""
revision="717362d810955b9514e2ccd989f8a1647c9d7a00"
Fixed #30316 -- Added source code link to the default logging
configuration in logging docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/30316#comment:8>
Django
-------------------------------------+-------------------------------------
Reporter: Andrew Badr | Owner: Ahisahar
Type: | Pretel
Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"f6febbc078aed627ec937f7e56876dc208a5e339" f6febbc0]:
{{{
#!CommitTicketReference repository=""
revision="f6febbc078aed627ec937f7e56876dc208a5e339"
[2.2.x] Fixed #30316 -- Added source code link to the default logging
configuration in logging docs.
Backport of 717362d810955b9514e2ccd989f8a1647c9d7a00 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/30316#comment:9>