From bf744698a1101f39caa467aa63ddbc4f5be5113a Mon Sep 17 00:00:00 2001 From: Connor Lindsey Date: Fri, 3 Dec 2021 10:14:39 -0700 Subject: [PATCH] Update service graph docs (#42604) * Update service graph docs * Add link to agent configuration --- docs/sources/datasources/tempo.md | 40 +++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/docs/sources/datasources/tempo.md b/docs/sources/datasources/tempo.md index 4e3b132d5be..539042f7a95 100644 --- a/docs/sources/datasources/tempo.md +++ b/docs/sources/datasources/tempo.md @@ -38,6 +38,18 @@ This is a configuration for the [trace to logs feature]({{< relref "../explore/t {{< figure src="/static/img/docs/explore/traces-to-logs-settings-8-2.png" class="docs-image--no-shadow" caption="Screenshot of the trace to logs settings" >}} +### Service Graph + +This is a configuration for the Service Graph feature. + +-- **Data source -** Prometheus instance where the Service Graph data is stored. + +### Search + +This is a configuration for Tempo search. + +-- **Hide search -** Optionally, hide the search query option in Explore in cases where search is not configured in the Tempo instance. + ### Node Graph This is a configuration for the beta Node Graph visualization. The Node Graph is shown after the trace view is loaded and is disabled by default. @@ -103,6 +115,34 @@ Here is an example JSON: } ``` +## Service Graph + +A service graph is a visual representation of the relationships between services. Each node on the graph represents a service such as an API or database. With this graph, customers can easily detect performance issues, increases in error, fault, or throttle rates in any of their services, and dive deep into corresponding traces and root causes. + +![Node graph panel](/static/img/docs/node-graph/node-graph-8-0.png 'Node graph') + +To display the service graph: + +- [Configure the Grafana Agent](https://grafana.com/docs/tempo/next/grafana-agent/service-graphs/#quickstart) to generate service graph data +- Link a Prometheus datasource in the Tempo datasource settings. +- Navigate to [Explore]({{< relref "../explore/_index.md" >}}) +- Select the Tempo datasource +- Select the **Service Graph** query type and run the query +- Optionally, filter by service name + +You can pan and zoom the view with buttons or you mouse. For details about the visualization, refer to [Node graph panel](https://grafana.com/docs/grafana/latest/panels/visualizations/node-graph/). + +Each service in the graph is represented as a circle. Numbers on the inside shows average time per request and request per second. + +The color of each circle represents the percentage of requests in each of the following states: + +- green = success +- red = fault +- yellow = errors +- purple = throttled responses + +Click on the service to see a context menu with additional links for quick navigation to other relevant information. + ## Linking Trace ID from logs You can link to Tempo trace from logs in Loki or Elastic by configuring an internal link. See the [Derived fields]({{< relref "loki.md#derived-fields" >}}) section in the [Loki data source]({{< relref "loki.md" >}}) or [Data links]({{< relref "elasticsearch.md#data-links" >}}) section in the [Elastic data source]({{< relref "elasticsearch.md" >}}) for configuration instructions.