123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491 |
- // 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.
- // This file defines a service that collects information about the user
- // experience in order to help improve future versions of the app.
- #ifndef COMPONENTS_METRICS_METRICS_SERVICE_H_
- #define COMPONENTS_METRICS_METRICS_SERVICE_H_
- #include <stdint.h>
- #include <map>
- #include <memory>
- #include <string>
- #include "base/bind.h"
- #include "base/callback_forward.h"
- #include "base/callback_list.h"
- #include "base/gtest_prod_util.h"
- #include "base/memory/raw_ptr.h"
- #include "base/memory/weak_ptr.h"
- #include "base/metrics/field_trial.h"
- #include "base/metrics/histogram_flattener.h"
- #include "base/metrics/histogram_snapshot_manager.h"
- #include "base/metrics/user_metrics.h"
- #include "base/observer_list.h"
- #include "base/scoped_observation.h"
- #include "base/sequence_checker.h"
- #include "base/time/time.h"
- #include "build/build_config.h"
- #include "build/chromeos_buildflags.h"
- #include "components/metrics/delegating_provider.h"
- #include "components/metrics/metrics_log.h"
- #include "components/metrics/metrics_log_manager.h"
- #include "components/metrics/metrics_log_store.h"
- #include "components/metrics/metrics_provider.h"
- #include "components/metrics/metrics_reporting_service.h"
- class PrefService;
- class PrefRegistrySimple;
- FORWARD_DECLARE_TEST(ChromeMetricsServiceClientTest,
- TestRegisterMetricsServiceProviders);
- FORWARD_DECLARE_TEST(IOSChromeMetricsServiceClientTest,
- TestRegisterMetricsServiceProviders);
- namespace base {
- class HistogramSamples;
- class PrefService;
- } // namespace base
- namespace variations {
- class SyntheticTrialRegistry;
- }
- namespace metrics {
- class MetricsRotationScheduler;
- class MetricsServiceClient;
- class MetricsStateManager;
- // Exposed in the header file for tests.
- extern const base::Feature kConsolidateMetricsServiceInitialLogLogic;
- // See metrics_service.cc for a detailed description.
- class MetricsService : public base::HistogramFlattener {
- public:
- // Creates the MetricsService with the given |state_manager|, |client|, and
- // |local_state|. Does not take ownership of the paramaters; instead stores
- // a weak pointer to each. Caller should ensure that the parameters are valid
- // for the lifetime of this class.
- MetricsService(MetricsStateManager* state_manager,
- MetricsServiceClient* client,
- PrefService* local_state);
- MetricsService(const MetricsService&) = delete;
- MetricsService& operator=(const MetricsService&) = delete;
- ~MetricsService() override;
- // Initializes metrics recording state. Updates various bookkeeping values in
- // prefs and sets up the scheduler. This is a separate function rather than
- // being done by the constructor so that field trials could be created before
- // this is run.
- void InitializeMetricsRecordingState();
- // Starts the metrics system, turning on recording and uploading of metrics.
- // Should be called when starting up with metrics enabled, or when metrics
- // are turned on.
- void Start();
- // Starts the metrics system in a special test-only mode. Metrics won't ever
- // be uploaded or persisted in this mode, but metrics will be recorded in
- // memory.
- void StartRecordingForTests();
- // Starts updating the "last live" browser timestamp.
- void StartUpdatingLastLiveTimestamp();
- // Shuts down the metrics system. Should be called at shutdown, or if metrics
- // are turned off.
- void Stop();
- // Enable/disable transmission of accumulated logs and crash reports (dumps).
- // Calling Start() automatically enables reporting, but sending is
- // asyncronous so this can be called immediately after Start() to prevent
- // any uploading.
- void EnableReporting();
- void DisableReporting();
- // Returns the client ID for this client, or the empty string if metrics
- // recording is not currently running.
- std::string GetClientId() const;
- // Set an external provided id for the metrics service. This method can be
- // set by a caller which wants to explicitly control the *next* id used by the
- // metrics service. Note that setting the external client id will *not* change
- // the current metrics client id. In order to change the current client id,
- // callers should call ResetClientId to change the current client id to the
- // provided id.
- void SetExternalClientId(const std::string& id);
- // Returns the date at which the current metrics client ID was created as
- // an int64_t containing seconds since the epoch.
- int64_t GetMetricsReportingEnabledDate();
- // Returns true if the last session exited cleanly.
- bool WasLastShutdownClean() const;
- // Registers local state prefs used by this class.
- static void RegisterPrefs(PrefRegistrySimple* registry);
- // HistogramFlattener:
- void RecordDelta(const base::HistogramBase& histogram,
- const base::HistogramSamples& snapshot) override;
- // This should be called when the application is not idle, i.e. the user seems
- // to be interacting with the application.
- void OnApplicationNotIdle();
- #if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
- // Called when the application is going into background mode.
- // If |keep_recording_in_background| is true, UMA is still recorded and
- // reported while in the background.
- void OnAppEnterBackground(bool keep_recording_in_background = false);
- // Called when the application is coming out of background mode.
- void OnAppEnterForeground(bool force_open_new_log = false);
- #endif // BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
- // Signals that the browser is shutting down cleanly. Intended to be called
- // during shutdown after critical shutdown tasks have completed.
- void LogCleanShutdown();
- bool recording_active() const;
- bool reporting_active() const;
- bool has_unsent_logs() const;
- bool IsMetricsReportingEnabled() const;
- // Register the specified |provider| to provide additional metrics into the
- // UMA log. Should be called during MetricsService initialization only.
- void RegisterMetricsProvider(std::unique_ptr<MetricsProvider> provider);
- // Check if this install was cloned or imaged from another machine. If a
- // clone is detected, reset the client id and low entropy source. This
- // should not be called more than once.
- void CheckForClonedInstall();
- // Checks if the cloned install detector says that client ids should be reset.
- bool ShouldResetClientIdsOnClonedInstall();
- // Clears the stability metrics that are saved in local state.
- void ClearSavedStabilityMetrics();
- // Marks current histograms as reported by snapshotting them, without
- // actually saving the deltas. At a higher level, this is used to throw
- // away new histogram samples (since the last log) so that they will not
- // be included in the next log.
- void MarkCurrentHistogramsAsReported();
- #if BUILDFLAG(IS_CHROMEOS_ASH)
- // Binds a user log store to store unsent logs. This log store will be
- // fully managed by MetricsLogStore. This will no-op if another log store has
- // already been set.
- //
- // If this is called before initial logs are recorded, then histograms
- // recorded before user log store is set will be included with user histograms
- // when initial logs are recorded.
- //
- // If this is called after initial logs are recorded, then this will flush all
- // logs recorded before swapping to |user_log_store|.
- void SetUserLogStore(std::unique_ptr<UnsentLogStore> user_log_store);
- // Unbinds the user log store. If there was no user log store, then this does
- // nothing.
- //
- // If this is called before initial logs are recorded, then histograms and the
- // current log will be discarded.
- //
- // If called after initial logs are recorded, then this will flush all logs
- // before the user log store is unset.
- void UnsetUserLogStore();
- // Returns true if a user log store has been bound.
- bool HasUserLogStore();
- // Initializes per-user metrics collection. Logs recorded during a user
- // session will be stored within each user's directory and consent to send
- // these logs will be controlled by each user. Logs recorded before any user
- // logs in or during guest sessions (given device owner has consented) will be
- // stored in local_state.
- //
- // This is in its own function because the MetricsService is created very
- // early on and a user metrics service may have dependencies on services that
- // are created happen after MetricsService is initialized.
- void InitPerUserMetrics();
- // Returns the current user metrics consent if it should be applied to
- // determine metrics reporting state.
- //
- // See comments at MetricsServiceClient::GetCurrentUserMetricsConsent() for
- // more details.
- absl::optional<bool> GetCurrentUserMetricsConsent() const;
- // Returns the current logged in user id. See comments at
- // MetricsServiceClient::GetCurrentUserId() for more details.
- absl::optional<std::string> GetCurrentUserId() const;
- // Updates the current user metrics consent. No-ops if no user has logged in.
- void UpdateCurrentUserMetricsConsent(bool user_metrics_consent);
- #endif // BUILDFLAG(IS_CHROMEOS_ASH)
- #if BUILDFLAG(IS_CHROMEOS)
- // Forces the client ID to be reset and generates a new client ID. This will
- // be called when a user re-consents to metrics collection and the user had
- // consented in the past.
- //
- // This is to preserve the pseudo-anonymous identifier <client_id, user_id>.
- void ResetClientId();
- #endif // BUILDFLAG(IS_CHROMEOS)
- variations::SyntheticTrialRegistry* GetSyntheticTrialRegistry();
- MetricsLogStore* LogStoreForTest() {
- return reporting_service_.metrics_log_store();
- }
- // Test hook to safely stage the current log in the log store.
- bool StageCurrentLogForTest();
- DelegatingProvider* GetDelegatingProviderForTesting() {
- return &delegating_provider_;
- }
- // Observers will be notified when the enablement state changes. The callback
- // should accept one boolean argument, which will signal whether or not the
- // metrics collection has been enabled.
- base::CallbackListSubscription AddEnablementObserver(
- const base::RepeatingCallback<void(bool)>& observer);
- #if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
- bool IsInForegroundForTesting() const { return is_in_foreground_; }
- #endif
- protected:
- // Sets the persistent system profile. Virtual for tests.
- virtual void SetPersistentSystemProfile(const std::string& serialized_proto,
- bool complete);
- // Records the current environment (system profile) in |log|, and persists
- // the results in prefs.
- // Exposed for testing.
- static std::string RecordCurrentEnvironmentHelper(
- MetricsLog* log,
- PrefService* local_state,
- DelegatingProvider* delegating_provider);
- // The MetricsService has a lifecycle that is stored as a state.
- // See metrics_service.cc for description of this lifecycle.
- enum State {
- CONSTRUCTED, // Constructor was called.
- INITIALIZED, // InitializeMetricsRecordingState() was called.
- INIT_TASK_SCHEDULED, // Waiting for deferred init tasks to finish.
- INIT_TASK_DONE, // Waiting for timer to send initial log.
- SENDING_LOGS, // Sending logs an creating new ones when we run out.
- };
- State state() const { return state_; }
- private:
- // The current state of recording for the MetricsService. The state is UNSET
- // until set to something else, at which point it remains INACTIVE or ACTIVE
- // for the lifetime of the object.
- enum RecordingState {
- INACTIVE,
- ACTIVE,
- UNSET,
- };
- // Gets the LogStore for UMA logs.
- MetricsLogStore* log_store() {
- return reporting_service_.metrics_log_store();
- }
- // Calls into the client to initialize some system profile metrics.
- void StartInitTask();
- // Callback that moves the state to INIT_TASK_DONE. When this is called, the
- // state should be INIT_TASK_SCHEDULED.
- void FinishedInitTask();
- void OnUserAction(const std::string& action, base::TimeTicks action_time);
- // Get the amount of uptime since this process started and since the last
- // call to this function. Also updates the cumulative uptime metric (stored
- // as a pref) for uninstall. Uptimes are measured using TimeTicks, which
- // guarantees that it is monotonic and does not jump if the user changes
- // their clock. The TimeTicks implementation also makes the clock not
- // count time the computer is suspended.
- void GetUptimes(PrefService* pref,
- base::TimeDelta* incremental_uptime,
- base::TimeDelta* uptime);
- // Turns recording on or off.
- // DisableRecording() also forces a persistent save of logging state (if
- // anything has been recorded, or transmitted).
- void EnableRecording();
- void DisableRecording();
- // If in_idle is true, sets idle_since_last_transmission to true.
- // If in_idle is false and idle_since_last_transmission_ is true, sets
- // idle_since_last_transmission to false and starts the timer (provided
- // starting the timer is permitted).
- void HandleIdleSinceLastTransmission(bool in_idle);
- // Set up client ID, session ID, etc.
- void InitializeMetricsState();
- // Opens a new log for recording user experience metrics.
- void OpenNewLog();
- // Closes out the current log after adding any last information.
- void CloseCurrentLog();
- // Pushes the text of the current and staged logs into persistent storage.
- // Called when Chrome shuts down.
- void PushPendingLogsToPersistentStorage();
- // Ensures that scheduler is running, assuming the current settings are such
- // that metrics should be reported. If not, this is a no-op.
- void StartSchedulerIfNecessary();
- // Starts the process of uploading metrics data.
- void StartScheduledUpload();
- // Called by the client via a callback when final log info collection is
- // complete.
- void OnFinalLogInfoCollectionDone();
- // Prepares the initial stability log, which is only logged when the previous
- // run of Chrome crashed. This log contains any stability metrics left over
- // from that previous run, and only these stability metrics. It uses the
- // system profile from the previous session. |prefs_previous_version| is used
- // to validate the version number recovered from the system profile. Returns
- // true if a log was created.
- bool PrepareInitialStabilityLog(const std::string& prefs_previous_version);
- // Prepares the initial metrics log, which includes startup histograms and
- // profiler data, as well as incremental stability-related metrics.
- void PrepareInitialMetricsLog();
- // Creates a new MetricsLog instance with the given |log_type|.
- std::unique_ptr<MetricsLog> CreateLog(MetricsLog::LogType log_type);
- // Records the current environment (system profile) in |log|, and persists
- // the results in prefs and GlobalPersistentSystemProfile.
- void RecordCurrentEnvironment(MetricsLog* log, bool complete);
- // Record complete list of histograms into the current log.
- // Called when we close a log.
- void RecordCurrentHistograms();
- // Record complete list of stability histograms into the current log,
- // i.e., histograms with the |kUmaStabilityHistogramFlag| flag set.
- void RecordCurrentStabilityHistograms();
- // Handle completion of PrepareProviderMetricsLog which is run as a
- // background task.
- void PrepareProviderMetricsLogDone(
- std::unique_ptr<MetricsLog::IndependentMetricsLoader> loader,
- bool success);
- // Record a single independent profile and associated histogram from
- // metrics providers. If this returns true, one was found and there may
- // be more.
- bool PrepareProviderMetricsLog();
- // Records one independent histogram log and then reschedules itself to
- // check for others. The interval is so as to not adversely impact the UI.
- void PrepareProviderMetricsTask();
- // Updates the "last live" browser timestamp and schedules the next update.
- void UpdateLastLiveTimestampTask();
- // Sub-service for uploading logs.
- MetricsReportingService reporting_service_;
- // Manager for the various in-flight logs.
- MetricsLogManager log_manager_;
- // |histogram_snapshot_manager_| prepares histogram deltas for transmission.
- base::HistogramSnapshotManager histogram_snapshot_manager_;
- // Used to manage various metrics reporting state prefs, such as client id,
- // low entropy source and whether metrics reporting is enabled. Weak pointer.
- const raw_ptr<MetricsStateManager> state_manager_;
- // Used to interact with the embedder. Weak pointer; must outlive |this|
- // instance.
- const raw_ptr<MetricsServiceClient> client_;
- // Registered metrics providers.
- DelegatingProvider delegating_provider_;
- raw_ptr<PrefService> local_state_;
- base::ActionCallback action_callback_;
- // Indicate whether recording and reporting are currently happening.
- // These should not be set directly, but by calling SetRecording and
- // SetReporting.
- RecordingState recording_state_;
- // Indicate whether test mode is enabled, where the initial log should never
- // be cut, and logs are neither persisted nor uploaded.
- bool test_mode_active_;
- // The progression of states made by the browser are recorded in the following
- // state.
- State state_;
- // The initial metrics log, used to record startup metrics (histograms and
- // profiler data). Note that if a crash occurred in the previous session, an
- // initial stability log may be sent before this.
- std::unique_ptr<MetricsLog> initial_metrics_log_;
- // Whether the MetricsService object has received any notifications since
- // the last time a transmission was sent.
- bool idle_since_last_transmission_;
- // A number that identifies the how many times the app has been launched.
- int session_id_;
- // The scheduler for determining when log rotations should happen.
- std::unique_ptr<MetricsRotationScheduler> rotation_scheduler_;
- // Stores the time of the first call to |GetUptimes()|.
- base::TimeTicks first_updated_time_;
- // Stores the time of the last call to |GetUptimes()|.
- base::TimeTicks last_updated_time_;
- // Indicates if loading of independent metrics is currently active.
- bool independent_loader_active_ = false;
- // A set of observers that keeps track of the metrics reporting state.
- base::RepeatingCallbackList<void(bool)> enablement_observers_;
- #if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
- // Indicates whether OnAppEnterForeground() (true) or OnAppEnterBackground
- // (false) was called.
- bool is_in_foreground_ = false;
- #endif
- FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest, ActiveFieldTrialsReported);
- FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest, IsPluginProcess);
- FRIEND_TEST_ALL_PREFIXES(::ChromeMetricsServiceClientTest,
- TestRegisterMetricsServiceProviders);
- FRIEND_TEST_ALL_PREFIXES(::IOSChromeMetricsServiceClientTest,
- TestRegisterMetricsServiceProviders);
- SEQUENCE_CHECKER(sequence_checker_);
- // Weak pointers factory used to post task on different threads. All weak
- // pointers managed by this factory have the same lifetime as MetricsService.
- base::WeakPtrFactory<MetricsService> self_ptr_factory_{this};
- };
- } // namespace metrics
- #endif // COMPONENTS_METRICS_METRICS_SERVICE_H_
|