element-hq / element-hq/synapse
User-facing documentation on configuring logging
Open
A-Docs
Z-Help-Wanted
z-p3
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 600
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 51
Description
This issue has been migrated from [#8922](https://github.com/matrix-org/synapse/issues/8922).
---
The the document we currently link to (docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema) isn't particularly user-friendly, especially to people unfamiliar with python. It also talks about "configuration dictionaries" in the abstract, rather than dealing specifically with yaml configuration files, so some of the examples are misleading. It would be good to provide better user-facing documentation of how to configure logging.
Split out of #7125
Contributor guide
Assessment
This issue has not been assessed yet.