Add per-node granularity to Profiler bottom panel

MartinHaeusler commented 6 months ago

Describe the project you are working on

A 3D card game

Describe the problem or limitation you are having in your project

One of my _process functions was causing a major lag in my game and I was trying to find out which one it is among my 100+ scripts. However, the godot profiler only shows the total process time without any possibility to further break it up:

So... which script was it?

Describe the feature / enhancement and how it helps to overcome the problem or limitation

Please allow the user to drill down into the process time. Ideally, the view should allow to break it down:

by node type / script name
by node name

The "long tail" isn't really interesting, knowing the top 5 slowest would already be enough.

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

Make the process time expandable:

 - Process Time: 100ms
   - GameMaster: 50ms
   - BosseEnemy: 25ms

If this enhancement will not be used often, can it be worked around with a few lines of script?

Manually measuring time and logging it is an option, but a bad one when you don't know which script causes the lag.

Is there a reason why this should be core and not an add-on in the asset library?

Profiler is part of the core.

Calinou commented 6 months ago

Related to https://github.com/godotengine/godot-proposals/issues/6809.

Unfortunately, I don't think per-node granularity on process time is feasible for two reasons:

It sounds extremely difficult to track which script is being run in which node, as there's no 1:1 mapping between nodes and scripts.
In certain scenarios, most of the process time is spent in the engine itself, rather than in any script. It used not to even always be indicated in the profiler until 4.3 (https://github.com/godotengine/godot/issues/23715), but that should be fixed now.

MartinHaeusler commented 6 months ago

I fully understand that this isn't an easy thing to accomplish. But if you're in a situation where a script is running wild and eats too much processing time, how else should we find it among hundreds of scripts? I also wouldn't mind if the profiler would slow down my overall game performance while it's collecting data (as long as it doesn't distort the outcome too much). This isn't something you'd want to have up and running all the time.

godotengine / godot-proposals