[Merged by Bors] - docs: Add section about using Tracy for profiling #4534

superdump · 2022-04-19T10:59:32Z

Objective

Document how to do profiling with Tracy

Solution

The documentation of setting RUST_LOG=info in order to capture wgpu spans depends on [Merged by Bors] - Enable wgpu profiling spans when using bevy's trace feature #5182

docs/profiling.md

alice-i-cecile · 2022-05-16T20:08:15Z

docs/profiling.md

+
+There are binaries available for Windows, and installation / build instructions for other operating systems can be found in the [Tracy documentation PDF](https://github.com/wolfpld/tracy/releases/latest/download/tracy.pdf).
+
+It has a command line capture tool that can be used for capturing with minimal disruption to the execution of graphical applications, saving the profile data to a file. It also has a GUI that can be used to inspect these profile files, or live capture them, though running the live capture on the same machine will be a competing graphical application, which may impact results. As such, @superdump tends to use the command line to for capturing, and the GUI tool for inspecting.


Please line break your .md paragraphs; it makes for cleaner git changes.

I disagree for text because then I end up re-joining and re-splitting all the lines whenever any words change, which creates a lot of noise. If they are on one line, in GitHub's UI only the changed words are highlighted. Plus none of the other existing paragraphs in this document are split across multiple lines. I won't resist on this point if you want us to consistently split paragraphs onto multiple lines in documentation though as I respect your ownership of docs more than my own opinions on it. :)

alice-i-cecile · 2022-05-16T20:08:33Z

docs/profiling.md

+
+There are binaries available for Windows, and installation / build instructions for other operating systems can be found in the [Tracy documentation PDF](https://github.com/wolfpld/tracy/releases/latest/download/tracy.pdf).
+
+It has a command line capture tool that can be used for capturing with minimal disruption to the execution of graphical applications, saving the profile data to a file. It also has a GUI that can be used to inspect these profile files, or live capture them, though running the live capture on the same machine will be a competing graphical application, which may impact results. As such, @superdump tends to use the command line to for capturing, and the GUI tool for inspecting.


What does "capturing" mean?

I'll clarify this, but it means 'receiving and recording profile data.' The Tracy tool is called 'capture'.

I feel like nicopap's rewording already makes this much clearer so I left it as-is after their change was committed. Let me know if you think it needs further clarification.

docs/profiling.md

alice-i-cecile

Some nits, but I'll block on the explicit mention of your username :)

I'm very glad to have this; seems extremely useful.

laundmo · 2022-06-26T19:53:34Z

This is still blocked on the username mention i assume? i ended up referring people to this PR multiple times by now, and would really appreciate it taken care of soon.

alice-i-cecile · 2022-06-26T20:04:09Z

Just needs the author (@superdump) to clean up a couple of the nits. @laundmo if you're feeling up for it feel free to make a competing version of this with the fixes and we can merge that ASAP.

superdump · 2022-06-28T11:36:32Z

I can update it sometime before the end of the week.

Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

superdump · 2022-07-04T08:53:20Z

This now provides information that depends on #5182

superdump · 2022-07-04T09:14:43Z

bors try

bors · 2022-07-04T09:28:25Z

try

Build failed:

markdownlint

superdump · 2022-07-04T09:35:52Z

bors try

bors · 2022-07-04T09:55:09Z

try

Build failed:

markdownlint

superdump · 2022-07-04T10:04:01Z

Pffft flakey link checker.

mockersf · 2022-07-04T10:06:07Z

well...

it's not the link checker, it's the markdown lint - it was removed in [Merged by Bors] - Remove markdown dead link check #4839
it's not flakey when it's failing every time
it's complaining that you used html tags for images

superdump · 2022-07-04T10:13:41Z

well...

* it's not the link checker, it's the markdown lint - it was removed in [[Merged by Bors] - Remove markdown dead link check #4839](https://github.com/bevyengine/bevy/pull/4839)

Aha. I looked at the big bold red ERRORs starting at the top and saw the failure to get a GitHub token and I thought it was only the dead link check in markdown that used that.

* it's not flakey when it's failing every time

Given other PRs were passing and I saw the GitHub token failure that I have seen so many times before, I figured it was temporarily failing. The boy who cried wolf. :)

* it's complaining that you used html tags for images

Righto, I missed those lines because despite being important information, they are not highlighted in red. 😄 I'll fix them.

superdump · 2022-07-04T10:28:34Z

Tests pass when you read, see, understand, and fix the errors that they report! \o/

nicopap

I've used this recently as a reference for #4240. I think a future PR could add a couple things:

Add a section about comparing two traces with tracy
Add a link to the tracing-tracy crate here for example, especially the table at the end of the README with the version matrix, and state the version used in bevy, so that the reader can at a glance know which tracy version to use.

laundmo · 2022-07-04T16:53:35Z

so that the reader can at a glance know which tracy version to use.

is it good to postpone that? speaking from experience it can lead to a lot of frustration...

alice-i-cecile · 2022-07-04T17:31:30Z

It's better to keep PRs small. I'll spin those off into new issues.

bors r+

# Objective - Document how to do profiling with Tracy # Solution - The documentation of setting `RUST_LOG=info` in order to capture `wgpu` spans depends on #5182

bors · 2022-07-04T17:46:01Z

Pull request successfully merged into main.

Build succeeded:

# Objective - Document how to do profiling with Tracy # Solution - The documentation of setting `RUST_LOG=info` in order to capture `wgpu` spans depends on bevyengine#5182

docs: Add section about using Tracy for profiling

c079018

github-actions bot added the S-Needs-Triage This issue needs to be labelled label Apr 19, 2022

superdump added C-Docs An addition or correction to our documentation C-Performance A change motivated by improving speed, memory usage or compile times and removed S-Needs-Triage This issue needs to be labelled labels Apr 19, 2022

mockersf reviewed Apr 20, 2022

View reviewed changes

docs/profiling.md Outdated Show resolved Hide resolved

nicopap reviewed Apr 25, 2022

View reviewed changes

docs/profiling.md Outdated Show resolved Hide resolved

nicopap reviewed Apr 25, 2022

View reviewed changes

docs/profiling.md Outdated Show resolved Hide resolved

hymm reviewed Apr 29, 2022

View reviewed changes

docs/profiling.md Show resolved Hide resolved

alice-i-cecile reviewed May 16, 2022

View reviewed changes

docs/profiling.md Outdated Show resolved Hide resolved

alice-i-cecile requested changes May 16, 2022

View reviewed changes

superdump and others added 8 commits July 4, 2022 10:32

Clarify the location of the Tracy statistics button in its UI

e118139

Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

Restructure Tracy capabilities and usage

18a5c5f

Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

Improve alt-text on Tracy profile timeline image

aaa2de6

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

Merge branch 'main' into docs-profiling-tracy

1e45271

Clarify Tracy capture.exe name on Windows

f8796e5

Improve Tracy example image alt-text

f7a5d81

Strip some trailing whitespace

9d3c7be

Add a section about how to capture wgpu spans when profiling

fb22d0e

superdump requested review from alice-i-cecile and mockersf July 4, 2022 08:54

bors bot added a commit that referenced this pull request Jul 4, 2022

Try #4534:

faa6383

bors bot added a commit that referenced this pull request Jul 4, 2022

Try #4534:

1844caf

profiling.md: Use markdown inline image syntax instead of HTML

38e00cc

alice-i-cecile approved these changes Jul 4, 2022

View reviewed changes

alice-i-cecile requested a review from hymm July 4, 2022 12:36

nicopap approved these changes Jul 4, 2022

View reviewed changes

This was referenced Jul 4, 2022

Document how to compare two tracy traces for profiling #5199

Closed

Link to tracy's version compatibility chart #5200

Closed

bors bot changed the title ~~docs: Add section about using Tracy for profiling~~ [Merged by Bors] - docs: Add section about using Tracy for profiling Jul 4, 2022

bors bot closed this Jul 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - docs: Add section about using Tracy for profiling #4534

[Merged by Bors] - docs: Add section about using Tracy for profiling #4534

superdump commented Apr 19, 2022 •

edited

Loading

alice-i-cecile May 16, 2022

superdump Jul 4, 2022

alice-i-cecile May 16, 2022

superdump Jul 4, 2022

superdump Jul 4, 2022 •

edited

Loading

alice-i-cecile left a comment

laundmo commented Jun 26, 2022

alice-i-cecile commented Jun 26, 2022

superdump commented Jun 28, 2022

superdump commented Jul 4, 2022

superdump commented Jul 4, 2022

bors bot commented Jul 4, 2022

superdump commented Jul 4, 2022

bors bot commented Jul 4, 2022

superdump commented Jul 4, 2022

mockersf commented Jul 4, 2022 •

edited

Loading

superdump commented Jul 4, 2022

superdump commented Jul 4, 2022

nicopap left a comment

laundmo commented Jul 4, 2022

alice-i-cecile commented Jul 4, 2022

bors bot commented Jul 4, 2022


		There are binaries available for Windows, and installation / build instructions for other operating systems can be found in the [Tracy documentation PDF](https://github.com/wolfpld/tracy/releases/latest/download/tracy.pdf).

		It has a command line capture tool that can be used for capturing with minimal disruption to the execution of graphical applications, saving the profile data to a file. It also has a GUI that can be used to inspect these profile files, or live capture them, though running the live capture on the same machine will be a competing graphical application, which may impact results. As such, @superdump tends to use the command line to for capturing, and the GUI tool for inspecting.

[Merged by Bors] - docs: Add section about using Tracy for profiling #4534

[Merged by Bors] - docs: Add section about using Tracy for profiling #4534

Conversation

superdump commented Apr 19, 2022 • edited Loading

Objective

Solution

alice-i-cecile May 16, 2022

Choose a reason for hiding this comment

superdump Jul 4, 2022

Choose a reason for hiding this comment

alice-i-cecile May 16, 2022

Choose a reason for hiding this comment

superdump Jul 4, 2022

Choose a reason for hiding this comment

superdump Jul 4, 2022 • edited Loading

Choose a reason for hiding this comment

alice-i-cecile left a comment

Choose a reason for hiding this comment

laundmo commented Jun 26, 2022

alice-i-cecile commented Jun 26, 2022

superdump commented Jun 28, 2022

superdump commented Jul 4, 2022

superdump commented Jul 4, 2022

bors bot commented Jul 4, 2022

try

superdump commented Jul 4, 2022

bors bot commented Jul 4, 2022

try

superdump commented Jul 4, 2022

mockersf commented Jul 4, 2022 • edited Loading

superdump commented Jul 4, 2022

superdump commented Jul 4, 2022

nicopap left a comment

Choose a reason for hiding this comment

laundmo commented Jul 4, 2022

alice-i-cecile commented Jul 4, 2022

bors bot commented Jul 4, 2022

superdump commented Apr 19, 2022 •

edited

Loading

superdump Jul 4, 2022 •

edited

Loading

mockersf commented Jul 4, 2022 •

edited

Loading