apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

documentation: update documentation for enabling tracing on a grafana instance (#56068)

Browse Source 
This PR improves docs around enabling traces on grafana.
In order to enable tracing and get a traceID, you must set the address field in your config.ini

https://github.com/grafana/grafana/blob/main/contribute/engineering/backend/instrumentation.md#2-enable-tracing-in-grafana
pull/55888/merge
Jeff Levin 3 years ago committed by GitHub
parent 2664575a4a
commit e4157361d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 21 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 46
      contribute/engineering/backend/instrumentation.md

46
contribute/engineering/backend/instrumentation.md
Unescape View File

@ -55,6 +55,8 @@ When to use which log level?
Use a contextual logger to include additional key/value pairs attached to `context.Context`, e.g. `traceID`, to allow correlating logs with traces and/or correlate logs with a common identifier. Use a contextual logger to include additional key/value pairs attached to `context.Context`, e.g. `traceID`, to allow correlating logs with traces and/or correlate logs with a common identifier.
You must [Enable tracing in Grafana](#2-enable-tracing-in-grafana) to get a traceID
Example: Example:
```go ```go
@ -241,36 +243,38 @@ Be **careful** to not expose any sensitive information in span names, attribute
### How to collect, visualize and query traces (and correlate logs with traces) locally ### How to collect, visualize and query traces (and correlate logs with traces) locally
1. Start Jaeger #### 1. Start Jaeger
```bash ```bash
make devenv sources=jaeger make devenv sources=jaeger
``` ```
2. Enable tracing in Grafana #### 2. Enable tracing in Grafana
opentelemetry tracing (recommended): To enable tracing in Grafana, you must set the address in your config.ini file
```ini opentelemetry tracing (recommended):
[tracing.opentelemetry.jaeger]
address = http://localhost:14268/api/traces
```
opentracing tracing (deprecated/not recommended): ```ini
[tracing.opentelemetry.jaeger]
address = http://localhost:14268/api/traces
```
```ini opentracing tracing (deprecated/not recommended):
[tracing.jaeger]
address = localhost:6831 ```ini
``` [tracing.jaeger]
address = localhost:6831
```
3. Search/browse collected logs and traces in Grafana Explore #### 3. Search/browse collected logs and traces in Grafana Explore
You need provisioned gdev-jaeger and gdev-loki datasources, see [developer dashboard and data sources](https://github.com/grafana/grafana/tree/main/devenv#developer-dashboards-and-data-sources) for setup instructions. You need provisioned gdev-jaeger and gdev-loki datasources, see [developer dashboard and data sources](https://github.com/grafana/grafana/tree/main/devenv#developer-dashboards-and-data-sources) for setup instructions.
Open Grafana explore and select gdev-loki datasource and use the query `{filename="/var/log/grafana/grafana.log"} | logfmt`. Open Grafana explore and select gdev-loki datasource and use the query `{filename="/var/log/grafana/grafana.log"} | logfmt`.
You can then inspect any log message that includes a `traceID` and from there click on `gdev-jaeger` to split view and inspect the trace in question. You can then inspect any log message that includes a `traceID` and from there click on `gdev-jaeger` to split view and inspect the trace in question.
4. Search/browse collected traces in Jaeger UI #### 4. Search/browse collected traces in Jaeger UI
You can open http://localhost:16686 to use the Jaeger UI for browsing and searching traces. You can open http://localhost:16686 to use the Jaeger UI for browsing and searching traces.

Write Preview
Loading…
Cancel
Save