Skip to content

Commit

Permalink
imporve the bug_report issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
zhongyuan17 committed May 20, 2024
1 parent 16901eb commit 4f0d9a5
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,19 @@ assignees: ''

---

⚠️ **Please ensure that the provided information is as detailed and clear as possible. Lack of information may delay the resolution of the issue.**

**Describe the bug**
A clear and concise description of what the bug is.

**BifroMQ**
- Version: [e.g. 3.1.x **We highly recommend you to try the latest version first.**]
- Deployment: [e.g. Standalone | Cluster | Docker | Kubernetes | etc]

**To Reproduce**

Steps to reproduce the behavior, Please include necessary information such as(but not limited to):

*** PUB Client ***:
- MQTT Connection:
- Clean Session: [true | false]
Expand All @@ -36,9 +44,9 @@ A clear and concise description of what you expected to happen.
**Logs**
If applicable, add related logs to help troubleshoot.

**HOST**
- CPU: [e.g. vCPU number]
- Memory: [e.g. 32G]
**Configurations**
You can copy from the beginning of info.log and paste here.
See also: https://bifromq.io/docs/admin_guide/configuration/configs_print

**OS(please complete the following information):**
- OS: [e.g. CentOS 8]
Expand All @@ -49,9 +57,23 @@ If applicable, add related logs to help troubleshoot.
- Version: [e.g. 17]
- Arguments: [e.g. if override any JVM arguments]

**BifroMQ**
- Version:
- Non-Default Configuration:
**Performance Related**

If your problem is performance-related, please provide as much detailed information as possible according to the list.

- HOST:
- Cluster node count: [e.g. 1|3]
- CPU: [e.g. vCPU number]
- Memory: [e.g. 32G]
- Network:
- Bandwidth: [e.g. 1Gbps]
- Latency: [e.g. 1ms]
- Load:
- PUB count: [e.g. 1000]
- SUB count: [e.g. 1000]
- PUB QPS per connection: [e.g. 10msg/s]
- SUB QPS per connection: [e.g. 10msg/s]
- Payload size: [e.g. 1KB]

**Additional context**
Add any other context about the problem here.

0 comments on commit 4f0d9a5

Please sign in to comment.