[DOC] Fix style issues and add videos to tracing and profiling shared files (#81215)
Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
This commit is contained in:
Kim Nylander
co-authored by
Jack Baldry
Ryan Perry
Clayton Cornell
Jack Baldry
Ryan Perry
Clayton Cornell
parent
2a734a9e3f
commit
da8eb8faa5
@@ -19,7 +19,7 @@ labels:
|
||||
|
||||
The TraceQL query builder, located on the **Explore** > **Query type** > **Search** in Grafana, provides drop-downs and text fields to help you write a query.
|
||||
|
||||
|
||||
|
||||
|
||||
The builder lets you run the most common queries in as few clicks as possible. You don't need to know the underlying query language or database architecture to use it.
|
||||
|
||||
@@ -32,14 +32,14 @@ You can use the query builder to search trace data by resource service name, spa
|
||||
|
||||
In addition, you can add query builder blocks, view the query history, and use the **Inspector** to see details.
|
||||
|
||||
{{< figure src="/static/img/docs/queries/screenshot-tempods-query-search.png" class="docs-image--no-shadow" max-width="750px" caption="Screenshot of the Tempo Search query type" >}}
|
||||
{{< figure src="/media/docs/tempo/traceql/screenshot-tempods-query-search.png" class="docs-image--no-shadow" max-width="750px" caption="Screenshot of the Tempo Search query type" >}}
|
||||
|
||||
## Perform a search
|
||||
|
||||
To perform a search, you need to select filters and/or tags and then run the query. The results appear underneath the query builder.
|
||||
The screenshot below identifies the areas used to perform a search.
|
||||
The screenshot identifies the areas used to perform a search.
|
||||
|
||||
{{< figure src="/static/img/docs/queries/screenshot-tempods-query-search-parts.png" class="docs-image--no-shadow" max-width="750px" caption="Parts of Tempo Search query type" >}}
|
||||
{{< figure src="/media/docs/tempo/traceql/screenshot-tempods-query-search-parts.png" class="docs-image--no-shadow" max-width="750px" caption="Parts of Tempo Search query type" >}}
|
||||
|
||||
| Number | Name | Action | Comment |
|
||||
| :----- | :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
@@ -109,8 +109,11 @@ To add a tag, follow these steps:
|
||||
Using **Aggregate by**, you can calculate RED metrics (total span count, percent erroring spans, and latency information) for spans of `kind=server` that match your filter criteria, grouped by one or more attributes.
|
||||
This capability is based on the [metrics summary API](/docs/grafana-cloud/monitor-infrastructure/traces/metrics-summary-api/).
|
||||
Metrics summary only calculates summaries based on spans received within the last hour.
|
||||
For additional information, refer to [Traces to metrics: Ad-hoc RED metrics in Grafana Tempo with `Aggregate by`](https://grafana.com/blog/2023/12/07/traces-to-metrics-ad-hoc-red-metrics-in-grafana-tempo-with-aggregate-by/).
|
||||
|
||||
{{< youtube id="g97CjKOZqT4" >}}
|
||||
<!--Impromptu RED metrics with Aggregate by -->
|
||||
|
||||
{{< youtube id="xOolCpm2F8c" >}}
|
||||
|
||||
When you use **Aggregate by**, the selections you make determine how the information is reported in the Table. Every combination that matches selections in your data is listed in the table.
|
||||
Each aggregate value, for example `intrinsic`:`name`, has a corresponding column in the results table.
|
||||
@@ -119,13 +122,13 @@ For example, **names** matching `GET /:endpoint` with a **span.http.user_agent**
|
||||
|
||||
The RED metrics are calculated for every name and user agent combination found in your data.
|
||||
|
||||
|
||||
|
||||
The screenshot shows all of the successful HTTP `status_code` API calls against the `mystical-server` service.
|
||||
The results are shown in the same order used in **Aggregate by**.
|
||||
For example, **Aggregate by** lists `intrinsic.name` followed by `span.http.user_agent`.
|
||||
The first column in the results Table shows **name** and then **span.http.user_agent**.
|
||||
|
||||
|
||||
|
||||
To use this capability:
|
||||
|
||||
1. In the **Aggregate by** row, select a scope from the first drop-down box. For example, `span`.
|
||||
@@ -134,6 +137,10 @@ To use this capability:
|
||||
1. Optional: Select a **Time range** to expand or narrow the data set for an hour's range.
|
||||
1. Select **Run query**.
|
||||
|
||||
<!-- Explanation of how to use feature -->
|
||||
|
||||
{{< youtube id="g97CjKOZqT4" >}}
|
||||
|
||||
### Optional: Add queries
|
||||
|
||||
Using **Add query**, you can have successive queries that run in sequential order.
|
||||
@@ -147,7 +154,7 @@ Select **Run query** to run the TraceQL query (1 in the screenshot).
|
||||
|
||||
Queries can take a little while to return results. The results appear in a table underneath the query builder. Selecting a Trace ID (2 in the screenshot) displays more detailed information (3 in the screenshot).
|
||||
|
||||
{{< figure src="/static/img/docs/queries/screenshot-tempods-query-results.png" class="docs-image--no-shadow" max-width="750px" caption="Tempo Search query type results" >}}
|
||||
{{< figure src="/media/docs/tempo/traceql/screenshot-tempods-query-results.png" class="docs-image--no-shadow" max-width="750px" caption="Tempo Search query type results" >}}
|
||||
|
||||
#### Streaming results
|
||||
|
||||
|
||||
Reference in New Issue
Block a user