Add diagnostic metrics/activities #18314

maxkatz6 · 2025-02-25T12:14:03Z

What does the pull request do?

Histogram metrics
avalonia.comp.render.time
avalonia.comp.update.time
avalonia.ui.measure.time
avalonia.ui.arrange.time
avalonia.ui.render.time
avalonia.ui.input.time
Observable updowncount metrics
avalonia.ui.event.handler.count
avalonia.ui.visual.count
avalonia.ui.dispatcher.timer.count
Activities:
Avalonia.AttachingStyle
Avalonia.FindingResource
Avalonia.EvaluatingStyle
Avalonia.MeasuringLayoutable
Avalonia.ArrangingLayoutable
Avalonia.PerformingHitTest
Avalonia.RaisingRoutedEvent

These are not considered a public API and might be removed or changed. As it's likely we didn't get things right on the first try.
We also might want to split histogram metrics per TopLevel. But probably not in this PR.

What is the updated/expected behavior with this PR?

RuntimeCongig Avalonia.Diagnostics.Diagnostic.IsEnabled enabled these meters and activities. Disabled by default.
Additionally, metrics can be additionally disabled via built-in System.Diagnostics.Metrics.Meter.IsSupported.

Fixed issues

Fixes #12032

Benchmarks

Benchmarks without any listeners, just master + with runtime config enabled + without runtime config enabled.
Just to see if this PR doesn't regress anything.
In summary, when Avalonia.Diagnostics.Diagnostic.IsEnabled is enabled, some code paths, especially style attaching, is noticably slower on becnmarks. Makes sense to keep it disabled by default.

Remeasure

master

Method	Mean	Error	StdDev	Gen0	Allocated
Remeasure	2.681 ms	0.0536 ms	0.0785 ms	7.8125	76.85 KB

with enabled runtime config

Method	Mean	Error	StdDev	Median	Gen0	Allocated
Remeasure	2.843 ms	0.0615 ms	0.1784 ms	2.766 ms	7.8125	76.85 KB

with disabled runtime config (default)

Method	Mean	Error	StdDev	Median	Gen0	Allocated
Remeasure	2.730 ms	0.0645 ms	0.1892 ms	2.789 ms	7.8125	76.85 KB

FindPreResource + FindPostResource + FindNotExistingResource

master

Method	Mean	Error	StdDev	Allocated
FindPreResource	323.38 us	3.992 us	3.734 us	-
FindPostResource	12.60 us	0.153 us	0.143 us	-
FindNotExistingResource	362.47 us	4.056 us	3.595 us	-

with enabled runtime config

Method	Mean	Error	StdDev	Allocated
FindPreResource	336.48 us	1.867 us	1.559 us	-
FindPostResource	13.34 us	0.115 us	0.108 us	-
FindNotExistingResource	355.55 us	3.120 us	2.605 us	-

with disabled runtime config (default)

Method	Mean	Error	StdDev	Allocated
FindPreResource	351.47 us	3.093 us	2.893 us	-
FindPostResource	12.65 us	0.090 us	0.075 us	-
FindNotExistingResource	356.66 us	4.541 us	4.248 us	-

Apply_Simple_Styles

master

Method	MatchingStyles	NonMatchingStyles	Mean	Error	StdDev	Gen0	Gen1	Gen2	Allocated
Apply_Simple_Styles	1	1	190.2 ns	3.69 ns	4.93 ns	0.1404	0.0005	0.0002	1.15 KB
Apply_Simple_Styles	1	5	236.9 ns	5.95 ns	17.54 ns	0.1404	0.0005	0.0002	1.15 KB
Apply_Simple_Styles	1	50	587.3 ns	8.86 ns	7.40 ns	0.1402	-	-	1.15 KB
Apply_Simple_Styles	5	1	299.7 ns	6.03 ns	6.19 ns	0.1507	-	-	1.23 KB
Apply_Simple_Styles	5	5	325.3 ns	3.47 ns	3.25 ns	0.1507	-	-	1.23 KB
Apply_Simple_Styles	5	50	725.9 ns	14.51 ns	20.81 ns	0.1507	-	-	1.23 KB
Apply_Simple_Styles	50	1	1,705.0 ns	33.15 ns	44.25 ns	0.2651	-	-	2.18 KB
Apply_Simple_Styles	50	5	1,676.6 ns	33.52 ns	69.97 ns	0.2651	-	-	2.18 KB
Apply_Simple_Styles	50	50	1,922.0 ns	26.38 ns	22.03 ns	0.2632	-	-	2.18 KB

with enabled runtime config

Method	MatchingStyles	NonMatchingStyles	Mean	Error	StdDev	Gen0	Gen1	Allocated
Apply_Simple_Styles	1	1	202.7 ns	3.92 ns	3.85 ns	0.1404	0.0005	1.15 KB
Apply_Simple_Styles	1	5	302.4 ns	6.03 ns	7.18 ns	0.1402	0.0005	1.15 KB
Apply_Simple_Styles	1	50	1,340.0 ns	26.31 ns	46.08 ns	0.1392	-	1.15 KB
Apply_Simple_Styles	5	1	364.7 ns	5.76 ns	5.39 ns	0.1507	-	1.23 KB
Apply_Simple_Styles	5	5	457.9 ns	6.02 ns	5.34 ns	0.1507	-	1.23 KB
Apply_Simple_Styles	5	50	1,450.9 ns	19.74 ns	18.47 ns	0.1507	-	1.23 KB
Apply_Simple_Styles	50	1	2,012.9 ns	24.76 ns	23.16 ns	0.2632	-	2.18 KB
Apply_Simple_Styles	50	5	2,104.4 ns	30.01 ns	28.08 ns	0.2632	-	2.18 KB
Apply_Simple_Styles	50	50	3,123.6 ns	51.32 ns	48.00 ns	0.2632	-	2.18 KB

with disabled runtime config (default)

Method	MatchingStyles	NonMatchingStyles	Mean	Error	StdDev	Gen0	Gen1	Allocated
Apply_Simple_Styles	1	1	188.1 ns	3.77 ns	5.04 ns	0.1404	0.0005	1.15 KB
Apply_Simple_Styles	1	5	221.5 ns	4.41 ns	4.72 ns	0.1404	0.0005	1.15 KB
Apply_Simple_Styles	1	50	621.4 ns	7.46 ns	6.98 ns	0.1402	-	1.15 KB
Apply_Simple_Styles	5	1	306.9 ns	5.31 ns	4.96 ns	0.1507	-	1.23 KB
Apply_Simple_Styles	5	5	337.3 ns	2.48 ns	2.20 ns	0.1507	-	1.23 KB
Apply_Simple_Styles	5	50	684.4 ns	1.90 ns	1.77 ns	0.1507	-	1.23 KB
Apply_Simple_Styles	50	1	1,574.7 ns	5.29 ns	4.69 ns	0.2651	-	2.18 KB
Apply_Simple_Styles	50	5	1,591.5 ns	4.50 ns	3.76 ns	0.2651	-	2.18 KB
Apply_Simple_Styles	50	50	1,952.9 ns	3.82 ns	3.38 ns	0.2632	-	2.18 KB

Apply_Detach_Styles

master

Method	Mean	Error	StdDev	Gen0	Allocated
Apply_Detach_Styles	13.64 us	0.267 us	0.467 us	0.6256	5.12 KB

with enabled runtime config

Method	Mean	Error	StdDev	Gen0	Allocated
Apply_Detach_Styles	22.19 us	0.210 us	0.197 us	0.6104	5.12 KB

with disabled runtime config (default)

Method	Mean	Error	StdDev	Gen0	Allocated
Apply_Detach_Styles	12.87 us	0.048 us	0.045 us	0.6256	5.12 KB

Apply style

master

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
Apply	112.6 ns	2.22 ns	3.78 ns	0.0415	0.0020	348 B
Apply_Toggle	1,023.2 ns	14.39 ns	13.46 ns	0.0415	0.0012	356 B
Apply_Detach	135.1 ns	0.76 ns	0.72 ns	0.0415	0.0014	348 B

with enabled runtime config

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
Apply	124.5 ns	0.74 ns	0.62 ns	0.0415	0.0020	348 B
Apply_Toggle	2,016.0 ns	27.18 ns	25.42 ns	0.0415	-	356 B
Apply_Detach	143.8 ns	2.75 ns	2.82 ns	0.0415	0.0014	348 B

with disabled runtime config (default)

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
Apply	105.7 ns	0.27 ns	0.24 ns	0.0415	0.0020	348 B
Apply_Toggle	1,083.7 ns	1.70 ns	1.42 ns	0.0415	0.0012	356 B
Apply_Detach	123.0 ns	0.45 ns	0.39 ns	0.0415	0.0014	348 B

…targets

avaloniaui-bot · 2025-02-25T12:45:46Z

You can test this PR using the following package version. 11.3.999-cibuild0055143-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

MrJul · 2025-03-05T15:13:46Z

src/Avalonia.Base/Diagnostics/Diagnostic.Metrics.cs

+    public static void InitMetrics()
+    {
+        // Metrics
+        var meter = new Meter("Avalonia.Diagnostic.Meter");


Shouldn't that be Avalonia.Diagnostics.Meter or Avalonia.Diagnostics.Diagnostic.Meter?

This name is public (for listeners, and also devtools UI), so I made it shorter. I don't have strong opinion though.

maxkatz6 added 17 commits January 20, 2025 23:55

Add System.Diagnostics.DiagnosticSource nuget package for pre-.NET 8 …

b5ef89e

…targets

Move System.Memory reference to Base.props

be64b22

Add CompositorRenderPass and CompositorUpdatePass metrics

a65d729

Layout measure/arrange pass metrics

8a33eaa

Add UI render pass and input pass meters

83b67f9

Add observable metrics

c6de7a8

Add RaisingRoutedEvent activity

b1df81c

Add FindingResourceActivity activity

4b97ee1

Add AttachingStyleActivity and EvaluatingStyleActivator activities

68eddc9

Add PerformingHitTest activity

b841fe8

Add MeasuingLayoutable/ArrangingLayoutable activities

81f9cd0

Missed RaisingRoutedEvent definition

c8e5828

Missed tag definitions

81e0cef

Start FindingResourceActivity on static resources too

f9f18bd

Fix compilation

05ab25d

Naming

ffc2570

Merge remote-tracking branch 'origin/master' into dev-tools-profiling

fec3f16

maxkatz6 added the feature label Feb 25, 2025

maxkatz6 added 3 commits March 4, 2025 22:14

Add Avalonia.Diagnostics.Diagnostic.IsEnabled runtime switch

472c4b2

Maybe make it more trimmable as well

0da1010

Merge branch 'master' into dev-tools-profiling

d626567

maxkatz6 marked this pull request as ready for review March 5, 2025 14:20

MrJul reviewed Mar 5, 2025

View reviewed changes

MrJul approved these changes Mar 5, 2025

View reviewed changes

maxkatz6 added this pull request to the merge queue Mar 6, 2025

Merged via the queue into master with commit acd4653 Mar 6, 2025
10 checks passed

maxkatz6 deleted the dev-tools-profiling branch March 6, 2025 12:07

fforjan mentioned this pull request Mar 7, 2025

Accessing RenderTime and Fps ? #18374

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add diagnostic metrics/activities #18314

Add diagnostic metrics/activities #18314

Uh oh!

maxkatz6 commented Feb 25, 2025 •

edited

Loading

Uh oh!

avaloniaui-bot commented Feb 25, 2025

Uh oh!

MrJul Mar 5, 2025 •

edited

Loading

Uh oh!

maxkatz6 Mar 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add diagnostic metrics/activities #18314

Add diagnostic metrics/activities #18314

Uh oh!

Conversation

maxkatz6 commented Feb 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does the pull request do?

What is the updated/expected behavior with this PR?

Fixed issues

Benchmarks

master

with enabled runtime config

with disabled runtime config (default)

master

with enabled runtime config

with disabled runtime config (default)

master

with enabled runtime config

with disabled runtime config (default)

master

with enabled runtime config

with disabled runtime config (default)

master

with enabled runtime config

with disabled runtime config (default)

Uh oh!

avaloniaui-bot commented Feb 25, 2025

Uh oh!

MrJul Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maxkatz6 Mar 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

maxkatz6 commented Feb 25, 2025 •

edited

Loading

MrJul Mar 5, 2025 •

edited

Loading