Include changes suggested in review

Author: Colman Yau

codeguru_profiler_agent/profiler_disabler.py

@@ -20,14 +20,14 @@ def __init__(self, environment, clock=time.time):
         self.memory_limit_bytes = environment['memory_limit_bytes']
 
     def should_stop_sampling(self, profile=None):
-        return self.killswitch.is_killswitch_on() \
-               or self.cpu_usage_check.is_sampling_cpu_usage_limit_reached(profile) \
-               or self._is_memory_limit_reached(profile)
+        return (self.killswitch.is_killswitch_on()
+                or self.cpu_usage_check.is_sampling_cpu_usage_limit_reached(profile)
+                or self._is_memory_limit_reached(profile))
 
     def should_stop_profiling(self, profile=None):
-        return self.killswitch.is_killswitch_on() \
-               or self.cpu_usage_check.is_overall_cpu_usage_limit_reached(profile) \
-               or self._is_memory_limit_reached(profile)
+        return (self.killswitch.is_killswitch_on()
+                or self.cpu_usage_check.is_overall_cpu_usage_limit_reached(profile)
+                or self._is_memory_limit_reached(profile))
 
     def _is_memory_limit_reached(self, profile):
         return False if profile is None else profile.get_memory_usage_bytes() > self.memory_limit_bytes
@@ -42,21 +42,25 @@ class CpuUsageCheck:
     def __init__(self, timer):
         self.timer = timer
 
-    # This function carries out an overall cpu limit check that covers the cpu overhead caused for the full
-    # sampling cycle: sample -> aggregate -> report -> refresh config. We expect this function to be called after
-    # configuration refresh and profile submission.
     def is_overall_cpu_usage_limit_reached(self, profile=None):
+        """
+        This function carries out an overall cpu limit check that covers the cpu overhead caused for the full
+        sampling cycle: refresh config -> (sample -> aggregate) * n -> profile submission. We expect this function to
+        be called after configuration refresh and profile submission.
+        """
         profiler_metric = self.timer.metrics.get("runProfiler")
         if not profile or not profiler_metric or profiler_metric.counter < MINIMUM_MEASURES_IN_DURATION_METRICS:
             return False
 
         used_time_percentage = 100 * profiler_metric.total/(profile.get_active_millis_since_start()/1000)
 
-        if used_time_percentage >= AgentConfiguration.get().cpu_limit_percentage:
+        cpu_limit_percentage = AgentConfiguration.get().cpu_limit_percentage
+
+        if used_time_percentage >= cpu_limit_percentage:
             logger.debug(self.timer.metrics)
             logger.info(
                 "Profiler overall cpu usage limit reached: {:.2f} % (limit: {:.2f} %), will stop CodeGuru Profiler."
-                .format(used_time_percentage, AgentConfiguration.get().cpu_limit_percentage))
+                .format(used_time_percentage, cpu_limit_percentage))
             return True
         else:
             return False
@@ -70,11 +74,13 @@ def is_sampling_cpu_usage_limit_reached(self, profile=None):
         sampling_interval_seconds = self._get_average_sampling_interval_seconds(profile)
         used_time_percentage = 100 * sample_and_aggregate_metric.average() / sampling_interval_seconds
 
-        if used_time_percentage >= AgentConfiguration.get().cpu_limit_percentage:
+        cpu_limit_percentage = AgentConfiguration.get().cpu_limit_percentage
+
+        if used_time_percentage >= cpu_limit_percentage:
             logger.debug(self.timer.metrics)
             logger.info(
                 "Profiler sampling cpu usage limit reached: {:.2f} % (limit: {:.2f} %), will stop CodeGuru Profiler."
-                .format(used_time_percentage, AgentConfiguration.get().cpu_limit_percentage))
+                .format(used_time_percentage, cpu_limit_percentage))
             return True
         else:
             return False