[DOC] Update screenshots tracing #2767
Conversation
knylander-grafana
requested review from
joe-elliott,
annanay25,
mdisibio,
mapno,
kvrhdn,
zalegrala,
electron0zero,
ie-pham and
stoewer
as code owners
| @@ -16,7 +16,7 @@ Spans also have a hierarchy, where parent spans can have children or siblings. | |||
|
|
|||
| In the screenshot below, the left side of the screen (1) shows the list of results for the query. The right side (2) lists each span that makes up the selected trace. | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
since this image does not exist in this repo are there any CI checks that alert us if this is removed?
cc @jdbaldry
There was a problem hiding this comment.
Very fair question.
The asset uploader service doesn't allow deletes except by the website squad themselves so removals don't happen often. That being said, that distance could mean that it would be hard to communicate if a removal were to happen.
There's nothing turnkey right now but I could imagine a quick script that runs make docs, greps for all image links, and then curls the URL to check it doesn't 404.
There was a problem hiding this comment.
cool, agree that something here would be nice. perhaps some CI in the main repo that double checks links/images aren't broken when they cross sub-repos.
i believe hugo will already catch in-repo broken links.
There was a problem hiding this comment.
Yeah, and once I have a more tested solution we should be able to have full cross-site link checking in source project CI. I still need a GitHub App and a little testing to iron out some of the UX kinks but I have a PoC.
It also simplifies our linking rules which at the moment are a bit complicated thanks to the separation of source projects.
There was a problem hiding this comment.
Putting the CI for broken images in the website repository makes sense.
| @@ -45,7 +45,7 @@ That trace ID enables one to trace, or follow a request as it flows from node to | |||
|
|
|||
| Here's an example showing two pages in Grafana Cloud. The first, on the left (1), shows a query using the **Explore** feature. In the query results you can see a **traceID** field that was added to an application. That field contains a **Tempo** trace ID. The second page, on the right (2), uses the same Explore feature to perform a Tempo search using that **trace ID**. It then shows a set of spans as horizontal bars, each bar denoting a different part of the system. | |||
|
|
|||
| <p align="center"><img src="../getting-started/assets/trace-explore-spans.png" alt="Trace example"></p> | |||
|  | |||
There was a problem hiding this comment.
silly Q. does the leading ! make it an image link?
|
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-2767-to-release-v2.2 origin/release-v2.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 37fc00ef097619a796dde0ff60477c7befa1f1f4
# When the conflicts are resolved, stage and commit the changes
git add . && git cherry-pick --continueIf you have the GitHub CLI installed: # Create the PR body template
PR_BODY=$(gh pr view 2767 --json body --template 'Backport 37fc00ef097619a796dde0ff60477c7befa1f1f4 from #2767{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Push the branch to GitHub and a PR
echo "${PR_BODY}" | gh pr create --title "[release-v2.2] [DOC] Update screenshots tracing" --body-file - --label "type/docs" --label "backport" --base release-v2.2 --milestone release-v2.2 --webOr, if you don't have the GitHub CLI installed (we recommend you install it!): # If you don't have the GitHub CLI installed: Push the branch to GitHub and manually create a PR:
git push --set-upstream origin backport-2767-to-release-v2.2
# Remove the local backport branch
git switch main
git branch -D backport-2767-to-release-v2.2Unless you've used the GitHub CLI above, now create a pull request where the |
* [DOC] Update screenshots tracing (#2767) * Change screenshots to use GCP * Remove conflict images * Update grafana/dskit dependency (#2773) * Update grafana/dskit dependency * go mod tidy all the go.mod's * Update dskit again to catch patch fix * Check in all of vendor/ * GetMetrics use second pass (#2765) * traceqlmetris use second pass for more correct output. However super messy memory pooling required to keep things from exploding * Expose parquetquery methods better * comment * Move Release() to the spanset instead of the Fetcher interface, much less churn * cleanup, simplification * cleanup * Small cleanup * Apply same pooling changes to vparquet3. Update benchmark to verify expected test block version * fix test * changelog * Refactor user-configurable overrides API and client; add detailed logging (#2755) * Refactor user-configurable overrides API and client * Refactor user-configurable overrides API and client * Bug smash * Replace weaveworks imports * 🤦 * Address why GCS is faling e2e test * Add patch to e2e test * Sprinkle some more println in tests * Update various OTel dependencies (#2778) * Update various OTel dependencies * Breaking changes, fix compilation issues --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Martin Disibio <martin.disibio@grafana.com>
What this PR does:
Moved a screenshot to the google cloud storage and updated two links to the image in the best practices and tracing.md docs.
Which issue(s) this PR fixes:
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]