mirror/gitea
1
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2024-12-15 17:49:20 +08:00
Code Packages Projects Releases Wiki Activity
e15794f62f
gitea/docs/content/help/support.en-us.md
Giteabot 087df926cc
Improve the "bug report" template and "support options" document (#26753) (#26780) 
Backport #26753 by @wxiaoguang

* `/help/support` is a better document than
`/administration/logging-config` for bug reporting
* Improve `support.en-us.md`
    * Move/add detailed contents into `Advanced Bug Report Tips` section
    * Merge `Chinese Support` section into `Support Options`

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
2023-08-29 07:57:21 +08:00

2.8 KiB
Raw Blame History

date title slug sidebar_position toc draft aliases menu
2018-05-21T15:00:00+00:00 Support Options support 20 false false
/en-us/seek-help
sidebar
parent name sidebar_position identifier
help Support Options 20 support

Support Options

Bug Report

If you found a bug, please create an issue on GitHub.

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:

  1. Your app.ini (with any sensitive data scrubbed as necessary).
  2. Any error messages you are seeing.
  3. The Gitea logs, and all other related logs for the situation.
    • It's more useful to collect trace / debug level logs (see the next section).
    • When using systemd, use journalctl --lines 1000 --unit gitea to collect logs.
    • When using docker, use docker logs --tail 1000 <gitea-container> to collect logs.
  4. Reproducible steps so that others could reproduce and understand the problem more quickly and easily.
  5. If you encounter slow/hanging/deadlock problems, please report the stacktrace when the problem occurs. Go to the "Site Admin" -> "Monitoring" -> "Stacktrace" -> "Download diagnosis report".

Advanced Bug Report Tips

More Config Options for Logs

By default, the logs are outputted to console with info level. If you need to set log level and/or collect logs from files, you could just copy the following config into your app.ini (remove all other [log] sections), then you will find the *.log files in Gitea's log directory (default: %(GITEA_WORK_DIR)/log).

; To show all SQL logs, you can also set LOG_SQL=true in the [database] section
[log]
LEVEL=debug
MODE=console,file

Collecting Stacktrace by Command Line

Gitea could use Golang's pprof handler and toolchain to collect stacktrace and other runtime information.

If the web UI stops working, you could try to collect the stacktrace by command line:

  1. Set app.ini:

    [server]
ENABLE_PPROF = true

  2. Restart Gitea

  3. Try to trigger the bug, when the requests get stuck for a while, use curl or browser to visit: http://127.0.0.1:6060/debug/pprof/goroutine?debug=1 to get the stacktrace.