Search Unity

Unity Profiler Extensibility

Discussion in 'Profiler Previews' started by AndyBarnard, Jun 2, 2021.

  1. AndyBarnard

    AndyBarnard

    Unity Technologies

    Joined:
    Nov 12, 2019
    Posts:
    3
    Welcome to the Profiler Extensibility discussion thread. You can use this thread to ask for help, share feedback, and have discussions about the Profiler Extensibility feature.

    Introduction
    Profiler Extensibility refers to the ability for developers to extend the Unity Profiler with custom data and visualisation in order to better measure, monitor, and convey the performance characteristics of their applications and systems.

    In Unity 2021.2 we are releasing two new features to aid developers in this goal, Profiler counters and custom Profiler modules.

    Profiler Counters
    Profiler counters allow you to track the key metrics of your application and make them visible in the Unity Profiler or in other code. This is particularly useful if you want to track performance changes in your application, and it speeds up the investigation of performance issues because you can use the information from your Profiler counters in conjunction with Unity’s built-in counters and instrumentation data.

    If you are an Asset Store package developer, you can add Profiler counters to your code to help other developers understand important performance characteristics of your system, and they can use this information for optimization or budgeting tooling.

    Profiler counters can be monitored in release (non-development) builds without the Unity Profiler attached via the Profiler Recorder API. This enables you to selectively track metrics in release builds and capture runtime performance characteristics closer to real-world usage.

    Profiler Counters are available in the Unity Profiling Core package, which is currently in the Release Candidate phase of its development cycle and on track to be Released for Unity 2021.2.

    Tanks - Runtime Stats.png

    Custom Profiler Modules
    In Unity 2021.2, the Profiler Window can now be extended with custom Profiler Modules in order to visualise your own metrics alongside other Profiler data. In combination with Profiler Counters, this enables you to visualise the performance story of your own systems directly in the Profiler window.

    Custom Profiler modules can be defined from both a Unity project, as well as from a Unity package. This enables package authors, such as Asset Store developers, to ship custom Profiler modules in their package to convey relevant performance metrics to their users.

    Custom Profiler modules also support rendering a custom UI in the module’s Details View, which is displayed below the list of charts when the module is selected. This is useful for showing additional details relevant to your module or presenting a bespoke visualization of your performance data to the user. The example below demonstrates adding more context to some performance data, in this case by visualising how several counters contribute to a total budget.

    Tank Effects Profiler Module (Detailed).png

    Resources
    For more information, please see the following resources:
    Feedback
    Please feel free to post any feedback in this thread.

    How to report bugs
    Please report bugs through Unity’s built-in bug reporter tool, located in “Help > Report a Bug…”. Once you have submitted a bug report through the bug reporter, please feel free to start a discussion about it in this thread or by posting a new thread in this forum using the profiling tag.

    Thank you for your interest, we're looking forward to your feedback!
     
    codestage, pvloon, MartinTilo and 6 others like this.
  2. codestage

    codestage

    Joined:
    Jul 27, 2012
    Posts:
    1,596
    Awesome feature set!

    I'm super happy about it both as developer and Asset Store publisher, going to use some of this black magic at Advanced FPS Counter and probably other my assets.

    Thank you for this opportunity ^^

    P.S. will get back with a feedback on how it goes for me when I'll reach that point!
     
    AndyBarnard, Seith and MartinTilo like this.
unityunity