Skip to content

Commit 83208b4

Browse files
authored
Improve the "bug report" template and "support options" document (#26753)
* `/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`
1 parent dca2f93 commit 83208b4

File tree

2 files changed

+48
-28
lines changed

2 files changed

+48
-28
lines changed

.github/ISSUE_TEMPLATE/bug-report.yaml

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Bug Report
22
description: Found something you weren't expecting? Report it here!
3-
labels: kind/bug
3+
labels: ["kind/bug"]
44
body:
55
- type: markdown
66
attributes:
@@ -15,11 +15,8 @@ body:
1515
3. Make sure you are using the latest release and
1616
take a moment to check that your issue hasn't been reported before.
1717
4. Make sure it's not mentioned in the FAQ (https://docs.gitea.com/help/faq)
18-
5. Please give all relevant information below for bug reports, because
18+
5. It's really important to provide pertinent details and logs (https://docs.gitea.com/help/support),
1919
incomplete details will be handled as an invalid report.
20-
6. In particular it's really important to provide pertinent logs. You must give us DEBUG level logs.
21-
Please read https://docs.gitea.com/administration/logging-config#collecting-logs-for-help
22-
In addition, if your problem relates to git commands set `RUN_MODE=dev` at the top of app.ini
2320
- type: textarea
2421
id: description
2522
attributes:
@@ -89,6 +86,6 @@ body:
8986
description: What database system are you running?
9087
options:
9188
- PostgreSQL
92-
- MySQL
89+
- MySQL/MariaDB
9390
- MSSQL
9491
- SQLite

docs/content/help/support.en-us.md

+45-22
Original file line numberDiff line numberDiff line change
@@ -22,34 +22,57 @@ menu:
2222
- [Discourse Forum](https://discourse.gitea.io/)
2323
- [Matrix](https://matrix.to/#/#gitea-space:matrix.org)
2424
- NOTE: Most of the Matrix channels are bridged with their counterpart in Discord and may experience some degree of flakiness with the bridge process.
25+
- Chinese Support
26+
- [Discourse Chinese Category](https://discourse.gitea.io/c/5-category/5)
27+
- QQ Group 328432459
28+
29+
# Bug Report
30+
31+
If you found a bug, please [create an issue on GitHub](https://github.com/go-gitea/gitea/issues).
2532

2633
**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:
2734

2835
1. Your `app.ini` (with any sensitive data scrubbed as necessary).
29-
2. The Gitea logs, and any other appropriate log files for the situation.
30-
- When using systemd, use `journalctl --lines 1000 --unit gitea` to collect logs.
31-
- When using docker, use `docker logs --tail 1000 <gitea-container>` to collect logs.
32-
- By default, the logs are outputted to console. If you need to collect logs from files,
33-
you could copy the following config into your `app.ini` (remove all other `[log]` sections),
34-
then you can find the `*.log` files in Gitea's log directory (default: `%(GITEA_WORK_DIR)/log`).
35-
36-
```ini
37-
; To show all SQL logs, you can also set LOG_SQL=true in the [database] section
38-
[log]
39-
LEVEL=debug
40-
MODE=console,file
41-
```
42-
43-
3. Any error messages you are seeing.
44-
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.
45-
- This will greatly improve the chance that the root of the issue can be quickly discovered and resolved.
46-
5. If you encounter slow/hanging/deadlock problems, please report the stack trace when the problem occurs.
36+
2. Any error messages you are seeing.
37+
3. The Gitea logs, and all other related logs for the situation.
38+
- It's more useful to collect `trace` / `debug` level logs (see the next section).
39+
- When using systemd, use `journalctl --lines 1000 --unit gitea` to collect logs.
40+
- When using docker, use `docker logs --tail 1000 <gitea-container>` to collect logs.
41+
4. Reproducible steps so that others could reproduce and understand the problem more quickly and easily.
42+
- [try.gitea.io](https://try.gitea.io) could be used to reproduce the problem.
43+
5. If you encounter slow/hanging/deadlock problems, please report the stacktrace when the problem occurs.
4744
Go to the "Site Admin" -> "Monitoring" -> "Stacktrace" -> "Download diagnosis report".
4845

49-
## Bugs
46+
# Advanced Bug Report Tips
47+
48+
## More Config Options for Logs
49+
50+
By default, the logs are outputted to console with `info` level.
51+
If you need to set log level and/or collect logs from files,
52+
you could just copy the following config into your `app.ini` (remove all other `[log]` sections),
53+
then you will find the `*.log` files in Gitea's log directory (default: `%(GITEA_WORK_DIR)/log`).
54+
55+
```ini
56+
; To show all SQL logs, you can also set LOG_SQL=true in the [database] section
57+
[log]
58+
LEVEL=debug
59+
MODE=console,file
60+
```
5061

51-
If you found a bug, please create an [issue on GitHub](https://github.com/go-gitea/gitea/issues).
62+
## Collecting Stacktrace by Command Line
63+
64+
Gitea could use Golang's pprof handler and toolchain to collect stacktrace and other runtime information.
65+
66+
If the web UI stops working, you could try to collect the stacktrace by command line:
67+
68+
1. Set `app.ini`:
69+
70+
```
71+
[server]
72+
ENABLE_PPROF = true
73+
```
5274
53-
## Chinese Support
75+
2. Restart Gitea
5476
55-
Support for the Chinese language is provided at [Our discourse](https://discourse.gitea.io/c/5-category/5) or QQ Group 328432459.
77+
3. Try to trigger the bug, when the requests get stuck for a while,
78+
use `curl` or browser to visit: `http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` to get the stacktrace.

0 commit comments

Comments
 (0)