diff --git a/docs/sources/installation/troubleshooting.md b/docs/sources/installation/troubleshooting.md index 3da3d6f4ec8..28bf42e60e7 100755 --- a/docs/sources/installation/troubleshooting.md +++ b/docs/sources/installation/troubleshooting.md @@ -11,31 +11,30 @@ weight = 8 # Troubleshooting -## Visualization and Query issues +This page lists some useful tools to help troubleshoot common Grafana issues. + +## Visualization and query issues {{< imgbox max-width="40%" img="/img/docs/v45/query_inspector.png" caption="Query Inspector" >}} -The most common problems are related to the query and response from you data source. Even if it looks -like a bug or visualization issue in Grafana it is 99% of time a problem with the data source query or +The most common problems are related to the query and response from your data source. Even if it looks +like a bug or visualization issue in Grafana, it is almost always a problem with the data source query or the data source response. -To check this you should use Query Inspector (new in Grafana v4.5). The query Inspector shows query requests and responses. +To check this you should use query inspector, which was added in Grafana 4.5. The query inspector shows query requests and responses. Refer to the data source page for more information. -For more on the query inspector read [this guide here](https://community.grafana.com/t/using-grafanas-query-inspector-to-troubleshoot-issues/2630). For -older versions of Grafana read the [how troubleshoot metric query issue](https://community.grafana.com/t/how-to-troubleshoot-metric-query-issues/50/2) article. +For more on the query inspector read the Grafana Community article [Using Grafana’s Query Inspector to troubleshoot issues](https://community.grafana.com/t/using-grafanas-query-inspector-to-troubleshoot-issues/2630). For older versions of Grafana, refer to the [How troubleshoot metric query issue](https://community.grafana.com/t/how-to-troubleshoot-metric-query-issues/50/2) article. ## Logging -If you encounter an error or problem it is a good idea to check the grafana server log. Usually -located at `/var/log/grafana/grafana.log` on Unix systems or in `/data/log` on -other platforms and manual installs. +If you encounter an error or problem, then you can check the Grafana server log. Usually located at `/var/log/grafana/grafana.log` on Unix systems or in `/data/log` on other platforms and manual installs. -You can enable more logging by changing log level in your grafana configuration file. +You can enable more logging by changing log level in the Grafana configuration file. ## Diagnostics -The `grafana-server` process can be instructued to enable certain diagnostics when it starts. This can be helpful -when experiencing/investigating certain performance problems. It's `not` recommended to have these enabled per default. +The `grafana-server` process can be instructed to enable certain diagnostics when it starts. This can be helpful +when investigating certain performance problems. It's *not* recommended to have these enabled per default. ### Profiling @@ -46,27 +45,26 @@ the default HTTP port (`6060`) where the pprof debugging endpoints will be avail ./grafana-server -profile -profile-port=8080 ``` -Note that pprof debugging endpoints are served on a different port than the Grafana HTTP server. +Note that `pprof` debugging endpoints are served on a different port than the Grafana HTTP server. -You can configure/override profiling settings using environment variables: +You can configure or override profiling settings using environment variables: ```bash export GF_DIAGNOSTICS_PROFILING_ENABLED=true export GF_DIAGNOSTICS_PROFILING_PORT=8080 ``` -See [Go command pprof](https://golang.org/cmd/pprof/) for more information about how to collect and analyze profiling data. +Refer to [Go command pprof](https://golang.org/cmd/pprof/) for more information about how to collect and analyze profiling data. ### Tracing -The `grafana-server` can be started with the arguments `-tracing` to enable tracing and `-tracing-file` to -override the default trace file (`trace.out`) where trace result will be written to, e.g. +The `grafana-server` can be started with the arguments `-tracing` to enable tracing and `-tracing-file` to override the default trace file (`trace.out`) where trace result is written to. For example: ```bash ./grafana-server -tracing -tracing-file=/tmp/trace.out ``` -You can configure/override profiling settings using environment variables: +You can configure or override profiling settings using environment variables: ```bash export GF_DIAGNOSTICS_TRACING_ENABLED=true @@ -84,8 +82,7 @@ go tool trace See [Go command trace](https://golang.org/cmd/trace/) for more information about how to analyze trace files. -## FAQ +## FAQs -Check out the [FAQ](https://community.grafana.com/c/howto/faq) section on our community page for frequently +Check out the [FAQ section](https://community.grafana.com/c/howto/faq) on the Grafana Community page for answers to frequently asked questions. -