From aa5de4dcad95e1c01cfe7871e668798ef9cbe733 Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Wed, 7 Sep 2022 23:58:55 +0800 Subject: [PATCH] Upgrade the document about how to collect logs for systemd and docker (#21101) Many users (#21099) do not know how to collect logs if they are using systemd. This PR makes the document more clear. --- docs/content/doc/advanced/logging-documentation.en-us.md | 6 ++++-- docs/content/doc/help/faq.en-us.md | 6 ++++-- docs/content/doc/help/seek-help.en-us.md | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/content/doc/advanced/logging-documentation.en-us.md b/docs/content/doc/advanced/logging-documentation.en-us.md index b519641591..4e8cbb3282 100644 --- a/docs/content/doc/advanced/logging-documentation.en-us.md +++ b/docs/content/doc/advanced/logging-documentation.en-us.md @@ -15,12 +15,14 @@ menu: # Logging Configuration -The logging framework has been revamped in Gitea 1.9.0. - **Table of Contents** {{< toc >}} +## Collecting Logs for Help + +To collect logs for help and issue report, see [Support Options]({{< relref "doc/help/seek-help.en-us.md" >}}). + ## Log Groups The fundamental thing to be aware of in Gitea is that there are several diff --git a/docs/content/doc/help/faq.en-us.md b/docs/content/doc/help/faq.en-us.md index 17983da695..970a6866a6 100644 --- a/docs/content/doc/help/faq.en-us.md +++ b/docs/content/doc/help/faq.en-us.md @@ -392,7 +392,9 @@ Gitea requires the system or browser to have one of the supported Emoji fonts in Stdout on systemd goes to the journal by default. Try using `journalctl`, `journalctl -u gitea`, or `journalctl `. -Similarly stdout on docker can be viewed using `docker logs ` +Similarly, stdout on docker can be viewed using `docker logs `. + +To collect logs for help and issue report, see [Support Options]({{< relref "doc/help/seek-help.en-us.md" >}}). ## Initial logging @@ -413,7 +415,7 @@ unchanged in the database schema. This may lead to warning such as: 2020/08/02 11:32:29 ...rm/session_schema.go:360:Sync2() [W] Table user Column keep_activity_private db default is , struct default is 0 ``` -These can safely be ignored but you may able to stop these warnings by getting Gitea to recreate these tables using: +These can safely be ignored, but you are able to stop these warnings by getting Gitea to recreate these tables using: ``` gitea doctor recreate-table user diff --git a/docs/content/doc/help/seek-help.en-us.md b/docs/content/doc/help/seek-help.en-us.md index fe898e34b9..fe47481600 100644 --- a/docs/content/doc/help/seek-help.en-us.md +++ b/docs/content/doc/help/seek-help.en-us.md @@ -22,12 +22,14 @@ menu: 1. Your `app.ini` (with any sensitive data scrubbed as necessary). 2. The Gitea logs, and any other appropriate log files for the situation. - - The logs are likely to be outputted to console. If you need to collect logs from files, + - When using systemd, use `journalctl --lines 1000 --unit gitea` to collect logs. + - When using docker, use `docker logs --tail 1000 ` to collect logs. + - By default, the logs are outputted to console. If you need to collect logs from files, you could copy the following config into your `app.ini` (remove all other `[log]` sections), then you can find the `*.log` files in Gitea's log directory (default: `%(GITEA_WORK_DIR)/log`). ```ini - ; To show all SQL logs, you can also set LOG_SQL=true in the [database] section + ; To show all SQL logs, you can also set LOG_SQL=true in the [database] section [log] LEVEL=debug MODE=console,file