[DOC] Add traces to profile content #2980
Merged
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
cyriltovena
reviewed
Feb 1, 2024
| Pyroscope offers both a Command Line Interface (CLI) and an Application Programming Interface (API) to interact with and retrieve profiling data. These tools provide flexibility in how you access and manage your profiling information. | ||
|
|
||
| You can export profiling data from Pyroscope in various formats: | ||
| - **JSON**: JSON object easy to integrate with other tools and scripts |
There was a problem hiding this comment.
The most popular is pprof and we support that, to be precised it gzip compressed pprof foo.pprof.gz
There was a problem hiding this comment.
Added pprof and removed dot.
docs/sources/view-and-analyze-profile-data/profile-tracing/traces-to-profiles.md
Outdated
Show resolved
Hide resolved
kolesnikovae
reviewed
Feb 5, 2024
|
Note that there is a link to a page that is created in #2982. The doc validator won't pass because of this broken link (until the other PR is merged). |
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-2980-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 2988c4329f2bac5348e8eccb22f55d53da9d7d75When 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-2980-to-release/v1.4
# Create the PR body template
PR_BODY=$(gh pr view 2980 --json body --template 'Backport 2988c4329f2bac5348e8eccb22f55d53da9d7d75 from #2980{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "[release/v1.4] [DOC] Add traces to profile content" --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-2980-to-release/v1.4
# Create a pull request where the `base` branch is `release/v1.4` and the `compare`/`head` branch is `backport-2980-to-release/v1.4`.
# Remove the local backport branch
git switch main
git branch -D backport-2980-to-release/v1.4 |
knylander-grafana
added a commit
that referenced
this pull request
Feb 29, 2024
* Add traces to profile content * Rename folder to view and analyze * Fix links * Update docs/sources/view-and-analyze-profile-data/_index.md * Apply suggestions from code review * Fix links * Apply suggestions from code review * Update docs/sources/view-and-analyze-profile-data/_index.md * Add link to PR 2982 content * Apply suggestions from code review (cherry picked from commit 2988c43)
knylander-grafana
added a commit
that referenced
this pull request
Feb 29, 2024
* [DOC] Add traces to profile content (#2980) * Add traces to profile content * Rename folder to view and analyze * Fix links * Update docs/sources/view-and-analyze-profile-data/_index.md * Apply suggestions from code review * Fix links * Apply suggestions from code review * Update docs/sources/view-and-analyze-profile-data/_index.md * Add link to PR 2982 content * Apply suggestions from code review (cherry picked from commit 2988c43) * Update docs/sources/configure-server/about-server-api.md
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.
Adds traces to profiles content from Grafana OSS and restructures the invest and analyze profile pages.
This is the updated table of contents with the traces to profiles content:
Fixes #2662