tree: 4a6e3f37bcf21a2ab1a664eb9a34d077aa11c445 [path history] [tgz]
  1. OWNERS
  2. README.md
  3. c_metrics_library.cc
  4. c_metrics_library.h
  5. init/
  6. libmetrics-395517.gyp
  7. libmetrics.gypi
  8. libmetrics.pc.in
  9. metrics.gyp
  10. metrics_client.cc
  11. metrics_daemon.cc
  12. metrics_daemon.h
  13. metrics_daemon_main.cc
  14. metrics_daemon_test.cc
  15. metrics_library.cc
  16. metrics_library.h
  17. metrics_library_mock.h
  18. metrics_library_test.cc
  19. persistent_integer.cc
  20. persistent_integer.h
  21. persistent_integer_mock.h
  22. persistent_integer_test.cc
  23. platform2_preinstall.sh
  24. serialization/
  25. timer.cc
  26. timer.h
  27. timer_mock.h
  28. timer_test.cc
  29. uploader/
  30. vmlog_writer.cc
  31. vmlog_writer.h
  32. vmlog_writer_test.cc
metrics/README.md

Chromium OS Metrics

The Chromium OS “metrics” package contains utilities for client-side user metric collection.

When Chromium is installed, Chromium will take care of aggregating and uploading the metrics to the UMA server.

When Chromium is not installed (e.g. an embedded build) and the metrics_uploader USE flag is set, metrics_daemon will aggregate and upload the metrics itself.

The Metrics Library: libmetrics

libmetrics is a small library that implements the basic C and C++ API for metrics collection. All metrics collection is funneled through this library. The easiest and recommended way for a client-side module to collect user metrics is to link libmetrics and use its APIs to send metrics to Chromium for transport to UMA. In order to use the library in a module, you need to do the following:

  • Add a dependence (DEPEND and RDEPEND) on chromeos-base/metrics to the module's ebuild.

  • Link the module with libmetrics (for example, by passing -lmetrics to the module's link command). Both libmetrics.so and libmetrics.a are built and installed into the sysroot libdir (e.g. $SYSROOT/usr/lib/). Note that by default -lmetrics will link against libmetrics.so, which is preferred.

  • To access the metrics library API in the module, include the <metrics/metrics_library.h> header file. The file is installed in $SYSROOT/usr/include/ when the metrics library is built and installed.

  • The API is documented in metrics_library.h. Before using the API methods, a MetricsLibrary object needs to be constructed and initialized through its Init method.

    For more information on the C API, see c_metrics_library.h.

  • Samples are sent to Chromium only if the /home/chronos/Consent To Send Stats file exists or the metrics are declared enabled in the policy file (see the AreMetricsEnabled API method).

  • On the target platform, shortly after the sample is sent, it should be visible in Chromium through chrome://histograms.

Histogram Naming Convention

Use TrackerArea.MetricName. For example:

  • Platform.DailyUseTime
  • Network.TimeToDrop

Server Side

If the histogram data is visible in chrome://histograms, it will be sent by an official Chromium build to UMA, assuming the user has opted into metrics collection. To make the histogram visible on “chromedashboard”, the histogram description XML file needs to be updated (steps 2 and 3 after following the “Details on how to add your own histograms” link under the Histograms tab). Include the string “Chrome OS” in the histogram description so that it's easier to distinguish Chromium OS specific metrics from general Chromium histograms.

The UMA server logs and keeps the collected field data even if the metric's name is not added to the histogram XML. However, the dashboard histogram for that metric will show field data as of the histogram XML update date; it will not include data for older dates. If past data needs to be displayed, manual server-side intervention is required. In other words, one should assume that field data collection starts only after the histogram XML has been updated.

The Metrics Client: metrics_client

metrics_client is a simple shell command-line utility for sending histogram samples and user actions. It's installed under /usr/bin on the target platform and uses libmetrics to send the data to Chromium. The utility is useful for generating metrics from shell scripts.

For usage information and command-line options, run “metrics_client” on the target platform or look for “Usage:” in metrics_client.cc.

The Metrics Daemon: metrics_daemon

metrics_daemon is a daemon that runs in the background on the target platform and is intended for passive or ongoing metrics collection, or metrics collection requiring feedback from multiple modules. For example, it listens to D-Bus signals related to the user session and screen saver states to determine if the user is actively using the device or not and generates the corresponding data. The metrics daemon uses libmetrics to send the data to Chromium.

The recommended way to generate metrics data from a module is to link and use libmetrics directly. However, the module could instead send signals to or communicate in some alternative way with the metrics daemon. Then the metrics daemon needs to monitor for the relevant events and take appropriate action -- for example, aggregate data and send the histogram samples.

FAQ

What should my histogram's |min| and |max| values be set at?

You should set the values to a range that covers the vast majority of samples that would appear in the field. Note that samples below the |min| will still be collected in the underflow bucket and samples above the |max| will end up in the overflow bucket. Also, the reported mean of the data will be correct regardless of the range.

How many buckets should I use in my histogram?

You should allocate as many buckets as necessary to perform proper analysis on the collected data. Note, however, that the memory allocated in Chromium for each histogram is proportional to the number of buckets. Therefore, it is strongly recommended to keep this number low (e.g., 50 is normal, while 100 is probably high).

When should I use an enumeration (linear) histogram vs. a regular (exponential) histogram?

Enumeration histograms should really be used only for sampling enumerated events and, in some cases, percentages. Normally, you should use a regular histogram with exponential bucket layout that provides higher resolution at the low end of the range and lower resolution at the high end. Regular histograms are generally used for collecting performance data (e.g., timing, memory usage, power) as well as aggregated event counts.