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

Document how to use memory profiling #8417

Closed
alice-i-cecile opened this issue Apr 17, 2023 · 4 comments · Fixed by #13755
Closed

Document how to use memory profiling #8417

alice-i-cecile opened this issue Apr 17, 2023 · 4 comments · Fixed by #13755
Labels
A-Diagnostics Logging, crash handling, error reporting and performance analysis C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alice-i-cecile
Copy link
Member

          Not going to block on it, but we should have something for how to use the feature in `profiling.md`.

Originally posted by @hymm in #8272 (review)

We should also encourage users to keep this off when profiling except when explicitly needed due to the high overhead.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-Diagnostics Logging, crash handling, error reporting and performance analysis labels Apr 17, 2023
@Mohamed-khattab
Copy link

Mohamed-khattab commented Apr 19, 2023

hello @alice-i-cecile ,

I am interested in contributing to the Beavy project on GitHub.
As a new contributor, I would like to work on resolving this issue by creating the requested document. I believe that this will be a great opportunity for me to learn more about open source development and contribute to the project.

Before I proceed, I would like to confirm with you if the issue is still open and available for contributions. Additionally, I would appreciate any suggestions or feedback you may have to help me get started with creating the document.

@alice-i-cecile
Copy link
Member Author

Great :) This is still available.

In order to turn this on, you need to enable the cargo feature added here when running your app.

This is the file we should be modifying: https://github.com/bevyengine/bevy/blob/main/docs/profiling.md :) Try your best to get tracy set up on your PC so you can test that the instructions work too! If you get stuck in the install process, post a new Discussion here for troubleshooting help so others can Google errors you run into in the future.

@theotherphil
Copy link
Contributor

theotherphil commented Jun 7, 2024

@mockersf I've just tried using your Tracy memory profiling feature on a MacBook in order to update the docs for this issue.

When trying it out, the Zone Info tab in Tracy shows something similar to your PR:

Screenshot 2024-06-07 at 21 41 16

However, the Memory tab is missing function names for the call stacks:
Screenshot 2024-06-07 at 21 43 30

Screenshot 2024-06-07 at 21 47 37

(Screenshots unhelpfully and somewhat irrationally truncated to not include my full name.)

Is this something that you would expect to work, or should I add a note in the docs that this isn't supported?

@mockersf
Copy link
Member

mockersf commented Jun 8, 2024

probably not supported for now!

github-merge-queue bot pushed a commit that referenced this issue Jun 25, 2024
# Objective

Document how to use Tracy memory profiling.

Fixes #8417.

## Solution

Expand Tracy documentation in profiling.md.

## Testing

New documentation tested manually; no code changes made.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Diagnostics Logging, crash handling, error reporting and performance analysis C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants