1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
|
// Copyright 2014 The Chromium Authors
// 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 <optional>
#include <string>
#include "base/callback_list.h"
#include "base/functional/callback_forward.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/statistics_recorder.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 "components/metrics/delegating_provider.h"
#include "components/metrics/metrics_log.h"
#include "components/metrics/metrics_log_store.h"
#include "components/metrics/metrics_logs_event_manager.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 first_run {
class FirstRunCoordinatorMetricsHelper;
}
namespace variations {
class SyntheticTrialRegistry;
}
namespace metrics {
class MetricsRotationScheduler;
class MetricsServiceClient;
class MetricsServiceObserver;
class MetricsStateManager;
// See metrics_service.cc for a detailed description.
class MetricsService {
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;
virtual ~MetricsService();
// 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();
// A passkey for owner-approved classes to access
// StartOutOfBandUploadIfPossible() - see
// </docs/patterns/passkey.md>.
class OutOfBandUploadPasskey {
private:
OutOfBandUploadPasskey() = default;
~OutOfBandUploadPasskey() = default;
friend class first_run::FirstRunCoordinatorMetricsHelper;
FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest, OutOfBandLogUpload);
};
// Starts the process of uploading metrics data outside of the uploads
// scheduled by the MetricsRotationScheduler. Upload attempt is silently
// dropped (never retried) and function returns false if:
// 1) the MetricsService has not uploaded the first ongoing log OR
// 2) recording is disabled OR
// 3) reporting is off and the first ongoing log hasn't been created.
//
// This function is currently only used within the iOS FRE screens and should
// be used very sparingly.
bool StartOutOfBandUploadIfPossible(OutOfBandUploadPasskey passkey);
// Returns the client ID for this client, or the empty string if metrics
// recording is not currently running.
std::string GetClientId() const;
// Get the low entropy source values.
int GetLowEntropySource();
int GetOldLowEntropySource();
int GetPseudoLowEntropySource();
// 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);
// 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)
// Increments the global `fg_bg_id` for when OnAppEnterBackground() or
// OnAppEnterForeground() below has closed the current log. In some cases,
// this may be no-op; see implementation for details.
void IncrementFgBgIdIfNeeded(
std::optional<bool> previous_is_in_foreground) const;
// Clears `fg_bg_id` from the current log for when OnAppEnterBackground() or
// OnAppEnterForeground() below cannot close it. In some cases, this may be
// no-op; see implementation for details.
void ClearFgBgIdIfNeeded(std::optional<bool> previous_is_in_foreground) const;
// 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)
// Called when a document first starts loading.
void OnPageLoadStarted();
// 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)
// 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.
std::optional<bool> GetCurrentUserMetricsConsent() const;
// Returns the current logged in user id. See comments at
// MetricsServiceClient::GetCurrentUserId() for more details.
std::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);
// 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();
// Returns the delay before the init tasks (to asynchronously initialize
// metrics providers) run.
base::TimeDelta GetInitializationDelay();
// Returns the delay before the task to update the "last alive timestamp" is
// run.
base::TimeDelta GetUpdateLastAliveTimestampDelay();
MetricsLogStore* LogStoreForTest() {
return reporting_service_.metrics_log_store();
}
// Test hook to safely stage the current log in the log store.
bool StageCurrentLogForTest();
MetricsLog* GetCurrentLogForTest() { return current_log_.get(); }
DelegatingProvider* GetDelegatingProviderForTesting() {
return &delegating_provider_;
}
// Adds/Removes a logs observer. Observers are notified when a log is newly
// created and is now known by the metrics service. This may occur when
// closing a log, or when loading a log from persistent storage. Observers are
// also notified when an event occurs on the log (e.g., log is staged,
// uploaded, etc.). See MetricsLogsEventManager::LogEvent for more details.
void AddLogsObserver(MetricsLogsEventManager::Observer* observer);
void RemoveLogsObserver(MetricsLogsEventManager::Observer* observer);
MetricsServiceObserver* logs_event_observer() {
return logs_event_observer_.get();
}
// Creates a new MetricsLog instance with the given |log_type|.
std::unique_ptr<MetricsLog> CreateLogForTesting(
MetricsLog::LogType log_type) {
return CreateLog(log_type);
}
// Used to test observers of the logs_event_manager_.
void NotifyLogsEventManagerForTesting(MetricsLogsEventManager::LogEvent event,
std::string_view log_hash,
std::string_view message) {
logs_event_manager_.NotifyLogEvent(event, log_hash, message);
}
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 and 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,
};
// The result of a call to FinalizeLog().
struct FinalizedLog {
FinalizedLog();
~FinalizedLog();
// This type is move only.
FinalizedLog(FinalizedLog&& other);
FinalizedLog& operator=(FinalizedLog&& other);
// The size of the uncompressed log data. This is only used for calculating
// some metrics.
size_t uncompressed_log_size;
// A LogInfo object representing the log, which contains its compressed
// data, hash, signature, timestamp, and some metadata.
std::unique_ptr<UnsentLogStore::LogInfo> log_info;
};
// Writes snapshots of histograms owned by the StatisticsRecorder to a log.
// Does not take ownership of the log.
// TODO(crbug.com/40897621): Although this class takes in |required_flags| in
// its constructor to filter the StatisticsRecorder histograms being put into
// the log, the |histogram_snapshot_manager_| is not aware of this. So if
// the |histogram_snapshot_manager_| is passed to some other caller, this
// caller will need to manually filter the histograms. Re-factor the code so
// that this is not needed.
class MetricsLogHistogramWriter {
public:
explicit MetricsLogHistogramWriter(MetricsLog* log);
MetricsLogHistogramWriter(MetricsLog* log,
base::HistogramBase::Flags required_flags);
MetricsLogHistogramWriter(const MetricsLogHistogramWriter&) = delete;
MetricsLogHistogramWriter& operator=(const MetricsLogHistogramWriter&) =
delete;
~MetricsLogHistogramWriter();
// Snapshots the deltas of histograms known by the StatisticsRecorder and
// writes them to the log passed in the constructor. This also marks the
// samples (the deltas) as logged.
void SnapshotStatisticsRecorderDeltas();
base::HistogramSnapshotManager* histogram_snapshot_manager() {
return histogram_snapshot_manager_.get();
}
// Notifies the histogram writer that the `log` passed in through the
// constructor is about to be destroyed.
void NotifyLogBeingFinalized();
private:
// Used to select which histograms to record when calling
// SnapshotStatisticsRecorderHistograms().
const base::HistogramBase::Flags required_flags_;
// Used to write histograms to the log passed in the constructor. Null after
// `NotifyLogBeingFinalized()`.
std::unique_ptr<base::HistogramFlattener> flattener_;
// Used to snapshot histograms.
std::unique_ptr<base::HistogramSnapshotManager> histogram_snapshot_manager_;
};
// Loads "independent" metrics from a metrics provider and executes a
// callback when complete, which could be immediate or after some
// execution on a background thread.
class IndependentMetricsLoader {
public:
explicit IndependentMetricsLoader(std::unique_ptr<MetricsLog> log,
std::string app_version,
std::string signing_key);
IndependentMetricsLoader(const IndependentMetricsLoader&) = delete;
IndependentMetricsLoader& operator=(const IndependentMetricsLoader&) =
delete;
~IndependentMetricsLoader();
// Call ProvideIndependentMetrics (which may execute on a background thread)
// for the |metrics_provider| and execute the |done_callback| when complete
// with the result (true if successful). |done_callback| must own |this|.
void Run(base::OnceCallback<void(bool)> done_callback,
MetricsProvider* metrics_provider);
// Finalizes/serializes |log_|, and stores the result in |finalized_log_|.
// Should only be called once, after |log_| has been filled.
void FinalizeLog();
// Returns whether FinalizeLog() was called.
bool HasFinalizedLog();
// Extracts |finalized_log_|. Should be only called once, after
// FinalizeLog() has been called. No more operations should be done after
// this.
FinalizedLog ReleaseFinalizedLog();
private:
std::unique_ptr<MetricsLog> log_;
std::unique_ptr<base::HistogramFlattener> flattener_;
std::unique_ptr<base::HistogramSnapshotManager> snapshot_manager_;
bool run_called_ = false;
// Used for finalizing |log_| in FinalizeLog().
const std::string app_version_;
const std::string signing_key_;
// Stores the result of FinalizeLog().
FinalizedLog finalized_log_;
bool finalize_log_called_ = false;
bool release_finalized_log_called_ = false;
};
// 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);
// 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. If |call_providers|
// is true, OnDidCreateMetricsLog() of providers will be called right after
// opening the new log.
void OpenNewLog(bool call_providers = true);
// Closes out the current log after adding any last information. |async|
// determines whether finalizing the log will be done in a background thread.
// |log_stored_callback| will be run (on the main thread) after the finalized
// log is stored.
void CloseCurrentLog(
bool async,
MetricsLogsEventManager::CreateReason reason,
base::OnceClosure log_stored_callback = base::DoNothing());
// Stores the |finalized_log| in |log_store()|.
void StoreFinalizedLog(MetricsLog::LogType log_type,
MetricsLogsEventManager::CreateReason reason,
base::OnceClosure done_callback,
FinalizedLog finalized_log);
// Pushes the text of the current and staged logs into persistent storage.
void PushPendingLogsToPersistentStorage(
MetricsLogsEventManager::CreateReason reason);
// 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();
// Called via a callback after a periodic ongoing log (created through the
// MetricsRotationScheduler) was stored in |log_store()|.
void OnAsyncPeriodicOngoingLogStored();
// 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);
// 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);
// Handle completion of PrepareProviderMetricsLog which is run as a
// background task.
void PrepareProviderMetricsLogDone(
std::unique_ptr<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();
// Returns whether it is too early to close a log.
bool IsTooEarlyToCloseLog();
// Called if this install is detected as cloned.
void OnClonedInstallDetected();
// Snapshots histogram deltas using the passed |log_histogram_writer| and then
// finalizes |log| by calling FinalizeLog(). |log|, |current_app_version| and
// |signing_key| are used to finalize the log (see FinalizeLog()).
static FinalizedLog SnapshotDeltasAndFinalizeLog(
std::unique_ptr<MetricsLogHistogramWriter> log_histogram_writer,
std::unique_ptr<MetricsLog> log,
bool truncate_events,
std::optional<ChromeUserMetricsExtension::RealLocalTime> close_time,
std::string&& current_app_version,
std::string&& signing_key);
// Finalizes |log| (see MetricsLog::FinalizeLog()). The |signing_key| is used
// to compute a signature for the log.
static FinalizedLog FinalizeLog(
std::unique_ptr<MetricsLog> log,
bool truncate_events,
std::optional<ChromeUserMetricsExtension::RealLocalTime> close_time,
const std::string& current_app_version,
const std::string& signing_key);
// Sub-service for uploading logs.
MetricsReportingService reporting_service_;
// The log that we are still appending to.
std::unique_ptr<MetricsLog> current_log_;
// 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_;
// 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_;
// Indicates if loading of independent metrics is currently active.
bool independent_loader_active_ = false;
// Indicates whether or not there is currently a periodic ongoing log being
// finalized (or is scheduled to be finalized).
bool pending_ongoing_log_ = false;
// Logs event manager to keep track of the various logs that the metrics
// service interacts with. An unowned pointer of this instance is passed down
// to various objects that are owned by this class.
MetricsLogsEventManager logs_event_manager_;
// An observer that observes all events notified through |logs_event_manager_|
// since the creation of this MetricsService instance. This is only created
// if this is a debug build, or the |kExportUmaLogsToFile| command line flag
// is passed. This is primarily used by the chrome://metrics-internals debug
// page.
std::unique_ptr<MetricsServiceObserver> logs_event_observer_;
// Subscription for a callback that runs if this install is detected as
// cloned.
base::CallbackListSubscription cloned_install_subscription_;
#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
// Indicates whether OnAppEnterForeground() (true) or OnAppEnterBackground
// (false) was called.
std::optional<bool> is_in_foreground_ = std::nullopt;
#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_
|