feat(performance-metrics): add RobotContextTracker #14862
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DerekMaggio
force-pushed
the
EXEC-384-robot-context-tracker
branch
from
1b1e80b to
18e0b15
Compare
DerekMaggio
changed the title
sfoster1
requested changes
Apr 12, 2024
performance-metrics/src/performance_metrics/robot_context_tracker.py
Outdated
Show resolved
Hide resolved
# Overview Add CI testing and lint checks
# Overview Add functionality to store CSV data in a file # Test Plan - Added test cases to verify storing to a file correctly # Changelog - Added `store` method to RobotContextTracker - Added data shaping to RawContextData - Tests # Review requests None # Risk assessment Low
Carlos-fernandez
pushed a commit
that referenced
this pull request
May 20, 2024
# Overview Create RobotContextTracker class. This class provides a `track` method. The track method should be used as a decorator on either a function/method. It takes a RobotContextState enum value to label what state the RobotContextTracker is tracking. Uses `FunctionTimer` to measure execution time and stores results in a list. RobotContextTracker is defaulted not to track anything at all. To turn on tracking, instantiate the class with `should_track=True`. When not tracking, the `track` method calls the underlying wrapped function as quickly as possible. # Test Plan - See test_robot_contest_tracker.py # Changelog - Add RobotContextTracker class - Add test_robot_context_tracker.py # Review requests None # Risk assessment Low, not being used on any production code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Create RobotContextTracker class.
This class provides a
trackmethod.The track method should be used as a decorator on either a function/method. It takes a RobotContextState enum value to label what state the RobotContextTracker is tracking. Uses
FunctionTimerto measure execution time and stores results in a list.RobotContextTracker is defaulted not to track anything at all. To turn on tracking, instantiate the class with
should_track=True. When not tracking, thetrackmethod calls the underlying wrapped function as quickly as possible.Test Plan
Changelog
Review requests
None
Risk assessment
Low, not being used on any production code