Opened 2 years ago

Closed 2 years ago

Last modified 2 years ago

#30316 closed Cleanup/optimization (fixed)

Link to default logging dictConfig in documentation

Reported by: Andrew Badr Owned by: Ahisahar Pretel
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description (last modified by Eunwoo Cho)

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).

Change History (9)

comment:1 Changed 2 years ago by Andrew Badr

Easy pickings: set
Needs documentation: set

comment:2 Changed 2 years ago by Carlton Gibson

Component: UncategorizedDocumentation
Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization
Version: 2.2master

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 it, 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.

Last edited 2 years ago by Carlton Gibson (previous) (diff)

comment:3 Changed 2 years ago by Carlton Gibson

Summary: Include default logging dictConfig in documentationLink to default logging dictConfig in documentation

comment:4 Changed 2 years ago by Ahisahar Pretel

Owner: changed from nobody to Ahisahar Pretel
Status: newassigned

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.

comment:5 Changed 2 years ago by Eunwoo Cho

Description: modified (diff)

comment:6 Changed 2 years ago by Ahisahar Pretel

Has patch: set

comment:7 Changed 2 years ago by Nick Pope

Needs documentation: unset

comment:8 Changed 2 years ago by Mariusz Felisiak <felisiak.mariusz@…>

Resolution: fixed
Status: assignedclosed

In 717362d8:

Fixed #30316 -- Added source code link to the default logging configuration in logging docs.

comment:9 Changed 2 years ago by Mariusz Felisiak <felisiak.mariusz@…>

In f6febbc0:

[2.2.x] Fixed #30316 -- Added source code link to the default logging configuration in logging docs.

Backport of 717362d810955b9514e2ccd989f8a1647c9d7a00 from master

Note: See TracTickets for help on using tickets.
Back to Top