Univention Bugzilla – Bug 56826
Provide reference about log files in UCS
Last modified: 2023-11-16 09:06:22 CET
Add a reference about relevant log files in UCS and provide links to the respective section talking about the service. As an administrator I want to quickly find the log file that I need to consult to find logging information about a specific service to troubleshot a problem I have. The reference summary should include the following information: * Path and filename * What service uses that log file * How to change the log level for that file * Links to the sections that describe or mention the log file
In the past, the developers talked about this - for developers. In each "project" (can be a package or repo) there should be a README with the information needed to maintain the project. That includes the log files it generates. Unfortunately, this has not become the norm. I like the idea of having central documentation for operators to search for log files and log settings. But a centralized structure is not good for developers to keep updated. 1. Software changes in one repository, and the documentation is in another repo. 2. New software is created every week. Developers have to remember about this separate docu repo. Could we have something like the following? A template (.rst, .json or .py file) exists in each git repo, possibly in subdirectories (Debian packages). The path to it is included in the repo for this documentation. The CI collects the files and assembles the doc. The template contains a table/structure with the information required (path, service, log level, further docs). Problem with the idea: Again the link to this template must be added manually to the central place. It would be nicer if that could be done automagically from the CI in the source repos.