blob: 7fb28b38e1b4c2f042a6b533c1bc5ad5dfd76ed8 [file] [log] [blame]
// 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.
#include <string>
#include <vector>
#include "base/basictypes.h"
#include "base/memory/scoped_ptr.h"
#include "components/metrics/metrics_log.h"
#include "components/metrics/persisted_logs.h"
namespace metrics {
// Manages all the log objects used by a MetricsService implementation. Keeps
// track of both an in progress log and a log that is staged for uploading as
// text, as well as saving logs to, and loading logs from, persistent storage.
class MetricsLogManager {
// The metrics log manager will persist it's unsent logs by storing them in
// |local_state|, and will not persist ongoing logs over
// |max_ongoing_log_size|.
MetricsLogManager(PrefService* local_state, size_t max_ongoing_log_size);
// Makes |log| the current_log. This should only be called if there is not a
// current log.
void BeginLoggingWithLog(scoped_ptr<MetricsLog> log);
// Returns the in-progress log.
MetricsLog* current_log() { return current_log_.get(); }
// Closes current_log(), compresses it, and stores the compressed log for
// later, leaving current_log() NULL.
void FinishCurrentLog();
// Returns true if there are any logs waiting to be uploaded.
bool has_unsent_logs() const {
return initial_log_queue_.size() || ongoing_log_queue_.size();
// Populates staged_log_text() with the next stored log to send.
// Should only be called if has_unsent_logs() is true.
void StageNextLogForUpload();
// Returns true if there is a log that needs to be, or is being, uploaded.
bool has_staged_log() const {
return initial_log_queue_.has_staged_log() ||
// The text of the staged log, as a serialized protobuf.
// Will trigger a DCHECK if there is no staged log.
const std::string& staged_log() const {
return initial_log_queue_.has_staged_log() ?
initial_log_queue_.staged_log() : ongoing_log_queue_.staged_log();
// The SHA1 hash of the staged log.
// Will trigger a DCHECK if there is no staged log.
const std::string& staged_log_hash() const {
return initial_log_queue_.has_staged_log() ?
initial_log_queue_.staged_log_hash() :
// Discards the staged log.
void DiscardStagedLog();
// Closes and discards |current_log|.
void DiscardCurrentLog();
// Sets current_log to NULL, but saves the current log for future use with
// ResumePausedLog(). Only one log may be paused at a time.
// TODO(stuartmorgan): Pause/resume support is really a workaround for a
// design issue in initial log writing; that should be fixed, and pause/resume
// removed.
void PauseCurrentLog();
// Restores the previously paused log (if any) to current_log().
// This should only be called if there is not a current log.
void ResumePausedLog();
// Saves any unsent logs to persistent storage.
void PersistUnsentLogs();
// Loads any unsent logs from persistent storage.
void LoadPersistedUnsentLogs();
// Saves |log_data| as the given type.
void StoreLog(const std::string& log_data, MetricsLog::LogType log_type);
// Tracks whether unsent logs (if any) have been loaded from the serializer.
bool unsent_logs_loaded_;
// The log that we are still appending to.
scoped_ptr<MetricsLog> current_log_;
// A paused, previously-current log.
scoped_ptr<MetricsLog> paused_log_;
// Logs that have not yet been sent.
PersistedLogs initial_log_queue_;
PersistedLogs ongoing_log_queue_;
} // namespace metrics