Skip to content

Commit 55a22d1

Browse files
wxiaoguangdelvhGustedlunny
authored
Improve log document (#20097)
* Improve log document * Update docs/content/doc/help/seek-help.en-us.md Co-authored-by: delvh <[email protected]> * Update docs/content/doc/help/seek-help.en-us.md Co-authored-by: Gusted <[email protected]> * Use different log names to avoid conflicts * Update seek-help.en-us.md Co-authored-by: delvh <[email protected]> Co-authored-by: Gusted <[email protected]> Co-authored-by: Lunny Xiao <[email protected]>
1 parent d0507ef commit 55a22d1

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

docs/content/doc/help/seek-help.en-us.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,26 @@ menu:
2020

2121
**NOTE:** When asking for support, it may be a good idea to have the following available so that the person helping has all the info they need:
2222

23-
1. Your `app.ini` (with any sensitive data scrubbed as necessary)
24-
2. The `gitea.log` (and any other appropriate log files for the situation)
25-
* e.g. If the error is related to the database, the `xorm.log` might be helpful
26-
3. Any error messages you are seeing
23+
1. Your `app.ini` (with any sensitive data scrubbed as necessary).
24+
2. The Gitea logs, and any other appropriate log files for the situation.
25+
* The logs are likely to be outputted to console. If you need to collect logs from files,
26+
you could copy the following config into your `app.ini` (remove all other `[log]` sections),
27+
then you can find the `*.log` files in Gitea's log directory (default: `%(GITEA_WORK_DIR)/log`).
28+
```ini
29+
; To show all SQL logs, you can also set LOG_SQL=true in the [database] section
30+
[log]
31+
LEVEL=debug
32+
MODE=console,file
33+
ROUTER=console,file
34+
XORM=console,file
35+
ENABLE_XORM_LOG=true
36+
FILE_NAME=gitea.log
37+
[log.file.router]
38+
FILE_NAME=router.log
39+
[log.file.xorm]
40+
FILE_NAME=xorm.log
41+
```
42+
3. Any error messages you are seeing.
2743
4. When possible, try to replicate the issue on [try.gitea.io](https://try.gitea.io) and include steps so that others can reproduce the issue.
2844
* This will greatly improve the chance that the root of the issue can be quickly discovered and resolved.
2945
5. If you meet slow/hanging/deadlock problems, please report the stack trace when the problem occurs:

0 commit comments

Comments
 (0)