diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 102 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 72 | ||||
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | claim/README.md | 4 | ||||
| -rw-r--r-- | collectors/REFERENCE.md | 2 | ||||
| -rw-r--r-- | docs/dashboard/import-export-print-snapshot.mdx | 2 | ||||
| -rw-r--r-- | docs/export/external-databases.md | 2 | ||||
| -rw-r--r-- | docs/guides/collect-unbound-metrics.md | 2 | ||||
| -rw-r--r-- | docs/guides/monitor-cockroachdb.md | 2 | ||||
| -rw-r--r-- | docs/guides/monitor-hadoop-cluster.md | 5 | ||||
| -rw-r--r-- | docs/guides/using-host-labels.md | 2 | ||||
| -rw-r--r-- | packaging/installer/REINSTALL.md | 2 |
12 files changed, 114 insertions, 85 deletions
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 0000000000..10a131c4c6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,102 @@ +name: "Bug report: Netdata" +description: "Submit a report and help us improve our free and open-source Netdata Agent" +title: "[Bug]: " +labels: ["bug", "needs triage"] +body: + - type: markdown + attributes: + value: "### Thank you for contributing to our project!" + - type: markdown + attributes: + value: | + <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()"> + - type: markdown + attributes: + value: | + Before submitting, we'd appreciate it if you: + - Verify that your issue is not already reported on GitHub. + - 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. + - type: textarea + id: bug-description + attributes: + label: Bug description + description: Provide a description of the bug you're experiencing. + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: Describe what you expected to happen. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: Describe the steps to reproduce the bug. + value: | + 1. + 2. + 3. + ... + validations: + required: true + - type: dropdown + id: install-method + attributes: + label: Installation method + description: | + Select [installation method](https://learn.netdata.cloud/docs/agent/packaging/installer#alternative-methods) you used. + Describe the method in the "Additional info" section if you chose "other". + options: + - "kickstart.sh" + - "kickstart-static64.sh" + - "native binary packages (.deb/.rpm)" + - "from git" + - "from source" + - "docker" + - "helmchart (kubernetes)" + - "other" + validations: + required: true + - type: textarea + id: system-info + attributes: + label: System info + description: | + Provide information about your system. To get this information, execute one of the following commands based on your OS: + ```shell + # Linux + uname -a; grep -HvE "^#|URL" /etc/*release + # BSD + uname -a; uname -K + # macOS + uname -a; sw_vers + ``` + > NOTE: This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: true + - type: textarea + id: netdata-buildfinfo + attributes: + label: Netdata build info + description: | + Provide Netdata Agent version and build info. To get this information, execute: + ```shell + netdata -W buildinfo + # If get "netdata: command not found", try (required running Netdata) + $(ps aux | grep -m1 -E -o "[a-zA-Z/]+netdata ") -W buildinfo + ``` + > NOTE: This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional info + description: Any additional information related to the issue (ex. logs). + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 799fba7a0c..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -name: "Bug report: Netdata Agent" -about: "Submit a report and help us improve our free and open-source Netdata Agent" -labels: bug, needs triage ---- - -<!-- -When creating a bug report please: -- Verify first that your issue is not already reported on GitHub. -- Test if the latest release and master branch are affected too. ---> - -##### Bug report summary - -<!-- Provide a clear and concise description of the bug you're experiencing. --> - -##### OS / Environment - -<!-- -Provide as much information about your environment (which operating system and distribution you're using, if Netdata is running in a container, etc.) -as possible to allow us reproduce this bug faster. - -To get this information, execute the following commands based on your operating system: -- uname -a; grep -Hv "^#" /etc/*release # Linux -- uname -a; uname -K # BSD -- uname -a; sw_vers # macOS - -Place the output from the command in the code section below. - --> - -``` - -``` - -##### Netdata version - -<!-- -Provide output of `netdata -W buildinfo`. - -If your Netdata Agent is older, and doesn't support buildinfo, do the following: -Provide output of `netdata -V`. - -If Netdata is running, execute: $(ps aux | grep -E -o "[a-zA-Z/]+netdata ") -V - --> - -##### Installation method - -<!-- -Tell us which installation method you used (https://learn.netdata.cloud/docs/agent/packaging/installer#alternative-methods). - --> - -##### Component Name - -<!-- -Let us know which component is affected by the bug. Our code is structured according to its component, -so the component name is the same as the top level directory of the repository. -For example, a bug in the dashboard would be under the web component. ---> - -##### Steps To Reproduce - -<!-- -Describe how you found this bug and how we can reproduce it, preferably with a minimal test-case scenario. -If you'd like to attach larger files, use gist.github.com and paste in links. ---> - -1. ... -2. ... - -##### Expected behavior - -<!-- Provide a clear and concise description of what you expected to happen. --> @@ -224,7 +224,7 @@ Contributions are the lifeblood of open-source projects. While we continue to in - 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! - We have a whole category dedicated to contributing and extending Netdata on our [community forums](https://community.netdata.cloud/c/agent-development/9) -- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2C+needs+triage&template=bug_report.md). +- 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+). - View our [Security Policy](https://github.com/netdata/netdata/security/policy). Package maintainers should read the guide on [building Netdata from source](/packaging/installer/methods/source.md) for diff --git a/claim/README.md b/claim/README.md index 41557d6b5e..99c26076cf 100644 --- a/claim/README.md +++ b/claim/README.md @@ -399,7 +399,7 @@ grep -i ACLK /var/log/netdata/error.log ``` If the installer's output does not help you enable Cloud features, contact us by [creating an issue on -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) +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) with details about your system and relevant output from `error.log`. #### agent-claimed is false / Claimed: No @@ -416,7 +416,7 @@ connecting](#connect-through-a-proxy). If you are certain firewall and proxy settings are not the issue, you should consult the Agent's `error.log` at `/var/log/netdata/error.log` and contact us by [creating an issue on -GitHub](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage%2C+ACLK&template=bug_report.md&title=ACLK-available-is-false) +GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=ACLK-available-is-false) with details about your system and relevant output from `error.log`. ### Remove and reconnect a node diff --git a/collectors/REFERENCE.md b/collectors/REFERENCE.md index 313526fbf0..e5c52115e8 100644 --- a/collectors/REFERENCE.md +++ b/collectors/REFERENCE.md @@ -81,7 +81,7 @@ field contains `go.d`, that collector uses the Go orchestrator. The output from the relevant command will provide valuable troubleshooting information. If you can't figure out how to enable the collector using the details from this output, feel free to [create an issue on our -GitHub](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) to get some +GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) to get some help from our collectors experts. ## Enable and disable plugins diff --git a/docs/dashboard/import-export-print-snapshot.mdx b/docs/dashboard/import-export-print-snapshot.mdx index 7e94a52c8f..1333efc2bf 100644 --- a/docs/dashboard/import-export-print-snapshot.mdx +++ b/docs/dashboard/import-export-print-snapshot.mdx @@ -17,7 +17,7 @@ timeframe](/docs/dashboard/visualization-date-and-time-controls.mdx) when the al colleague for further analysis. Or, send the Netdata team a snapshot of your dashboard when [filing a bug -report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2C+needs+triage&template=bug_report.md) on +report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) on GitHub.  d Can't find your preferred external time-series database? Ask our [community](https://community.netdata.cloud/) for solutions, or file an [issue on -GitHub](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md). +GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml). ## What's next? diff --git a/docs/guides/collect-unbound-metrics.md b/docs/guides/collect-unbound-metrics.md index a6a4de02f0..5709c872cc 100644 --- a/docs/guides/collect-unbound-metrics.md +++ b/docs/guides/collect-unbound-metrics.md @@ -134,7 +134,7 @@ file](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/unbound.con Now that you're collecting metrics from your Unbound servers, let us know how it's working for you! There's always room for improvement or refinement based on real-world use cases. Feel free to [file an -issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) with your +issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) with your thoughts. [](<>) diff --git a/docs/guides/monitor-cockroachdb.md b/docs/guides/monitor-cockroachdb.md index 0307381e3c..3272378367 100644 --- a/docs/guides/monitor-cockroachdb.md +++ b/docs/guides/monitor-cockroachdb.md @@ -115,7 +115,7 @@ guide](/health/QUICKSTART.md). Now that you're collecting metrics from your CockroachDB databases, let us know how it's working for you! There's always room for improvement or refinement based on real-world use cases. Feel free to [file an -issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) with your +issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) with your thoughts. Also, be sure to check out these useful resources: diff --git a/docs/guides/monitor-hadoop-cluster.md b/docs/guides/monitor-hadoop-cluster.md index dce56b7c76..69f2bc8e31 100644 --- a/docs/guides/monitor-hadoop-cluster.md +++ b/docs/guides/monitor-hadoop-cluster.md @@ -73,8 +73,7 @@ The JSON result for a DataNode's `/jmx` endpoint is slightly different: ```json { "beans" : [ { - "name" : "Hadoop:service=DataNode,name=DataNodeActivity-dev-slave-01.dev.loc -al-9866", + "name" : "Hadoop:service=DataNode,name=DataNodeActivity-dev-slave-01.dev.local-9866", "modelerType" : "DataNodeActivity-dev-slave-01.dev.local-9866", "tag.SessionId" : null, "tag.Context" : "dfs", @@ -192,7 +191,7 @@ documentation](/health/README.md). If you're having issues with Netdata auto-detecting your HDFS/Zookeeper servers, or want to help improve how Netdata collects or presents metrics from these services, feel free to [file an -issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md). +issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml). - Read up on the [HDFS configuration file](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/hdfs.conf) to understand how to configure diff --git a/docs/guides/using-host-labels.md b/docs/guides/using-host-labels.md index 79558dd169..d3a51bea6b 100644 --- a/docs/guides/using-host-labels.md +++ b/docs/guides/using-host-labels.md @@ -206,7 +206,7 @@ queries _do_ showcase this information. As always, we recommend you secure Netda - [Caddy](/docs/Running-behind-caddy.md) If you have issues or questions around using host labels, don't hesitate to [file an -issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) on GitHub. We're +issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) on GitHub. We're excited to make host labels even more valuable to our users, which we can only do with your input. [](<>) diff --git a/packaging/installer/REINSTALL.md b/packaging/installer/REINSTALL.md index 50a15d799b..4dfb39848d 100644 --- a/packaging/installer/REINSTALL.md +++ b/packaging/installer/REINSTALL.md @@ -63,6 +63,6 @@ best route is to [uninstall](/packaging/installer/UNINSTALL.md) and then try a f installer](/packaging/installer/methods/kickstart.md). You can also post to our [community forums](https://community.netdata.cloud/c/support/13) or create a new [bug -report](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md). +report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml). [](<>) |