Skip to content

Commit

Permalink
improve the bug_report issue template (#84)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhongyuan17 authored May 21, 2024
1 parent 16901eb commit 8f98fc2
Showing 1 changed file with 34 additions and 9 deletions.
43 changes: 34 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,28 @@ 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]
- ClientIdentifier:
- ClientIdentifier:
- etc...
- MQTT Pub:
- Topic:
- QoS: [0|1|2]
- Retain: [true | false]
*** SUB Client ***
*** SUB Client ***:
- MQTT Connection:
- Clean Session: [true | false]
- ClientIdentifier:
Expand All @@ -36,9 +43,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 +56,27 @@ 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]
- FanIn & FanOut
- FanIn: [e.g. 5 means one sub client recieves messages from average 5 pub clients]
- FanOut: [e.g. 5 means one message is subscribed by average 5 sub clients]
- Please describe here how do you design your topic pattern and pub/sub messages: [e.g. 10 pub clients send messages to the topic: tp/{deviceName}/event, which each client use its unique deviceName. One sub client subscribe the topicfilter tp/+/event to recieve all the messages.]

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

0 comments on commit 8f98fc2

Please sign in to comment.