NEW: Input System Profiler Module

[ekcoh]

Description

Made a draft implementation of a Profiler Module for the Input System based on lack of observability to work as an aid in understanding system mechanics. Hopefully could work as an embryo of something more refined if considered a good idea.

Testing status & QA

Just a prototype at this point. Try it out and suggest or contribute to this PR to make it more useful.

Overall Product Risks

Some more work likely need to be done to InputManager.OnUpdate to make that method cleaner and this work more reliably.

Might not be possible to merge unless minimum Unity version requirement is changed to 2020.1. (Profiler package dependency)

• Complexity: Small
• Halo Effect: Medium

Comments to reviewers

At this point mainly looking for feedback and suggestions since this was unplanned work.

Checklist

Before review:

• [ ] Changelog entry added.
  • Explains the change in Changed, Fixed, Added sections.
  • For API change contains an example snippet and/or migration example.
  • JIRA ticket linked, example (case %<ID>%). If it is a private issue, just add the case ID without a link.
  • Jira port for the next release set as "Resolved".
• [ ] Tests added/changed, if applicable.
  • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
  • Performance tests.
  • Integration tests.
• [ ] Docs for new/changed API's.
  • Xmldoc cross references are set correctly.
  • Added explanation how the API works.
  • Usage code examples added.
  • The manual is updated, if needed.

During merge:

• [ ] Commit message for squash-merge is prefixed with one of the list:
  • NEW: ___.
  • FIX: ___.
  • DOCS: ___.
  • CHANGE: ___.
  • RELEASE: 1.1.0-preview.3.

After merge:

• [ ] Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

[surfnerd]

My first thought looking at the window is the mix of types being presented. I see Counters, Memory Size, and Times. It looks a little bit busy and hard to know what I'm looking at exactly. Overall I think this is a great idea. I wonder if there's a way we can group like values together within one window.

[ekcoh]

My first thought looking at the window is the mix of types being presented. I see Counters, Memory Size, and Times. It looks a little bit busy and hard to know what I'm looking at exactly. Overall I think this is a great idea. I wonder if there's a way we can group like values together within one window.

Agreed, I just saw other modules were doing that and replicated it. I think there is opportunity to slip things into separate modules to handle it, e.g. Latency and Input System Counters. I wonder if execution time should even be there since its covered by the ProfilerMarkers anyway.....

[codecov-github-com[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

@@             Coverage Diff             @@
##           develop    #2038      +/-   ##
===========================================
- Coverage    68.15%   68.14%   -0.02%     
===========================================
  Files          367      367              
  Lines        53662    53654       -8     
===========================================
- Hits         36576    36562      -14     
- Misses       17086    17092       +6     

Files with missing lines	Coverage Δ
.../com.unity.inputsystem/InputSystem/InputManager.cs	88.73% <ø> (-0.05%)	:arrow_down:

... and 1 file with indirect coverage changes

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.