diff --git a/.gitlab/issue_templates/bug_report.md b/.gitlab/issue_templates/bug_report.md index be390e35b5ae3b2e4b719fe5ea304fa200fcbb69..38313e83809f2eeea0ecd311063e71531b917fb9 100644 --- a/.gitlab/issue_templates/bug_report.md +++ b/.gitlab/issue_templates/bug_report.md @@ -1,24 +1,26 @@ -🎉 Thank you for reporting this! +🎉 Thank you for reporting this! -**Version number of controlcenter** +Please fill the info below, skipping when not available. -Please state version here (found via the "i" info button top right of Web UI) +**Version number of Lightmeter** -Version: +Please state version here (found via the "i" info button top right of Web UI) or by running Lightmeter with `-version`: + +Version: **Postfix version** Use `postconf mail_version` to get postfix version -Version: +Version: **Golang version** -Note: needed only if you build Lightmeter Control Center yourself. +In case you have built Lightmeter yourself. Use `go version` to get golang version -Version: +Version: **Docker version** @@ -26,30 +28,23 @@ Note: "if you use docker then please add the version information" Use `docker version` to get docker version -Version: - -**Sqlite version** +Version: -Use this snippet to extract the version information from your DB files +**Which Operating System and version are you using?** -``` -for f in /path/to/workspace/*.db; do - echo "Filename: $f" - sqlite3 "$f" '.dbinfo' - done -``` +OS: -Version: +Version: **Attach logs** -Consider attaching relevant mail logs to this issue - you can safely remove private data from them (email addresses, hostnames, IPs, etc) +Please consider attaching relevant mail logs to this issue - you can safely remove private data from them (email addresses, hostnames, IPs, etc) using the [`tools/batch_log_cleaner.py`] script in this repository. That creates clean log copies without modifying your source logs. You can run it like this: ```sh -./tools/batch_log_cleaner.py -i /var/log/ -o logs.tar.gz +./tools/batch_log_cleaner.py -i /var/log/ -o logs.tar.gz --complete ``` It'll generate a file logs.tar.gz with sample lines (by default 1000 lines) of the Postfix log files in /var/log, removing any sensitive data. @@ -57,20 +52,8 @@ It'll generate a file logs.tar.gz with sample lines (by default 1000 lines) of t Please run such script on the original log files, or at least on a copy of such files that preserve the file modification time (copied by rsync, for instance, instead of a plain "cp"), as such metadata is important for analysing the log files. -If you prefer not collecting samples, but sending us all file lines, please add the argument `--complete` to the script execution, as in: - -```sh -./tools/batch_log_cleaner.py -i /var/log/ -o logs.tar.gz --complete -``` - Please always check the contents of the `logs.tar.gz` file before sending it to us :-) You can attach the `logs.tar.gz` file to this issue, or send it via e-mail to `hello@lightmeter.io` with the subject `Log files for Gitlab issue #XXX`, where `#XXX` is the number assigned to the issue report you've just created (you can copy if from the URL or from the top of the page). - -**Which Operating System and version are you using?** - -OS: - -Version: