From 4717bd9e494280d2fc8d96decd30c47f43d6408f Mon Sep 17 00:00:00 2001 From: James Liu Date: Wed, 7 Dec 2022 22:57:27 +0000 Subject: [PATCH] Docs: Show how to compare two different traces in Tracy (#6869) # Objective Fixes #5199. ## Solution Mention how to compare two different saved tracy traces in the profiling section. --- docs/profiling.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/profiling.md b/docs/profiling.md index 8c9ba24115515..67db06825e02a 100644 --- a/docs/profiling.md +++ b/docs/profiling.md @@ -48,6 +48,10 @@ Or you can select an individual system and inspect its statistics (available thr ![A graph and statistics in the Tracy GUI showing the distribution of execution times of an instrumented span in the application](https://user-images.githubusercontent.com/302146/163988464-86e1a3ee-e97b-49ae-9f7e-4ff2b8b761ad.png) +If you save more than one trace, you can compare the spans between both of them by clicking the `Compare` button at the top of the UI. This will open a dialog box asking to load a second trace. From there, it's possible to select any family of spans to more closely compare the timing and distribution of a particular span. + +![A graph and statistics in the Tracy GUI comparing the distribution of execution times of an instrumented span across two traces](https://user-images.githubusercontent.com/3137680/205834698-84405b2f-97b5-43a3-9dba-385167ac1db5.png) + ### Adding your own spans Add spans to your app like this (these are in `bevy::prelude::*` and `bevy::log::*`, just like the normal logging macros).