mirror of
https://github.com/grafana/grafana.git
synced 2026-08-26 13:27:30 -05:00
[DOC] Remove traceQLStreaming feature flag from docs (#94581)
* Remove traceQLStreaming feature flag from docs * Apply suggestions from code review Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Updates from prettier --------- Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Kim Nylander
co-authored by
Jack Baldry
Jack Baldry
parent
62738dd5c8
commit
8a3508a547
@@ -123,30 +123,25 @@ For additional information on setting up TLS encryption with Tempo, refer to [Co
|
||||
|
||||
## Streaming
|
||||
|
||||
<!-- The traceQLStreaming toggle will be deprecated in Grafana 11.2 and removed in 11.3. -->
|
||||
|
||||
Streaming enables TraceQL query results to be displayed as they become available.
|
||||
Without streaming, no results are displayed until all results have returned.
|
||||
|
||||
{{< docs/public-preview product="TraceQL streaming results" >}}
|
||||
|
||||
To use streaming, you need to:
|
||||
|
||||
- Run Tempo version 2.2 or newer, or Grafana Enterprise Traces (GET) version 2.2 or newer, or use Grafana Cloud Traces.
|
||||
- For self-managed Tempo or GET instances: If your Tempo or GET instance is behind a load balancer or proxy that doesn't supporting gRPC or HTTP2, streaming may not work and should be disabled.
|
||||
- Run Tempo version 2.2 or later, or Grafana Enterprise Traces (GET) version 2.2 or later, or use Grafana Cloud Traces.
|
||||
- Tempo must have `stream_over_http_enabled: true` for streaming to work.
|
||||
|
||||
For more information, refer to [Tempo GRPC API](https://grafana.com/docs/tempo/<TEMPO_VERSION>/api_docs/#tempo-grpc-api).
|
||||
|
||||
- For self-managed Tempo or GET instances: If your Tempo or GET instance is behind a load balancer or proxy that doesn't supporting gRPC or HTTP2, streaming may not work and should be deactivated.
|
||||
|
||||
### Activate streaming
|
||||
|
||||
You can activate streaming by either setting the `traceQLStreaming` [feature toggle](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/feature-toggles/) to true or by activating the **Streaming** toggle in the Tempo data source.
|
||||
Streaming is available in Grafana and Grafana Cloud.
|
||||
You can activate streaming by turning the **Streaming** toggle to on in the Tempo data source.
|
||||
|
||||
|
||||
|
||||
If you are using Grafana Cloud, the `traceQLStreaming` feature toggle is already set to `true` by default.
|
||||
|
||||
If the Tempo data source is set to allow streaming but the `traceQLStreaming` feature toggle is set to `false` in Grafana, streaming occurs.
|
||||
|
||||
If the data source has streaming disabled and `traceQLStreaming` is set to `true`, streaming happens for that data source.
|
||||
|
||||
When streaming is active, it's shows as **Enabled** in **Explore**.
|
||||
To check the status, select Explore in the menu, select your Tempo data source, and expand the **Options** section.
|
||||
|
||||
|
||||
@@ -41,7 +41,6 @@ Most [generally available](https://grafana.com/docs/release-life-cycle/#general-
|
||||
| `recordedQueriesMulti` | Enables writing multiple items from a single query within Recorded Queries | Yes |
|
||||
| `logsExploreTableVisualisation` | A table visualisation for logs in Explore | Yes |
|
||||
| `transformationsRedesign` | Enables the transformations redesign | Yes |
|
||||
| `traceQLStreaming` | Enables response streaming of TraceQL queries of the Tempo data source | |
|
||||
| `awsAsyncQueryCaching` | Enable caching for async queries for Redshift and Athena. Requires that the datasource has caching and async query support enabled | Yes |
|
||||
| `prometheusConfigOverhaulAuth` | Update the Prometheus configuration page with the new auth component | Yes |
|
||||
| `alertingNoDataErrorExecution` | Changes how Alerting state manager handles execution of NoData/Error | Yes |
|
||||
|
||||
@@ -129,10 +129,8 @@ Using the **Spans** option makes it easier access the spans to apply transformat
|
||||
|
||||
The Tempo data source supports streaming responses to TraceQL queries so you can see partial query results as they come in without waiting for the whole query to finish.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
To use this feature in Grafana OSS v10.1 and later, enable the `traceQLStreaming` feature toggle. This capability is enabled by default in Grafana Cloud.
|
||||
{{% /admonition %}}
|
||||
|
||||
Streaming is available for both the **Search** and **TraceQL** query types, and you'll get immediate visibility of incoming traces on the results table.
|
||||
|
||||
To learn how to activate streaming, refer to [Streaming](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/datasources/tempo/configure-tempo-data-source/#streaming) in the Tempo data source documentation.
|
||||
|
||||
{{< video-embed src="/media/docs/grafana/data-sources/tempo-streaming-v2.mp4" >}}
|
||||
|
||||
@@ -167,12 +167,9 @@ Selecting a Trace ID (2 in the screenshot) displays more detailed information (3
|
||||
|
||||
The Tempo data source supports streaming responses to TraceQL queries so you can see partial query results as they come in without waiting for the whole query to finish.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
To use this public preview feature, enable the `traceQLStreaming` feature toggle.
|
||||
When active, all configured Tempo data sources will attempt to use streaming.
|
||||
You can control which Tempo data sources do and don't attempt to stream results at the per-data source level using the **Streaming** section of the Tempo data source configuration.
|
||||
|
||||
{{% /admonition %}}
|
||||
When active, all configured Tempo data sources attempt to use streaming.
|
||||
You can activate and control which Tempo data sources do and don't attempt to stream results at the per-data source level using the **Streaming** section of the Tempo data source configuration.
|
||||
For more information, refer to the [Tempo data source](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/datasources/tempo/configure-tempo-data-source/#streaming) documentation.
|
||||
|
||||
Streaming is available for both the **Search** and **TraceQL** query types.
|
||||
You'll get immediate visibility of incoming traces on the results table.
|
||||
|
||||
Reference in New Issue
Block a user