add bug report form (#11891)
Ilya Mashchenko committed
Jan 10, 2022 at 12:05 UTC
9969f0dd43e7894e400350a135a0674bd81c4377
12 files changed
+114
-85
.github/ISSUE_TEMPLATE/BUG_REPORT.yml
new
+102
@@ -0,0 +1,102 @@
1
+name: "Bug report: Netdata"
2
+description: "Submit a report and help us improve our free and open-source Netdata Agent"
3
+title: "[Bug]: "
4
+labels: ["bug", "needs triage"]
5
+body:
6
+ - type: markdown
7
+ attributes:
8
+ value: "### Thank you for contributing to our project!"
9
+ - type: markdown
10
+ attributes:
11
+ value: |
12
+ <img src="https://img.shields.io/github/v/release/netdata/netdata.svg?label=latest%20stable"> <img src="https://img.shields.io/badge/dynamic/xml?url=https://storage.googleapis.com/netdata-nightlies/latest-version.txt&label=latest%20nightly&query=/text()">
13
+ - type: markdown
14
+ attributes:
15
+ value: |
16
+ Before submitting, we'd appreciate it if you:
17
+ - Verify that your issue is not already reported on GitHub.
18
+ - Check if your Netdata Agent is up to date. If not, we recommend that you [update](https://learn.netdata.cloud/docs/agent/packaging/installer/update) first.
19
+ - type: textarea
20
+ id: bug-description
21
+ attributes:
22
+ label: Bug description
23
+ description: Provide a description of the bug you're experiencing.
24
+ validations:
25
+ required: true
26
+ - type: textarea
27
+ id: expected-behavior
28
+ attributes:
29
+ label: Expected behavior
30
+ description: Describe what you expected to happen.
31
+ validations:
32
+ required: true
33
+ - type: textarea
34
+ id: reproduce
35
+ attributes:
36
+ label: Steps to reproduce
37
+ description: Describe the steps to reproduce the bug.
38
+ value: |
39
+ 1.
40
+ 2.
41
+ 3.
42
+ ...
43
+ validations:
44
+ required: true
45
+ - type: dropdown
46
+ id: install-method
47
+ attributes:
48
+ label: Installation method
49
+ description: |
50
+ Select [installation method](https://learn.netdata.cloud/docs/agent/packaging/installer#alternative-methods) you used.
51
+ Describe the method in the "Additional info" section if you chose "other".
52
+ options:
53
+ - "kickstart.sh"
54
+ - "kickstart-static64.sh"
55
+ - "native binary packages (.deb/.rpm)"
56
+ - "from git"
57
+ - "from source"
58
+ - "docker"
59
+ - "helmchart (kubernetes)"
60
+ - "other"
61
+ validations:
62
+ required: true
63
+ - type: textarea
64
+ id: system-info
65
+ attributes:
66
+ label: System info
67
+ description: |
68
+ Provide information about your system. To get this information, execute one of the following commands based on your OS:
69
+ ```shell
70
+ # Linux
71
+ uname -a; grep -HvE "^#|URL" /etc/*release
72
+ # BSD
73
+ uname -a; uname -K
74
+ # macOS
75
+ uname -a; sw_vers
76
+ ```
77
+ > NOTE: This will be automatically formatted into code, so no need for backticks.
78
+ render: shell
79
+ validations:
80
+ required: true
81
+ - type: textarea
82
+ id: netdata-buildfinfo
83
+ attributes:
84
+ label: Netdata build info
85
+ description: |
86
+ Provide Netdata Agent version and build info. To get this information, execute:
87
+ ```shell
88
+ netdata -W buildinfo
89
+ # If get "netdata: command not found", try (required running Netdata)
90
+ $(ps aux | grep -m1 -E -o "[a-zA-Z/]+netdata ") -W buildinfo
91
+ ```
92
+ > NOTE: This will be automatically formatted into code, so no need for backticks.
93
+ render: shell
94
+ validations:
95
+ required: true
96
+ - type: textarea
97
+ id: additional-info
98
+ attributes:
99
+ label: Additional info
100
+ description: Any additional information related to the issue (ex. logs).
101
+ validations:
102
+ required: false
.github/ISSUE_TEMPLATE/bug_report.md
deleted
-72
@@ -1,72 +0,0 @@
1
----
2
-name: "Bug report: Netdata Agent"
3
-about: "Submit a report and help us improve our free and open-source Netdata Agent"
4
-labels: bug, needs triage
5
----
6
-
7
-<!--
8
-When creating a bug report please:
9
-- Verify first that your issue is not already reported on GitHub.
10
-- Test if the latest release and master branch are affected too.
11
--->
12
-
13
-##### Bug report summary
14
-
15
-<!-- Provide a clear and concise description of the bug you're experiencing. -->
16
-
17
-##### OS / Environment
18
-
19
-<!--
20
-Provide as much information about your environment (which operating system and distribution you're using, if Netdata is running in a container, etc.)
21
-as possible to allow us reproduce this bug faster.
22
-
23
-To get this information, execute the following commands based on your operating system:
24
-- uname -a; grep -Hv "^#" /etc/*release # Linux
25
-- uname -a; uname -K # BSD
26
-- uname -a; sw_vers # macOS
27
-
28
-Place the output from the command in the code section below.
29
- -->
30
-
31
-```
32
-
33
-```
34
-
35
-##### Netdata version
36
-
37
-<!--
38
-Provide output of `netdata -W buildinfo`.
39
-
40
-If your Netdata Agent is older, and doesn't support buildinfo, do the following:
41
-Provide output of `netdata -V`.
42
-
43
-If Netdata is running, execute: $(ps aux | grep -E -o "[a-zA-Z/]+netdata ") -V
44
- -->
45
-
46
-##### Installation method
47
-
48
-<!--
49
-Tell us which installation method you used (https://learn.netdata.cloud/docs/agent/packaging/installer#alternative-methods).
50
- -->
51
-
52
-##### Component Name
53
-
54
-<!--
55
-Let us know which component is affected by the bug. Our code is structured according to its component,
56
-so the component name is the same as the top level directory of the repository.
57
-For example, a bug in the dashboard would be under the web component.
58
--->
59
-
60
-##### Steps To Reproduce
61
-
62
-<!--
63
-Describe how you found this bug and how we can reproduce it, preferably with a minimal test-case scenario.
64
-If you'd like to attach larger files, use gist.github.com and paste in links.
65
--->
66
-
67
-1. ...
68
-2. ...
69
-
70
-##### Expected behavior
71
-
72
-<!-- Provide a clear and concise description of what you expected to happen. -->
README.md
+1
-1
@@ -224,7 +224,7 @@ Contributions are the lifeblood of open-source projects. While we continue to in
224
225
- Read our [Contributing Guide](https://learn.netdata.cloud/contribute/handbook), which contains all the information you need to contribute to Netdata, such as improving our documentation, engaging in the community, and developing new features. We've made it as frictionless as possible, but if you need help, just ping us on our community forums!
226
- We have a whole category dedicated to contributing and extending Netdata on our [community forums](https://community.netdata.cloud/c/agent-development/9)
227
-- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2C+needs+triage&template=bug_report.md).
227
+- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=%5BBug%5D%3A+).
228
- View our [Security Policy](https://github.com/netdata/netdata/security/policy).
229
230
Package maintainers should read the guide on [building Netdata from source](/packaging/installer/methods/source.md) for
claim/README.md
+2
-2
@@ -399,7 +399,7 @@ grep -i ACLK /var/log/netdata/error.log
399
```
400
401
If the installer's output does not help you enable Cloud features, contact us by [creating an issue on
402
-GitHub](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage%2C+ACLK&template=bug_report.md&title=The+installer+failed+to+prepare+the+required+dependencies+for+Netdata+Cloud+functionality)
402
+GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=The+installer+failed+to+prepare+the+required+dependencies+for+Netdata+Cloud+functionality)
403
with details about your system and relevant output from `error.log`.
404
405
#### agent-claimed is false / Claimed: No
@@ -416,7 +416,7 @@ connecting](#connect-through-a-proxy).
416
417
If you are certain firewall and proxy settings are not the issue, you should consult the Agent's `error.log` at
418
`/var/log/netdata/error.log` and contact us by [creating an issue on
419
-GitHub](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage%2C+ACLK&template=bug_report.md&title=ACLK-available-is-false)
419
+GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=ACLK-available-is-false)
420
with details about your system and relevant output from `error.log`.
421
422
### Remove and reconnect a node
collectors/REFERENCE.md
+1
-1
@@ -81,7 +81,7 @@ field contains `go.d`, that collector uses the Go orchestrator.
81
82
The output from the relevant command will provide valuable troubleshooting information. If you can't figure out how to
83
enable the collector using the details from this output, feel free to [create an issue on our
84
-GitHub](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) to get some
84
+GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) to get some
85
help from our collectors experts.
86
87
## Enable and disable plugins
docs/dashboard/import-export-print-snapshot.mdx
+1
-1
@@ -17,7 +17,7 @@ timeframe](/docs/dashboard/visualization-date-and-time-controls.mdx) when the al
17
colleague for further analysis.
18
19
Or, send the Netdata team a snapshot of your dashboard when [filing a bug
20
-report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2C+needs+triage&template=bug_report.md) on
20
+report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) on
21
GitHub.
22
23
 d
70
71
Can't find your preferred external time-series database? Ask our [community](https://community.netdata.cloud/) for
72
solutions, or file an [issue on
73
-GitHub](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md).
73
+GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml).
74
75
## What's next?
76
docs/guides/collect-unbound-metrics.md
+1
-1
@@ -134,7 +134,7 @@ file](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/unbound.con
134
135
Now that you're collecting metrics from your Unbound servers, let us know how it's working for you! There's always room
136
for improvement or refinement based on real-world use cases. Feel free to [file an
137
-issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) with your
137
+issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) with your
138
thoughts.
139
140
[](<>)
docs/guides/monitor-cockroachdb.md
+1
-1
@@ -115,7 +115,7 @@ guide](/health/QUICKSTART.md).
115
116
Now that you're collecting metrics from your CockroachDB databases, let us know how it's working for you! There's always
117
room for improvement or refinement based on real-world use cases. Feel free to [file an
118
-issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) with your
118
+issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) with your
119
thoughts.
120
121
Also, be sure to check out these useful resources:
docs/guides/monitor-hadoop-cluster.md
+2
-3
@@ -73,8 +73,7 @@ The JSON result for a DataNode's `/jmx` endpoint is slightly different:
73
```json
74
{
75
"beans" : [ {
76
- "name" : "Hadoop:service=DataNode,name=DataNodeActivity-dev-slave-01.dev.loc
77
-al-9866",
76
+ "name" : "Hadoop:service=DataNode,name=DataNodeActivity-dev-slave-01.dev.local-9866",
77
"modelerType" : "DataNodeActivity-dev-slave-01.dev.local-9866",
78
"tag.SessionId" : null,
79
"tag.Context" : "dfs",
@@ -192,7 +191,7 @@ documentation](/health/README.md).
191
192
If you're having issues with Netdata auto-detecting your HDFS/Zookeeper servers, or want to help improve how Netdata
193
collects or presents metrics from these services, feel free to [file an
195
-issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md).
194
+issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml).
195
196
- Read up on the [HDFS configuration
197
file](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/hdfs.conf) to understand how to configure
docs/guides/using-host-labels.md
+1
-1
@@ -206,7 +206,7 @@ queries _do_ showcase this information. As always, we recommend you secure Netda
206
- [Caddy](/docs/Running-behind-caddy.md)
207
208
If you have issues or questions around using host labels, don't hesitate to [file an
209
-issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) on GitHub. We're
209
+issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) on GitHub. We're
210
excited to make host labels even more valuable to our users, which we can only do with your input.
211
212
[](<>)
packaging/installer/REINSTALL.md
+1
-1
@@ -63,6 +63,6 @@ best route is to [uninstall](/packaging/installer/UNINSTALL.md) and then try a f
63
installer](/packaging/installer/methods/kickstart.md).
64
65
You can also post to our [community forums](https://community.netdata.cloud/c/support/13) or create a new [bug
66
-report](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md).
66
+report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml).
67
68
[](<>)