Google Git
Sign in
cos / mirrors / cros / chromiumos / platform2 / refs/heads/release-R123-15786.B / . / missive / analytics
tree: b9dfc3043cce17809e84bcaeae4335ed26a6de89 [path history] [tgz]
  1. BUILD.gn
  2. metrics.cc
  3. metrics.h
  4. metrics_test.cc
  5. metrics_test_util.cc
  6. metrics_test_util.h
  7. README.md
  8. registry.cc
  9. registry.h
  10. registry_test.cc
  11. resource_collector.cc
  12. resource_collector.h
  13. resource_collector_cpu.cc
  14. resource_collector_cpu.h
  15. resource_collector_cpu_test.cc
  16. resource_collector_memory.cc
  17. resource_collector_memory.h
  18. resource_collector_memory_test.cc
  19. resource_collector_mock.cc
  20. resource_collector_mock.h
  21. resource_collector_storage.cc
  22. resource_collector_storage.h
  23. resource_collector_storage_test.cc
  24. resource_collector_test.cc
missive/analytics/README.md

Analytics

This directory contains implementation of internal analytics of Missive via UMA.

To see the analytics results, visit the UMA Dashboard. Select “Chrome OS” as the platform and the channel of your interest. Then, click on “Metrics/Formula +” and search for “Platform.Missive.”. All items shown are analytics of the Missive daemon recorded and uploaded by this directory.

Add an Analytics Resource

To add a new analytics resource:

  1. Create a new class ResourceCollectorMyResource that inherits ResourceCollector.

  2. Implement the virtual method ResourceCollectorMyResource::Collect according to the document of ResourceCollector::Collect. Here, you likely need to use libmetrics. Check out their documentation for guidance.

  3. Register it to the registry in the MissiveDaemon constructor by calling

    analytics_registry_.Add("MyResource",
                        std::make_unique<ResourceCollectorMyResource>(base::Minutes(10)))

    Feel free to replace base::Minutes(10) above with any reasonable time interval.

See ResourceCollectorStorage for an example.

Dependency on This Directory

Generally speaking, only MissiveDaemon should contain code that depends on this directory. The reason is twofold:

  1. This directory is not synced to components/. It will become burdensome to sync the part of Missive that need to be synced to components/ if they depend on this directory.

  2. It is generally good engineering practice to not spill analytics code into implementation details. Otherwise, a simple change in implementation details or a small refactoring may unnoticeably introduce inconsistency into analytics.

The Terms “Analytics,” “Metrics,” and “Telemetry”

The three words are quite confusing in the context of Encrypted Reporting Pipeline (ERP). Metrics or telemetry in ERP typically refers to monitoring data on device that are collected to directly benefit the admins and usually made accessible to them. Metrics or telemetry in Chrome, as referred to by UMA, are monitoring data on device that are collected to directly benefit developers, usually for better understanding the behavior of the software in production. To distinguish from metrics or telemetry in ERP, we refer to the term corresponding to metrics and telemetry in Chrome as analytics.

A quick summary:

  • Metrics and telemetry in ERP: To the benefit of admins (our customers)
  • Analytics in ERP, metrics and telemetry in Chrome: To the benefit of developers