From 7ecaa2fe2ce9229a4870f45688f933a58824b816 Mon Sep 17 00:00:00 2001 From: Roman Khavronenko Date: Wed, 26 May 2021 10:26:45 +0100 Subject: [PATCH] update the issue template (#1329) The main changes are: * ask for Grafana's dashboard screenshots; * ask only for non-default cmd-line flags; * explicitly ask about logs; --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1d11ad1a47..4500c91c08 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,12 +4,12 @@ about: Create a report to help us improve title: '' labels: '' assignees: '' - --- **Describe the bug** A clear and concise description of what the bug is. -It would be a great [upgrading](https://docs.victoriametrics.com/#how-to-upgrade) to [the latest avaialble release](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) +It would be a great [upgrading](https://docs.victoriametrics.com/#how-to-upgrade) +to [the latest available release](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) and verifying whether the bug is reproducible there. It is also recommended reading [troubleshooting docs](https://docs.victoriametrics.com/#troubleshooting). @@ -19,9 +19,22 @@ Steps to reproduce the behavior. **Expected behavior** A clear and concise description of what you expected to happen. +**Logs** +Check if any warnings or errors were logged by VictoriaMetrics components +or components in communication with VictoriaMetrics (e.g. Prometheus, Grafana). + **Screenshots** If applicable, add screenshots to help explain your problem. +For VictoriaMetrics health-state issues please provide full-length screenshots +of Grafana dashboards if possible: +* [Grafana dashboard for single-node VictoriaMetrics](https://grafana.com/dashboards/10229) +* [Grafana dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176) + +See how to setup monitoring here: +* [monitoring for single-node VictoriaMetrics](https://docs.victoriametrics.com/#monitoring) +* [montioring for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#monitoring) + **Version** The line returned when passing `--version` command line flag to binary. For example: ``` @@ -30,15 +43,5 @@ victoria-metrics-20190730-121249-heads-single-node-0-g671d9e55 ``` **Used command-line flags** -Command-line flags are listed as `flag{name="httpListenAddr", value=":443"} 1` lines at the `/metrics` page. -See the following docs for details: +Please provide applied command-line flags used for running VictoriaMetrics and its components. -* [monitoring for single-node VictoriaMetrics](https://docs.victoriametrics.com/#monitoring) -* [montioring for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#monitoring) - -**Additional context** -Add any other context about the problem here such as error logs from VictoriaMetrics and Prometheus, -`/metrics` output, screenshots from the official Grafana dashboards for VictoriaMetrics: - -* [Grafana dashboard for single-node VictoriaMetrics](https://grafana.com/dashboards/10229) -* [Grafana dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176)