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

docs: Add notice about heap profiling #3494

Merged
merged 1 commit into from
Aug 19, 2024

Conversation

simonswine
Copy link
Contributor

@simonswine simonswine commented Aug 16, 2024

This was a profiler in the dotnet sdk I noticed we are missing.

This was something I noticed we are missing.
@simonswine simonswine added type/docs Improvements for doc docs. Used by Docs team for project management backport release/v1.7 This label will backport a merged PR to the release/v1.7 branch labels Aug 16, 2024
@simonswine simonswine marked this pull request as ready for review August 16, 2024 13:36
@simonswine simonswine requested review from a team as code owners August 16, 2024 13:36
Copy link
Contributor

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

1 similar comment
Copy link
Contributor

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

Copy link
Collaborator

@korniltsev korniltsev left a comment

Choose a reason for hiding this comment

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

I am certain there was a reason we removed live heap from the docs.
I don't remember and could not find the exact reason though.

@aleks-p
Copy link
Contributor

aleks-p commented Aug 16, 2024

Looks like it was added after the others?
grafana/pyroscope-dotnet#22

Copy link
Contributor

@knylander-grafana knylander-grafana left a comment

Choose a reason for hiding this comment

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

Thank you for updating the docs and the table!

@knylander-grafana
Copy link
Contributor

I am certain there was a reason we removed live heap from the docs. I don't remember and could not find the exact reason though.

Are there any caveats that go along with this option?

@simonswine
Copy link
Contributor Author

Are there any caveats that go along with this option?

We are not fully sure, at least it requiers .Net 7.0+. Let's document the flag it will be still default off.

@simonswine simonswine merged commit c40ee84 into grafana:main Aug 19, 2024
20 checks passed
github-actions bot pushed a commit that referenced this pull request Aug 19, 2024
This was something I noticed we are missing.

(cherry picked from commit c40ee84)
Copy link
Contributor

The backport to release/v1.7 failed:

Validation Failed: "Could not resolve to a node with the global id of 'T_kwDOAG3Mbc4AczmP'."

To backport manually, run these commands in your terminal:

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

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-3494-to-release/v1.7
# Create the PR body template
PR_BODY=$(gh pr view 3494 --json body --template 'Backport c40ee842d6a0a11666ad415bfc3d70c2db957b07 from #3494{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release/v1.7] docs: Add notice about heap profiling' --body-file - --label 'type/docs' --label 'backport' --base release/v1.7 --milestone release/v1.7 --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-3494-to-release/v1.7

# Create a pull request where the `base` branch is `release/v1.7` and the `compare`/`head` branch is `backport-3494-to-release/v1.7`.

# Remove the local backport branch
git switch main
git branch -D backport-3494-to-release/v1.7

simonswine added a commit that referenced this pull request Aug 19, 2024
This was something I noticed we are missing.

(cherry picked from commit c40ee84)

Co-authored-by: Christian Simon <simon@swine.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release/v1.7 This label will backport a merged PR to the release/v1.7 branch backport-failed type/docs Improvements for doc docs. Used by Docs team for project management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants