Optimize your game with the Profile Analyzer - Unite Copenhagen 2019
Download as PPTX, PDF1 like3,708 views
The document provides an overview of Unity's Profile Analyzer, a tool designed to aid in CPU performance analysis by identifying focus areas, enabling comparisons between performance captures, and offering visual representations to improve understanding. It details features like UI components, filtering options, and profiling tips, along with examples of usage and comparison between different performance datasets. The tool is available as a preview package and aims to facilitate performance optimization efforts in Unity projects.
Optimize your game with the Profile Analyzer - Unite Copenhagen 2019
- 2. CPU Performance Analysis with Unity’s Profile Analyzer Lyndon Homewood Platforms Performance Team
- 3. Contents 3 — Introduction to Performance Analysis — What is the Profile Analyzer? — UI Overview — Examples — UI Breakdown — Recap, links
- 5. Where to start? 5 — Have you ever wondered where to focus your performance efforts? – Frame time data is so noisy – How can you identify a representative frame
- 6. Comparing Performance 6 — Have you ever tried to compare performance after a change? – Code change – Asset / Data change – Changing a project setting – Updating to a new Unity version – Switching platform — Or just compare between representative frame and a slow frame
- 7. Explaining performance 7 — How you ever needed to report on performance changes? – For your Technical Lead, CTO or investor – To help guide optimisation efforts of your team – Provide data in bug reports for Unity
- 8. A tool would help — The Profile Analyzer was written to solve those problems – Helps identify where to focus – Supports comparison between profile captures – Provides visual representations to aid understanding
- 9. Profile Analyzer — Complements the Unity Profiler — Multi frame CPU performance analysis – Statistics with visualisations — Comprehensive Filtering support — Allows comparison of two data sets
- 11. 11
- 12. Where do I get it from? 12 — Available as a preview package – 2018.4 LTS + — Or download directly – Drop into assets folder – 5.6 +
- 13. How do I launch it? 13 Launch from Window Menu : — Window / Analysis / Profile Analyzer Older versions : — Window / Profile Analyzer
- 14. UI Overview 14 — Key areas of the UI — Version 0.5
- 15. UI Overview 15 1. Frame Time graph 1
- 16. UI Overview 1. Frame Time graph 2. Filtering options 16 2 1
- 17. UI Overview 17 1. Frame Time graph 2. Filtering options 3. Top 10 Markers 3 1 2
- 18. UI Overview 18 1. Frame Time graph 2. Filtering options 3. Top 10 Markers 4. Marker Table 4 3 2 1
- 19. UI Overview 19 1. Frame Time graph 2. Filtering options 3. Top 10 Markers 4. Marker Table Summary areas 3 2 1 4
- 20. UI Overview 20 1. Frame Time graph 2. Filtering options 3. Top 10 Markers 4. Marker Table 5. Frame Summary 5 4 3 2 1
- 21. UI Overview 21 1. Frame Time graph 2. Filtering options 3. Top 10 Markers 4. Marker Table 5. Frame Summary 6. Thread Summary 6 5 4 3 2 1
- 22. UI Overview 22 1. Frame Time graph 2. Filtering options 3. Top 10 Markers 4. Marker Table 5. Frame Summary 6. Thread Summary 7. Marker Summary 7 6 5 4 3 2 1
- 24. Profiling tips — Setup repeatable capture – FPS Sample has random spawn point – Hacked in PreviewGameLoop.cs to fixed spawn point var offset = 3;// Random.Range(0, spawnpoints.Length); 24
- 25. Profiling tips — Close all applications other than the one you’re profiling – Use C# Profile.logFile to write out profile log file (.raw) – so you don’t need to have the editor running – https://docs.unity3d.com/ScriptReference/Profiling.Profiler-logFile.html — Disable CPU performance scaling – E.g. Intel Speed Step or Turbo Boost 25
- 26. Examples 26 — Check if function called — Finding Representative Frames — Changing a project setting — Are we GPU bound?
- 27. Check if function called 27
- 28. First we need to get some data Entry point 28
- 29. Open the Unity Profiler Unity Profiler 29
- 30. Open the Unity Profiler Unity Profiler 30
- 31. Pull data from Unity Profiler Or load previously saved data Acquire Data 31
- 32. Data 32 Frame Time graph — White for frame durations — Cyan for currently selected marker
- 33. Search for marker 33 Use Filter area — Type marker name — E.g. FindObjectsOfType
- 34. Search for marker 34 Marker table shows filtered list
- 35. Search for marker 35 This marker only appears once
- 36. Search for marker 36 Marker shown in frame time graph
- 37. Search for marker 37 Marker shown in frame time graph
- 38. Search for marker 38 — Select marker — View Summary
- 39. Search for marker 39 — Top section of Summary
- 40. Search for marker 40 — Shows first frame marker present on
- 41. Sync Unity Profiler 41 — Click to jump to frame in Profiler (*) (*) If Profiler has same data set loaded
- 42. — Highlights selected marker – (first instance) Sync Unity Profiler 42
- 44. Selecting a Representative Frame 44 — Use the Frame Summary
- 45. Selecting a Representative Frame 45 — Find the median frame – Here 17.5ms on frame 12
- 46. Selecting a Representative Frame 46 — Find the median frame – Here 17.5ms on frame 12 — Worst frame (max value) – Here 38.15ms on frame 239
- 47. Sync Unity Profiler 47 Click button to jump to frame in the Unity Profiler
- 48. Filter frame selection in Profile Analyzer — Right click on the Frame Time Graph – Select Median Frame — All stats are filtered to the selected frame – Useful, but just one data point ... 48
- 49. Selecting a range of Representative frames — Use ‘Order by Frame Duration’ — Range select a set of frames around the median point – Using multiple frames smooths noise in the data 49
- 50. Changing a project setting 50
- 51. Graphics Jobs Enable graphics jobs — On FPS Sample project Moves CPU graphics work off the main thread See: https://learn.unity.com/tutorial/optimizing-graphics-in-unity# 51
- 52. Graphics Jobs Player Settings — Other Settings 52
- 53. Graphics Jobs? Use Comparison view — Take 2 captures and load them in – 1st - jobs disabled (blue) – 2nd - jobs enabled (orange) 53
- 54. Graphics Jobs? Use Frame Summary 54
- 55. Graphics Jobs? Improved frame times — Faster on CPU overall Conclusion: — Graphics jobs setting is faster Profile on your own projects 55
- 56. Thread Utilisation Review thread activity — First select threads 56
- 57. Thread Utilisation Review thread activity — Confirm work distributed to worker threads First select all threads, or subset. E.g. — Worker threads : Job.Worker (All) — Main thread — Render thread 57
- 58. Thread Utilisation View the Thread Summary tab 58
- 59. Thread Utilisation View the Thread Summary tab 2nd data set = Graphics jobs enabled — Worker threads are busier — Main / Render threads are less busy 59
- 60. Are we GPU bound? 60
- 61. Are we GPU bound? Check the duration of Gfx.WaitForPresent — Non zero, if we are waiting for GPU 61
- 62. Are we GPU bound? Yes Gfx.WaitForPresent — Is non zero — So CPU is waiting for the GPU — Frame is therefore GPU bound Majority of frames are GPU bound 62
- 63. Revisiting graphics jobs Lets review the Graphics Jobs again — Select Gfx.WaitForPresent — Inspect the frame time graphs 63
- 64. Gfx.WaitForPresent almost zero — Initially CPU Bound Graphics jobs made CPU faster — Now GPU bound Next Steps : Focus on GPU optimisations Revisiting graphics jobs 64
- 65. UI Breakdown 65 — Looking at the UI in more detail
- 66. Data Set Management 66 — Starting point – At top of window
- 67. Data Set Management 67 1. Open Unity Profiler 2. ‘Pull Data’ from Unity Profiler, or 3. Load previously saved file (any Unity version) 12 3
- 68. Data Set Loaded 68 4. Frame time preview is shown for the data set – Interactive region allowing selection of frame subset – Right click for advanced options 5. Save to capture (.pdata file) – Recommend saving Unity Profiler .data (or .raw) and Profile Analyzer .pdata together 5 4
- 69. Frame Time Summary 69 — Top right
- 70. Frame Time Summary 70 Shows frame times (defaults to ms) — Highlights min, max, median frame time (defaults to ms) — Buttons to jump to specific frames in Unity Profiler (*) — Visuals for frame time distribution Histogram and box and whisker plots – (Box and whisker description later) (*) If Profiler has same data set loaded
- 71. Marker Table 71 — Bottom left — What does it show ?
- 72. 72 2ms 1 2.5ms 5.5ms Aggregated Marker Data — Marker data from Unity Profiler – All stack depths — Time for each instance — Calculate aggregated time : 5.5ms — Record count of instances : 3
- 73. Median Marker Values 73 — Marker values over multiple frames — Calculate min, max, median, etc — Median value used in table view 5.5ms Min Median Max
- 74. Marker Table Details 74 Aggregated marker instances — Displays median, min, max, … — Visual bar for faster analysis — Includes call counts and depth — Table headers allow sorting — Can select marker to focus on ...
- 75. Marker Summary 75 — Bottom right — Currently selected marker
- 76. Marker Summary 76 Information about selected (aggregated) marker 1. Percentage of time in median frame 2. Top times, listed with frame indices Frames where this marker is slowest 3. Visual display of marker distribution Histogram and box and whisker plots 4. Median, min, max ms values 1 2 3 4
- 77. Marker Summary 77 Information about selected (aggregated) marker 1. Percentage of time in median frame 2. Top times, listed with frame indices Frames where this marker is slowest 3. Visual display of marker distribution Histogram and box and whisker plots 4. Median, min, max ms values 5. Min/max of individual marker instances 1 2 3 4 5
- 78. Box and Whisker plot 78 Distribution of time values. Tooltip shows exact values 1. Max 2. Upper quartile range 25% of data above this point. Middle value between median and max. 3. Median value 4. Lower quartile range 25% of data below this point. Middle value between min and median 5. Min Interquartile range is the middle 50% of the values 2 4 1 5 3
- 79. Quick visual review 79 Use up/down cursor keys — Scroll selected marker Frame Summary — Review Frame time distribution — Focus on slowest markers first – (top of table, sorted by median)
- 80. Box and Whisker plot - Examples Low variance in data (and biased toward low times) — Suggestion: Review slow outlier frames (>1ms) 80 Large variance in data (wide interquartile range) — But total min-max range is small (0.01-0.28) — Suggestion: Ignore (due to small range) Even data distribution (bell curve) — Suggestion: Review which other markers align with slow/fast outliers
- 81. Box and Whisker plot - Comparison 81 Comparison between two data sets — Here the blue data set is slower
- 82. Filtering Options 82 — Below frame time graph — Use to drill down
- 83. Filtering Options - Marker Names 83 1. Marker name filtering (case insensitive substring) – Separated by spaces – Quote if space in name. E.g. “my marker” 2. Excluding by name (case insensitive substring). E.g. : – “idle” to exclude idle time in jobs – “profile” to exclude all profiler functions 1 2
- 84. Filtering Options - Marker Selection 84 Can also add to include/exclude list via marker right click in marker table 1 2
- 85. Filtering Options - Threads 85 Thread filtering Including thread aggregation. E.g. ‘All worker threads’ 3 3.
- 86. Filtering Options - Depth 86 4. Marker call stack depth filtering (E.g. callstack depth 3) 4
- 87. Filtering Options - Parent 87 5. Limit to markers below a parent Select parent by right clicking on marker table 5
- 88. 5. Limit to markers below a parent Select parent by right clicking on marker table Filtering Options - Parent 88 5
- 89. Filtering Options - Self time 89 6. Show ‘self’ marker time (excluding children) or ‘total’ time (including children) Eg. Self time for Camera.Render is small as most of time is in child markers 6
- 90. Filtering Options 90 7. Select time units to show 8. Select group of marker table columns 9. Indication of marker/thread count for the current filter 8 7 9 8 7
- 91. Top 10 markers 91 — Top 10 markers for a quick overview – on the median frame
- 92. Top 10 markers 92 Shows relative ratio of most significant markers — Uses current filter — Typically used with – Main thread – At specific depth slice (E.g. depth 3) – Using the ‘total time’ (I.e. including children)
- 93. Top 10 markers 93 — Clicking selects the marker — Tooltips show % and ms time
- 94. Comparison Tab — “Compare” tab – Compare two data sets – Or two areas of a single data set
- 95. Comparison Tab — Select left/right data to compare – Same filters as single data set – Same visual aids
- 96. Comparison Tab — Side by side comparisons — Differences shown numerically — And with visual graphs – Tooltips on graphs for details
- 97. Comparison Table — Bars show data set with longer time – Blue if 1st data set has longer time – Orange if 2nd data set has longer time
- 98. Comparison Table — If marker only present in one scan – E.g. renamed in new Unity version — Dash ‘-’ shown for missing markers – E.g Material.SetPassUncached not in second data set
- 99. Comparison top 10 - Normalised — Both data sets scaled to their own median frame time – Quickly see if a system has larger impact
- 100. Comparison top 10 - Longest — Data sets are scaled to longest frame time – Shows absolute differences
- 101. Export — Exporting to csv data — For custom processing
- 102. Export — Marker table contents — Frame duration values – Single – Comparison
- 104. Export Frame Times Frame Time Comparison
- 105. Recap 105
- 106. Profile Analyzer 106 — Profile Analyzer is a CPU performance analysis tool — Shows numerical values and data visualisations — Numerous filtering options — Allows comparison of two data sets — Export for your own analysis
- 107. How to get it 107 — Available as a preview package – 2018.4 + — Or download directly – Drop into assets folder – 5.6 + Direct download link (also in main documentation) https://unity.bintray.com/unity/com.unity.performance.profile-analyzer/-/
- 108. How to get it 108 Show Preview Packages from the ‘Advanced’ menu Select Profile Analyzer (Using 0.5.0 in this presentation)
- 109. Thank you 109 — Big thank you to all Unity Users who gave valuable feedback – Please continue to give your feedback. We are listening – Use Profiler preview area on the forums : https://forum.unity.com/forums/profiler-previews.199/ – Raise Bug reports
- 110. Links, Questions? 110 Documentation & Direct Download https://docs.unity3d.com/Packages/com.unity.performance.profile-analyzer@latest/index.htm Feedback forum https://forum.unity.com/forums/profiler-previews.199/ Graphics jobs https://learn.unity.com/tutorial/optimizing-graphics-in-unity#l
- 111. Thank you 111
- 112. Useful layout - docked with Profiler 112
- 113. Marker Median Value 113 Median value is usually on a different frame for each marker. Hover mouse on median to see frame — WaitForJobGroupID 3.44ms on frame 55 — Game.Update 0.37ms on frame 280
- 114. Check for markers that are called a lot — Sort by count — GC.Alloc has a high call count 114
- 115. Comparing a range of Representative frames — Use ‘Order by Frame Time’ — Range select a set of frames, around the median point — Selection mirrored/paired on both graphs by default – But can make unique selection on each graph — All stats will be limited to this selection 115
- 117. ‘Order by Frame Duration’ Shows slower frames align to where GPU bound Cause of slower frames 117
- 118. Delete this slide before presenting Keep all text within these margins
Editor's Notes
- #3: My name is Lyndon Homewood I’m a software engineer on Unitys Platforms Performance Team, Our team are working on optimisations across a range of areas within the Unity runtime and Editor We wrote this tool to help us and made it public so you can all use it on your applications
- #5: Have you ever wanted to know … Have you ever wondered why two unity versions are slower We did internal so we developed this tool
- #6: What do you do when the frame time data is so noisy How can you identify a representative frame
- #7: Performance optimisation might be code or data change Why is the outliner frame slower than the median frame?
- #9: Performance efforts - Can check if CPU or GPU bound Performance optimisation might be code or data change (ADD ORDER BY FRAME TIME VIEW)
- #10: Developed with Steve Cavanagh, Unity Profiler Team Lead
- #24: TAKE TIME ON THIS SLIDE FRAME THE USE CASE
- #26: Disable Build Option “Script Debugging” (because it inserts hooks for debugging) Disable vsync if necessary (why)
- #33: Views populate on pull/load
- #42: Profiler captures are not backwards compatible, but profile analyzer .pdata is
- #43: … if you have previously made a selection Plans to improve selection highlight when package moves out of preview
- #49: Select Median Frame
- #50: Using multiple frames smooths noise in the data Excludes outliers Selection maintained when reverting to order by timestamp
- #51: TAKE TIME ON THIS SLIDE FRAME THE USE CASE
- #52: On FPS Sample project Enables rendering to run in parallel on multiple cores We are currently CPU bound
- #53: On FPS Sample project Enables rendering to run in parallel on multiple cores We are currently CPU bound
- #55: Note max frame time has gone up. There are some spikes.
- #56: Test on your own projects using the Profile Analyzer
- #59: Note: We are using ‘Total time’ here. Self time less useful.
- #60: Note: We are using ‘Total time’ here. Self time less useful. The increased parallelism of work = faster frame time
- #62: Select directly or use filter to locate WaitForEndOfFrame is another indicator for GPU Bound
- #63: Aligned with slower frames
- #64: Use platform specific GPU profiling tools (or Unity frame debugger)
- #65: Use platform specific GPU profiling tools (or Unity frame debugger)
- #67: Let’s look at this area in more detail
- #68: .data or .raw Can also export data here.
- #69: .data or .raw Can also export data here.
- #73: Count is shown in the marker table Only the aggregated marker time is used in the profiler analyzer Markers are aggregated over all depths.
- #74: Frame number is not the same throughout the table
- #75: Depth is a range Selected marker highlighted in blue
- #77: 2. Top three shows frames where marker is slowest
- #87: Benefit of this filter becomes clearer later In comparison view it will automatically match up the depth in old and new version. Old Unity didn’t have the top level player loop
- #93: In 2018 a new top level marker went in. PlayerLoop
- #98: Sortable columns as with single view
- #110: Thank to all Unity staff who gave feedback on the tool Javier, Vicky, Dale and all the DRE’s Everyone on the profiling and performance teams
- #111: Thank to all Unity staff who gave feedback on the tool Javier, Vicky, Dale and all the DRE’s Everyone on the profiling and performance teams
- #112: Time for any questions
- #118: Use platform specific GPU profiling tools (or Unity frame debugger)