Battery impact UMA

content/browser/power_usage_monitor_impl.h

+// Copyright 2014 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CHROME_CONTENT_BROWSER_POWER_USAGE_MONITOR_IMPL_H_
+#define CHROME_CONTENT_BROWSER_POWER_USAGE_MONITOR_IMPL_H_
+
+#include "base/basictypes.h"
+#include "base/containers/hash_tables.h"
+#include "base/gtest_prod_util.h"
+#include "base/memory/singleton.h"
+#include "base/power_monitor/power_monitor.h"
+#include "base/time/time.h"
+#include "content/public/browser/browser_message_filter.h"
+#include "content/public/browser/notification_observer.h"
+#include "content/public/browser/notification_registrar.h"
+#include "device/battery/battery_status_service.h"
+
+namespace content {
+
+// Record statistics on power usage.
+//
+// Two main statics are recorded by this class:
+// * Power.BatteryDischarge_{5,15,30} - delta between battery level when

[Daniel Erat, 2014/11/06 18:56:19]

(and then Power.BatteryDischargePercent_... for these)

+//   unplugged from wallpower, over the specified period - in minutes.
+// * Power.BatteryDischargeRateWhenUnplugged - the rate of battery discharge
+//   from the device being unplugged until it's plugged back in, if said period
+//   was longer than 30 minutes.
+//
+// Heuristics:
+// * Data collection starts after system uptime exceeds 30 minutes.
+// * If the machine goes to sleep or all renderers are closed then the current
+//   measurement is cancelled.
+class PowerUsageMonitor : public base::PowerObserver,
+                          public NotificationObserver {
+ public:
+  class SystemInterface {
+   public:
+    virtual ~SystemInterface() {}
+
+    virtual void ScheduleHistogramReport(base::TimeDelta delay) = 0;
+    virtual void CancelPendingHistogramReports() = 0;
+
+    // Record the battery discharge rate over a period when the system is
+    // on battery power. Rate refers to the amount the battery charge has
+    // decreased over a unit of time.
+    // Possible values [0,100].
+    // The number is scaled so that 0 signifies very slow discharge, arbitrarily
+    // defined as total battery discharge in 8 hours or more. 100 indicates
+    // a very quick discharge.
+    // This scale is arbitrary and only meant to provide sufficient precision to
+    // discern interesting changes in discharge rate.

[Daniel Erat, 2014/11/06 17:22:43]

mark, any opinions about whether this is a meaningful thing to report as a
histogram?

[Mark P, 2014/11/06 18:50:03]

I like the idea.  Here are my concerns:
- When / how frequently is this emitted?  If it's not emitted at a regular rate,
then this will be hard to interpret (depending on what affects the rate at which
it is emitted).
- How arbitrary is the scale?  Can it vary from device to device?  What about
platform to platform?  In either case (especially the first), that can make this
measure very hard to interpret.

[Daniel Erat, 2014/11/06 18:54:15]

i asked about the device-to-device variance in an earlier patch set. the answer
was "very", but it sounds like the intent is to use this to view changes across
individual hardware platforms (e.g. specific macbooks or chromebooks).

i think that most of my unease would go away if this histogram were renamed to
something like Power.BatteryDischargePercentPerHour and scaled accordingly. i
don't like the "arbitrary" definitions of slow vs. fast discharge.

[Mark P, 2014/11/06 19:33:33]

Is hard the slicing by hardware fine-grained enough on the UMA dashboard, or
would there be variety from device to device within the same hardware class at
the granularity we're aware of?

[jeremy, 2014/11/09 13:49:27]

* I changed this to report the percent of battery charge depleted per hour while
the system is on battery power.
* This is reported every time the power adapter is connected after 30 minutes or
more on battery power.
* I'd assume the number would be comparable across devices of the same hardware
class:
  - Hardware class is reported directly on CrOS/OSX (crbug.com/429487) and on
Android we can tell the device type by other means.
  - The UMA dashboard has a "Show Versions split by Chrome OS hardware class"
checkbox which should allow us to split correctly for CrOS/OSX if not we'll need
to either analyze via dremel or add the nobs we need to the dashboard.

+    virtual void RecordDischargeRate(int discharge_rate) = 0;
+
+    // Allow tests to override clock.
+    virtual base::Time Now() = 0;
+  };
+
+ public:
+  PowerUsageMonitor();
+  ~PowerUsageMonitor() override;
+
+  double discharge_amount() const {
+    return initial_battery_level_ - current_battery_level_;
+  }
+
+  // Start monitoring power usage.
+  // Note that the actual monitoring will be delayed until 30 minutes after
+  // system boot.
+  void Start();
+
+  void SetSystemInterfaceForTest(scoped_ptr<SystemInterface> interface);
+
+  // Overridden from base::PowerObserver:
+  void OnPowerStateChange(bool on_battery_power) override;
+  void OnResume() override;
+  void OnSuspend() override;
+
+  // Overridden from NotificationObserver:
+  void Observe(int type,
+               const NotificationSource& source,
+               const NotificationDetails& details) override;
+
+ private:
+  friend class PowerUsageMonitorTest;
+  FRIEND_TEST_ALL_PREFIXES(PowerUsageMonitorTest, OnBatteryStatusUpdate);
+  FRIEND_TEST_ALL_PREFIXES(PowerUsageMonitorTest, OnRenderProcessNotification);
+
+  // Start monitoring system power usage.
+  // This function may be called after a delay, see Start() for details.
+  void StartInternal();
+
+  void OnBatteryStatusUpdate(const device::BatteryStatus& status);
+  void OnRenderProcessNotification(int type, int rph_id);
+
+  void DischargeStarted(double battery_level);
+  void WallPowerConnected(double battery_level);
+
+  void CancelPendingHistogramReporting();
+
+  device::BatteryStatusService::BatteryUpdateCallback callback_;
+  scoped_ptr<device::BatteryStatusService::BatteryUpdateSubscription>
+      subscription_;
+
+  NotificationRegistrar registrar_;
+
+  scoped_ptr<SystemInterface> system_interface_;
+
+  // True if monitoring was started (Start() called).
+  bool started_;
+
+  // True if collecting metrics for the current discharge cycle e.g. if no
+  // renderers are open we don't keep track of discharge.
+  bool tracking_discharge_;
+
+  // True if the system is running on battery power, false if on wall power.
+  bool on_battery_power_;
+
+  // Battery level when wall power disconnected. [0.0, 1.0] - 0 if on wall
+  // power, 1 means fully charged.
+  double initial_battery_level_;
+
+  // Current battery level. [0.0, 1.0] - 0 if on wall power, 1 means fully
+  // charged.
+  double current_battery_level_;
+
+  // Timestamp when wall power was disconnected, null Time object otherwise.
+  base::Time start_discharge_time_;
+
+  // IDs of live renderer processes.
+  base::hash_set<int> live_renderer_ids_;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(PowerUsageMonitor);
+};
+
+}  // namespace content
+
+#endif  // CHROME_CONTENT_BROWSER_POWER_USAGE_MONITOR_IMPL_H_