Skip to content

Add documentation on how to use Tracy and Perfetto #11484

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation on how to use Tracy and Perfetto #11484

wants to merge 1 commit into from
+398 −141

Conversation

@dsnopek
Copy link
Contributor

@dsnopek dsnopek commented Nov 21, 2025 •
edited
Loading

This takes the existing using_cpp_profilers.rst and moves it to be about "Sampling profilers" (sampling_profilers.rst), so that a new page can be added about "Tracing profilers" (like Perfetto and Tracy!) and makes the old URL into an index that explains the difference and links to both pages.

This is marked as DRAFT for the moment, because it only covers Perfetto - I actually haven't had a chance try Tracy yet :-)

@dsnopek dsnopek requested a review from Ivorforce November 21, 2025 16:47
@dsnopek dsnopek added enhancement area:engine details Issues and PRs related to the Engine Details section of the documentation labels Nov 21, 2025
@dsnopek dsnopek marked this pull request as draft November 21, 2025 16:47
AThousandShips
AThousandShips reviewed Nov 21, 2025
View reviewed changes
@dsnopek dsnopek force-pushed the tracing-profiler branch 3 times, most recently from 00cf4f1 to 74c46a5 Compare November 21, 2025 21:28
@dsnopek dsnopek changed the title [DRAFT] Add documentation on how to use Tracy and Perfetto Add documentation on how to use Tracy and Perfetto Nov 21, 2025
@dsnopek dsnopek marked this pull request as ready for review November 21, 2025 21:28
@dsnopek
Copy link
Contributor Author

dsnopek commented Nov 21, 2025

I've filled in the docs for Tracy now too, so taking this out of draft!

Given that I've only just tried Tracy for the first time, I'm very curious to hear if I'm using it correctly or not :-)

@dsnopek dsnopek force-pushed the tracing-profiler branch 2 times, most recently from aa775c7 to e5bd5a8 Compare November 21, 2025 22:40
Ivorforce
Ivorforce reviewed Nov 23, 2025
View reviewed changes
Copy link
Member

@Ivorforce Ivorforce left a comment

Choose a reason for hiding this comment

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

Looks really good!

AThousandShips
AThousandShips reviewed Nov 24, 2025
View reviewed changes
@dsnopek dsnopek force-pushed the tracing-profiler branch 2 times, most recently from 6bbb449 to 3b017d0 Compare November 24, 2025 21:51
@dsnopek
Copy link
Contributor Author

dsnopek commented Nov 24, 2025

@Ivorforce @AThousandShips Thanks for the review! I think I've integrated all your feedback in my latest push :-)

Ivorforce
Ivorforce approved these changes Nov 24, 2025
View reviewed changes
Copy link
Member

@Ivorforce Ivorforce left a comment

Choose a reason for hiding this comment

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

Looks great!

m4gr3d
m4gr3d reviewed Nov 25, 2025
View reviewed changes
engine_details/development/debugging/using_cpp_profilers.rst
@@ -1,3 +1,3 @@
.. _doc_using_cpp_profilers:

Using C++ profilers
Copy link
Contributor

@m4gr3d m4gr3d Nov 25, 2025

Choose a reason for hiding this comment

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

Should C++ be dropped from the page title and page path since both sampling and tracing profilers can be used for more than C++ applications and the Godot codebase contains other languages besides C++.

Copy link
Contributor Author

@dsnopek dsnopek Nov 25, 2025

Choose a reason for hiding this comment

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

I believe the "C++" is in there to distinguish it from Godot's profiler?

Copy link
Contributor

@m4gr3d m4gr3d Nov 25, 2025

Choose a reason for hiding this comment

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

I think the section is explicit enough that we could drop C++. For example, in the same section we have a using sanitizers page.

Copy link
Contributor Author

@dsnopek dsnopek Nov 25, 2025

Choose a reason for hiding this comment

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

I think sanitizers is a little different, though: there isn't a "Godot sanitizer" and "C++ sanitizers", whereas we do have a "Godot profiler" and "C++ profilers"

However, if we do rename it, I assume we'd want to keep the path the same so we don't have to deal with redirects?

Copy link
Contributor

@m4gr3d m4gr3d Nov 25, 2025

Choose a reason for hiding this comment

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

However, if we do rename it, I assume we'd want to keep the path the same so we don't have to deal with redirects?

yeah, keep things simpler.

m4gr3d
m4gr3d reviewed Nov 25, 2025
View reviewed changes
engine_details/development/debugging/profiling/tracing_profilers.rst
To learn more, see the
`Tracy manual <https://github.com/wolfpld/tracy/releases/latest/download/tracy.pdf>`_.

Perfetto for Android
Copy link
Contributor

@m4gr3d m4gr3d Nov 25, 2025

Choose a reason for hiding this comment

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

Worth including that it supports Win/Mac/Linux as well.

Copy link
Contributor Author

@dsnopek dsnopek Nov 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I don't think the way Godot has integrated it (at least so far) really supports Windows and Mac. It's setup to use the "system" backend, which requires connecting with Perfetto's system daemon which I think is only Linux and Android. If we added support for the "in process" backend we could add docs for how to use that later? The steps for using it would be somewhat different

m4gr3d
m4gr3d reviewed Nov 25, 2025
View reviewed changes
engine_details/development/debugging/profiling/tracing_profilers.rst
This will create a ``perfetto`` directory - you can place this anywhere.

Next, build the Android debug or release templates for your architecture using
Copy link
Contributor

@m4gr3d m4gr3d Nov 25, 2025

Choose a reason for hiding this comment

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

Are debug symbols not required for Perfetto?

Copy link
Contributor Author

@dsnopek dsnopek Nov 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Nope! Debug symbols are not required for Perfetto, or Tracy either, if you just use its tracing stuff and not its sampling features

AThousandShips
AThousandShips approved these changes Nov 25, 2025
View reviewed changes
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

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

Looks great!

@dsnopek dsnopek mentioned this pull request Nov 25, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@m4gr3d m4gr3d m4gr3d left review comments

@bruvzg bruvzg bruvzg left review comments

@Ivorforce Ivorforce Ivorforce approved these changes

@AThousandShips AThousandShips AThousandShips approved these changes

Assignees

No one assigned

Labels

area:engine details Issues and PRs related to the Engine Details section of the documentation enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@dsnopek @m4gr3d @Ivorforce @bruvzg @AThousandShips