mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 02:12:29 +08:00
560f49b3dc
* Enable doc-validator for specific directories Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix one linting error to trigger CI Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update doc-validator to latest release Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update make-docs procedure Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use doc-validator version from CI in local make target Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Revert to 1.11.0 Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * adds missing descriptions * Fix titles and headings Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix link formats Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix easy to resolve anchors Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Remove broken anchor link This anchor appears to have been broken for a long time. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use doc-validator image with support for numbered anchors Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update make-docs procedure to support doc-validator 2.0.x Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix a bunch of broken anchors Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Ignore old whatsnew content Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update doc-validator to v2.0.x and use reviewdog to report errors Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * removes broken links --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
62 lines
2.2 KiB
Markdown
62 lines
2.2 KiB
Markdown
---
|
|
aliases:
|
|
- ../../troubleshooting/diagnostics/
|
|
- ../enable-diagnostics/
|
|
menuTitle: Configure tracing
|
|
title: Configure tracing to troubleshoot Grafana
|
|
description: Learn how to configure tracing so that you can troubleshoot Grafana.
|
|
weight: 200
|
|
---
|
|
|
|
# Configure tracing to troubleshoot Grafana
|
|
|
|
You can set up the `grafana-server` process to enable certain diagnostics when it starts. This can be useful
|
|
when investigating certain performance problems. It's _not_ recommended to have these enabled by default.
|
|
|
|
## Turn on profiling
|
|
|
|
The `grafana-server` can be started with the command-line option `-profile` to enable profiling, `-profile-addr` to override the default HTTP address (`localhost`), and
|
|
`-profile-port` to override the default HTTP port (`6060`) where the `pprof` debugging endpoints are available. For example:
|
|
|
|
```bash
|
|
./grafana server -profile -profile-addr=0.0.0.0 -profile-port=8080
|
|
```
|
|
|
|
Note that `pprof` debugging endpoints are served on a different port than the Grafana HTTP server.
|
|
|
|
You can configure or override profiling settings using environment variables:
|
|
|
|
```bash
|
|
export GF_DIAGNOSTICS_PROFILING_ENABLED=true
|
|
export GF_DIAGNOSTICS_PROFILING_ADDR=0.0.0.0
|
|
export GF_DIAGNOSTICS_PROFILING_PORT=8080
|
|
```
|
|
|
|
Refer to [Go command pprof](https://golang.org/cmd/pprof/) for more information about how to collect and analyze profiling data.
|
|
|
|
## Use 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 is written to. For example:
|
|
|
|
```bash
|
|
./grafana server -tracing -tracing-file=/tmp/trace.out
|
|
```
|
|
|
|
You can configure or override profiling settings using environment variables:
|
|
|
|
```bash
|
|
export GF_DIAGNOSTICS_TRACING_ENABLED=true
|
|
export GF_DIAGNOSTICS_TRACING_FILE=/tmp/trace.out
|
|
```
|
|
|
|
View the trace in a web browser (Go required to be installed):
|
|
|
|
```bash
|
|
go tool trace <trace file>
|
|
2019/11/24 22:20:42 Parsing trace...
|
|
2019/11/24 22:20:42 Splitting trace...
|
|
2019/11/24 22:20:42 Opening browser. Trace viewer is listening on http://127.0.0.1:39735
|
|
```
|
|
|
|
For more information about how to analyze trace files, refer to [Go command trace](https://golang.org/cmd/trace/).
|