Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-15 08:23:34 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs/Troubleshooting.md: mention that it is recommended to use default command-line flag values for VictoriaMetrics components

Browse Source
This commit is contained in:
Aliaksandr Valialkin 2023-04-10 10:39:25 -07:00
parent 4077b0fcb1
commit 6c7087f65e
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/Troubleshooting.md
View File

@ -37,10 +37,14 @@ then please follow the following steps in order to quickly find the solution:
These cases are documented in [the changelog](https://docs.victoriametrics.com/CHANGELOG.html). These cases are documented in [the changelog](https://docs.victoriametrics.com/CHANGELOG.html).
So please read the changelog before the upgrade. So please read the changelog before the upgrade.
1. Check for logs in VictoriaMetrics components. They may contain useful information about the issue. 1. Inpsect command-line flags passed to VictoriaMetrics components and remove flags which unclear outcomes for your workload.
If the log message doesn't have enough useful information for troubleshooting the issue, VictoriaMetrics components are designed to work optimally with the default command-line flag values (e.g. when these flags aren't set explicitly).
It is recommended removing flags with unclear outcomes, since they may result in unexpected issues.
1. Check for logs in VictoriaMetrics components. They may contain useful information about cause of the issue
and how to fix the issue. If the log message doesn't have enough useful information for troubleshooting,
then search the log message in Google. There are high chances that the issue is already reported then search the log message in Google. There are high chances that the issue is already reported
somewhere (docs, StackOverflow, Github issues, etc.) and indexed by Google and the solution is already documented there. somewhere (docs, StackOverflow, Github issues, etc.) and the solution is already documented there.
1. If VictoriaMetrics logs have no relevant information, then try searching for the issue in Google 1. If VictoriaMetrics logs have no relevant information, then try searching for the issue in Google
via multiple keywords and phrases specific to the issue. There are high chances that the issue via multiple keywords and phrases specific to the issue. There are high chances that the issue
@ -49,9 +53,8 @@ then please follow the following steps in order to quickly find the solution:
1. Try searching for the issue at [VictoriaMetrics Github](https://github.com/VictoriaMetrics/VictoriaMetrics/issues). 1. Try searching for the issue at [VictoriaMetrics Github](https://github.com/VictoriaMetrics/VictoriaMetrics/issues).
The signal/noise quality of search results here is much lower than in Google, but sometimes it may help The signal/noise quality of search results here is much lower than in Google, but sometimes it may help
finding the relevant information about the issue when Google fails to find the needed information. finding the relevant information about the issue when Google fails to find the needed information.
If you located the relevant Github issue, but it misses some information on how to diagnose or troubleshoot If you located the relevant Github issue, but it misses some information on how to diagnose or troubleshoot it,
the issue, then please provide this information in comments to the issue. This increases chances then please provide this information in comments to the issue. This increases chances that it will be resolved soon.
that the issue will be resolved soon.
1. Try searching for information about the issue in [VictoriaMetrics source code](https://github.com/search?q=repo%3AVictoriaMetrics%2FVictoriaMetrics&type=code). 1. Try searching for information about the issue in [VictoriaMetrics source code](https://github.com/search?q=repo%3AVictoriaMetrics%2FVictoriaMetrics&type=code).
Github code search may be not very good in some cases, so it is recommended [checking out VictoriaMetrics source code](https://github.com/VictoriaMetrics/VictoriaMetrics/) Github code search may be not very good in some cases, so it is recommended [checking out VictoriaMetrics source code](https://github.com/VictoriaMetrics/VictoriaMetrics/)