Re: [PR] Add TraceQL configuration in docs ui-grafana.md [skywalking]

[via GitHub]

Copilot commented on code in PR #13803:
URL: https://github.com/apache/skywalking/pull/13803#discussion_r3043661244


##########
docs/en/setup/backend/ui-grafana.md:
##########
@@ -22,6 +22,20 @@ In the data source config panel, chose the `SkyWalking` and 
set the url to the O
 In the data source config panel, chose the `Loki` and set the url to the OAP 
server address, the default port is `3100`.
 <img 
src="https://skywalking.apache.org/screenshots/9.6.0/logql/grafana-loki-datasource.jpg"/>
 
+### Tempo Data Source
+In the data source config panel, chose the `Tempo` and set the url to the OAP 
server address, the default port is `3200`.
+The SkyWalking native trace API context path is `/skywalking`, and the Zipkin 
trace API context path is `/zipkin`.
+You can customize them via `SW_TRACEQL_REST_CONTEXT_PATH_SKYWALKING` and 
`SW_TRACEQL_REST_CONTEXT_PATH_ZIPKIN` respectively.
+
+***Notice:*** disable the Streamimg option for Tempo data source in the 
following configuration.

Review Comment:
   Typo in the Tempo data source notice: "Streamimg" should be "Streaming" 
(matching Grafana’s option name and the wording used elsewhere in TraceQL docs).
   ```suggestion
   ***Notice:*** disable the Streaming option for Tempo data source in the 
following configuration.
   ```



##########
docs/en/setup/backend/ui-grafana.md:
##########
@@ -22,6 +22,20 @@ In the data source config panel, chose the `SkyWalking` and 
set the url to the O
 In the data source config panel, chose the `Loki` and set the url to the OAP 
server address, the default port is `3100`.
 <img 
src="https://skywalking.apache.org/screenshots/9.6.0/logql/grafana-loki-datasource.jpg"/>
 
+### Tempo Data Source
+In the data source config panel, chose the `Tempo` and set the url to the OAP 
server address, the default port is `3200`.
+The SkyWalking native trace API context path is `/skywalking`, and the Zipkin 
trace API context path is `/zipkin`.
+You can customize them via `SW_TRACEQL_REST_CONTEXT_PATH_SKYWALKING` and 
`SW_TRACEQL_REST_CONTEXT_PATH_ZIPKIN` respectively.

Review Comment:
   The Tempo data source URL instruction is likely incomplete/misleading: 
Grafana usually needs the full base URL including the backend context path 
(e.g., `http://<oap-host>:3200/skywalking` or `/zipkin`), not just the 
host/port. Consider updating this sentence to explicitly include the required 
path to avoid misconfiguration.
   ```suggestion
   In the data source config panel, chose the `Tempo` and set the url to the 
full OAP trace API address, including the context path. The default port is 
`3200`, for example `http://<oap-host>:3200/skywalking` for SkyWalking native 
trace or `http://<oap-host>:3200/zipkin` for Zipkin trace.
   The SkyWalking native trace API context path is `/skywalking`, and the 
Zipkin trace API context path is `/zipkin`.
   You can customize them via `SW_TRACEQL_REST_CONTEXT_PATH_SKYWALKING` and 
`SW_TRACEQL_REST_CONTEXT_PATH_ZIPKIN` respectively. If you customize either 
path, use the customized path in the Grafana Tempo data source URL.
   ```



##########
docs/en/setup/backend/ui-grafana.md:
##########
@@ -118,6 +132,28 @@ For endpoint relation scope, extra set `Endpoint` and 
`Dest Endpoint`.
 4. Test query and save the panel.
 <img 
src="https://skywalking.apache.org/screenshots/10.1.0/promql/grafana-relation-panel.png"/>
 
+## Configure Trace Dashboard
+### SkyWalking Native Trace
+#### Dashboards Settings
+The following steps are an example of configuring a `Trace` dashboard for 
SkyWalking native trace:
+1. Go to the `Explore` page, select the `Tempo` data source named 
`SkyWalkingTraceQL` (the name you configured). Add it to the dashboard and save 
it as `SkyWalking Trace`.
+<img 
src="https://skywalking.apache.org/screenshots/10.4.0/traceql/grafana-tempo-skywalking-explore.png"/>
+2. Configure variables for the dashboard:
+<img 
src="https://skywalking.apache.org/screenshots/10.4.0/traceql/grafana-tempo-skywalking-variables.png"/>
+
+#### Add Trace Panel
+The following steps show how to add a trace panel for SkyWalking native trace.
+1. Choose `Table` chart or edit your saved panel.
+2. Set `Query type` to `Search` and set the query condition `Service Name` to 
variable `$Service`.
+3. Set other query conditions if needed.
+4. Test query and save the panel.
+<img 
src="https://skywalking.apache.org/screenshots/10.4.0/traceql/grafana-tempo-skywalking-panel.png"/>
+5. If you click the trace ID on the trace panel, it will jump to the explore 
page and show the trace details.
+<img 
src="https://skywalking.apache.org/screenshots/10.4.0/traceql/grafana-tempo-skywalking-trace-detail.png"/>
+
+### Zipkin Trace
+Same as the SkyWalking native trace, but use the Zipkin tempo data source you 
configured.

Review Comment:
   Inconsistent capitalization in product name: "Zipkin tempo data source" 
should use "Tempo" (capital T) to match earlier references (e.g., "Tempo Data 
Source").
   ```suggestion
   Same as the SkyWalking native trace, but use the Zipkin Tempo data source 
you configured.
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@skywalking.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org