Skip to content

Commit de1e514

Browse files
oddlittlebirdmarefr
authored andcommitted
Docs: Update troubleshooting.md (grafana#21244)
Fixed a few minor grammar errors. Fixes grafana#19295
1 parent 4f10dca commit de1e514

File tree

1 file changed

+18
-21
lines changed

1 file changed

+18
-21
lines changed

docs/sources/installation/troubleshooting.md

+18-21
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,30 @@ weight = 8
1111

1212
# Troubleshooting
1313

14-
## Visualization and Query issues
14+
This page lists some useful tools to help troubleshoot common Grafana issues.
15+
16+
## Visualization and query issues
1517

1618
{{< imgbox max-width="40%" img="/img/docs/v45/query_inspector.png" caption="Query Inspector" >}}
1719

18-
The most common problems are related to the query and response from you data source. Even if it looks
19-
like a bug or visualization issue in Grafana it is 99% of time a problem with the data source query or
20+
The most common problems are related to the query and response from your data source. Even if it looks
21+
like a bug or visualization issue in Grafana, it is almost always a problem with the data source query or
2022
the data source response.
2123

22-
To check this you should use Query Inspector (new in Grafana v4.5). The query Inspector shows query requests and responses.
24+
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.
2325

24-
For more on the query inspector read [this guide here](https://community.grafana.com/t/using-grafanas-query-inspector-to-troubleshoot-issues/2630). For
25-
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.
26+
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.
2627

2728
## Logging
2829

29-
If you encounter an error or problem it is a good idea to check the grafana server log. Usually
30-
located at `/var/log/grafana/grafana.log` on Unix systems or in `<grafana_install_dir>/data/log` on
31-
other platforms and manual installs.
30+
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 `<grafana_install_dir>/data/log` on other platforms and manual installs.
3231

33-
You can enable more logging by changing log level in your grafana configuration file.
32+
You can enable more logging by changing log level in the Grafana configuration file.
3433

3534
## Diagnostics
3635

37-
The `grafana-server` process can be instructued to enable certain diagnostics when it starts. This can be helpful
38-
when experiencing/investigating certain performance problems. It's `not` recommended to have these enabled per default.
36+
The `grafana-server` process can be instructed to enable certain diagnostics when it starts. This can be helpful
37+
when investigating certain performance problems. It's *not* recommended to have these enabled per default.
3938

4039
### Profiling
4140

@@ -46,27 +45,26 @@ the default HTTP port (`6060`) where the pprof debugging endpoints will be avail
4645
./grafana-server -profile -profile-port=8080
4746
```
4847

49-
Note that pprof debugging endpoints are served on a different port than the Grafana HTTP server.
48+
Note that `pprof` debugging endpoints are served on a different port than the Grafana HTTP server.
5049

51-
You can configure/override profiling settings using environment variables:
50+
You can configure or override profiling settings using environment variables:
5251

5352
```bash
5453
export GF_DIAGNOSTICS_PROFILING_ENABLED=true
5554
export GF_DIAGNOSTICS_PROFILING_PORT=8080
5655
```
5756

58-
See [Go command pprof](https://golang.org/cmd/pprof/) for more information about how to collect and analyze profiling data.
57+
Refer to [Go command pprof](https://golang.org/cmd/pprof/) for more information about how to collect and analyze profiling data.
5958

6059
### Tracing
6160

62-
The `grafana-server` can be started with the arguments `-tracing` to enable tracing and `-tracing-file` to
63-
override the default trace file (`trace.out`) where trace result will be written to, e.g.
61+
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:
6462

6563
```bash
6664
./grafana-server -tracing -tracing-file=/tmp/trace.out
6765
```
6866

69-
You can configure/override profiling settings using environment variables:
67+
You can configure or override profiling settings using environment variables:
7068

7169
```bash
7270
export GF_DIAGNOSTICS_TRACING_ENABLED=true
@@ -84,8 +82,7 @@ go tool trace <trace file>
8482

8583
See [Go command trace](https://golang.org/cmd/trace/) for more information about how to analyze trace files.
8684

87-
## FAQ
85+
## FAQs
8886

89-
Check out the [FAQ](https://community.grafana.com/c/howto/faq) section on our community page for frequently
87+
Check out the [FAQ section](https://community.grafana.com/c/howto/faq) on the Grafana Community page for answers to frequently
9088
asked questions.
91-

0 commit comments

Comments
 (0)