[DOC] Update metrics query docs with examples, more details#4248
Merged
knylander-grafana merged 7 commits intografana:mainfrom Oct 30, 2024
Merged
Conversation
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com> Co-authored-by: Joe Elliott <joe.elliott@grafana.com>
7 tasks
Comment on lines
+84
to
+87
| {{< admonition type="note" >}} | ||
| TraceQL metric queries with exemplars aren't fully supported in Grafana Explore. | ||
| They will be supported in a future Grafana release. | ||
| {{< /admonition >}} |
Contributor
Author
There was a problem hiding this comment.
This admonition is new and needs to be reviewed.
zalegrala
approved these changes
Oct 30, 2024
Contributor
|
This PR must be merged before a backport PR will be created. |
Contributor
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-4248-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 532f83f9338542c4f63052b104e6c1205e8b6f36When the conflicts are resolved, stage and commit the changes: If you have the GitHub CLI installed: # Push the branch to GitHub:
git push --set-upstream origin backport-4248-to-release-v2.6
# Create the PR body template
PR_BODY=$(gh pr view 4248 --json body --template 'Backport 532f83f9338542c4f63052b104e6c1205e8b6f36 from #4248{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release-v2.6] [DOC] Update metrics query docs with examples, more details' --body-file - --label 'type/docs' --label 'backport' --base release-v2.6 --milestone release-v2.6 --webOr, 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-4248-to-release-v2.6
# Create a pull request where the `base` branch is `release-v2.6` and the `compare`/`head` branch is `backport-4248-to-release-v2.6`.
# Remove the local backport branch
git switch main
git branch -D backport-4248-to-release-v2.6 |
knylander-grafana
added a commit
that referenced
this pull request
Oct 30, 2024
* Update metrics query doc with more examples * Update content from doc session * Apply suggestions from code review Co-authored-by: Jennifer Villa <jvilla2013@gmail.com> Co-authored-by: Joe Elliott <joe.elliott@grafana.com> * Restructure and update metrics queries * Updates to meet review comments * fix paragraph * Updates for conflict --------- Co-authored-by: Jennifer Villa <jvilla2013@gmail.com> Co-authored-by: Joe Elliott <joe.elliott@grafana.com> (cherry picked from commit 532f83f)
7 tasks
knylander-grafana
added a commit
that referenced
this pull request
Oct 30, 2024
…tails (#4250) * [DOC] Update metrics query docs with examples, more details (#4248) * Update metrics query doc with more examples * Update content from doc session * Apply suggestions from code review Co-authored-by: Jennifer Villa <jvilla2013@gmail.com> Co-authored-by: Joe Elliott <joe.elliott@grafana.com> * Restructure and update metrics queries * Updates to meet review comments * fix paragraph * Updates for conflict --------- Co-authored-by: Jennifer Villa <jvilla2013@gmail.com> Co-authored-by: Joe Elliott <joe.elliott@grafana.com> (cherry picked from commit 532f83f) * Apply suggestions from code review * Update docs/sources/tempo/traceql/metrics-queries/_index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does:
Second try. Original PR with review comments: #4128
This doc has a first draft of a use case for using TraceQL metrics queries to investigate an issue. The example provides equivalent PromQL and TraceQL queries.
Updates the TraceQL metrics documentation to add:
Which issue(s) this PR fixes:
Fixes https://github.com/grafana/tempo-squad/issues/413
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]