[DOC] Update Configure the client and span profiles doc #3028
Conversation
This file contains 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
knylander-grafana
added
the
type/docs
knylander-grafana
changed the title
| 2. Optional: Choose any tags to use in the query. If left blank, the default values of service.name and service.namespace are used. | ||
|
|
||
| The tags you configure must be present in the spans attributes or resources for a trace to profiles span link to appear. You can optionally configure a new name for the tag. This is useful for example if the tag has dots in the name and the target data source doesn’t allow using dots in labels. In that case you can for example remap service.name to service_name. | ||
| ## View the span profiles in Grafana or Grafana Cloud | ||
|
|
There was a problem hiding this comment.
We have the full content for Traces to profiles in the Pyroscope documentation. I removed the content from the Traces to profiles and linked to the page instead.
Doc is here: https://grafana.com/docs/pyroscope/next/view-and-analyze-profile-data/profile-tracing/traces-to-profiles/
We can make it live. It's currently in /next. Not sure why it isn't live.
| @@ -7,38 +7,52 @@ weight: 100 | |||
|
|
|||
| # Span profiles with Traces to profiles for Go | |||
|
|
|||
There was a problem hiding this comment.
The blog post about span profiles has some great content, so I used a few of the paragraphs for the introduction and linked to the blog post.
|
@kolesnikovae Thank you for the review! Should the wording for your comment above be application-wide or system-wide? |
knylander-grafana
added
the
backport release/v1.4
|
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-3028-to-release/v1.4 origin/release/v1.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 87423e4c3f2c7a21323d8e9290220c382350c5fbWhen 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-3028-to-release/v1.4
# Create the PR body template
PR_BODY=$(gh pr view 3028 --json body --template 'Backport 87423e4c3f2c7a21323d8e9290220c382350c5fb from #3028{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "[release/v1.4] [DOC] Update Configure the client and span profiles doc" --body-file - --label "type/docs" --label "backport" --base release/v1.4 --milestone release/v1.4 --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-3028-to-release/v1.4
# Create a pull request where the `base` branch is `release/v1.4` and the `compare`/`head` branch is `backport-3028-to-release/v1.4`.
# Remove the local backport branch
git switch main
git branch -D backport-3028-to-release/v1.4 |
knylander-grafana
added a commit
that referenced
this pull request
Feb 29, 2024
* Update Configure the client page * Update Span Profiles doc * Apply suggestions from code review * fix broken link from validator * Update _index.md * Update docs/sources/configure-client/go-span-profiles.md (cherry picked from commit 87423e4)
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.
This PR does two things:
Fixes #2771