Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Remove traceQLStreaming feature flag #4188

Merged

Conversation

knylander-grafana
Copy link
Contributor

What this PR does:

Removes the traceQLStreaming feature toggle, per grafana/grafana#94528

Also, updates the version of Grafana to 11.2 in some of the docker-compose files that reference the feature toggle.

Which issue(s) this PR fixes:
Part of grafana/grafana#94528

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

Copy link
Contributor

This PR must be merged before a backport PR will be created.

Copy link
Member

@yvrhdn yvrhdn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks okay to me but for the examples to work with streaming we need to change something in the data source configuration here:

https://github.com/grafana/tempo/blob/main/example/docker-compose/shared/grafana-datasources.yaml#L27-L30

If you run the docker-compose example, the Tempo data source has streaming disabled.

I'm trying to track down what the config name is in Grafana...

@knylander-grafana
Copy link
Contributor Author

knylander-grafana commented Oct 15, 2024

This looks okay to me but for the examples to work with streaming we need to change something in the data source configuration here:

main/example/docker-compose/shared/grafana-datasources.yaml#L27-L30

If you run the docker-compose example, the Tempo data source has streaming disabled.

I'm trying to track down what the config name is in Grafana...

Oh! I wonder if the requirement for Grafana for these to work is 11.3. I think the feature toggle is being removed then. I think I found the answer in a Slack thread from Andre P:

If the traceQLStreaming feature toggle is enabled for the instance, for all Tempo datasources, update the jsonData property with "streamingEnabled":{"search":true}.
Examples:

{"streamingEnabled":{"search":true}}
{"oauthPassThru":false,"streamingEnabled":{"search":true}}
{"nodeGraph":{"enabled":true},"serviceMap":{"datasourceUid":"Mimir"},"streamingEnabled":{"search":true},"tracesToLogs":{"datasourceUid":"loki","filterByTraceID":false,"spanEndTimeShift":"500ms","spanStartTimeShift":"-500ms","tags":["beast"]}}

@yvrhdn
Copy link
Member

yvrhdn commented Oct 15, 2024

That should be this change:

diff --git a/example/docker-compose/shared/grafana-datasources.yaml b/example/docker-compose/shared/grafana-datasources.yaml
index 4a3bc2c4e..794d5a1d5 100644
--- a/example/docker-compose/shared/grafana-datasources.yaml
+++ b/example/docker-compose/shared/grafana-datasources.yaml
@@ -28,3 +28,5 @@ datasources:
     httpMethod: GET
     serviceMap:
       datasourceUid: prometheus
+    streamingEnabled:
+      search: true

Want me to push this change to the PR or can you add it?

@yvrhdn
Copy link
Member

yvrhdn commented Oct 15, 2024

Yep I can confirm with this setting you get Streaming: Enabled in explore 👍

Screenshot 2024-10-15 at 19 08 54

@knylander-grafana
Copy link
Contributor Author

knylander-grafana commented Oct 15, 2024

Awesome! Thank you. You're faster than me :) I just added the change. I can push the update.

Do we need to add this to the docs?

@yvrhdn
Copy link
Member

yvrhdn commented Oct 15, 2024

Do we need to add this to the docs?

I think it might be nice to have an example of the yaml config either in our docs or in Grafana.

It would also fit well on this page: https://grafana.com/docs/grafana/next/datasources/tempo/configure-tempo-data-source/#streaming
There is an example yaml file at the bottom but it doesn't have the streamingEnabled setting.

@knylander-grafana
Copy link
Contributor Author

knylander-grafana commented Oct 15, 2024

I will add that example to the Grafana docs. Thank you for finding a spot. grafana/grafana#94751

I want to see if the Obs Tracing and Profiling team have any comments on the grafana/grafana PR before merging our Tempo docs PR.

@knylander-grafana knylander-grafana merged commit a5b4d76 into grafana:main Oct 16, 2024
17 checks passed
@knylander-grafana knylander-grafana deleted the remove-traceql-streaming-flag branch October 16, 2024 20:48
Copy link
Contributor

The backport to release-v2.6 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-4188-to-release-v2.6 origin/release-v2.6
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x a5b4d7613c434e6ad2eb9a4e011b97b93d1be60f

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-4188-to-release-v2.6
# Create the PR body template
PR_BODY=$(gh pr view 4188 --json body --template 'Backport a5b4d7613c434e6ad2eb9a4e011b97b93d1be60f from #4188{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release-v2.6] [DOC] Remove traceQLStreaming feature flag' --body-file - --label 'type/docs' --label 'backport' --base release-v2.6 --milestone release-v2.6 --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-4188-to-release-v2.6

# Create a pull request where the `base` branch is `release-v2.6` and the `compare`/`head` branch is `backport-4188-to-release-v2.6`.

# Remove the local backport branch
git switch main
git branch -D backport-4188-to-release-v2.6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-v2.6 backport-failed type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants