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
|
// 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.
#ifndef COMPONENTS_METRICS_METRICS_LOG_MANAGER_H_
#define COMPONENTS_METRICS_METRICS_LOG_MANAGER_H_
#include <stddef.h>
#include <memory>
#include <string>
#include <vector>
#include "base/macros.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 {
public:
// 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);
~MetricsLogManager();
// Makes |log| the current_log. This should only be called if there is not a
// current log.
void BeginLoggingWithLog(std::unique_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() ||
ongoing_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() :
ongoing_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. Public to allow to push log created by
// external components.
void StoreLog(const std::string& log_data, MetricsLog::LogType log_type);
private:
// Tracks whether unsent logs (if any) have been loaded from the serializer.
bool unsent_logs_loaded_;
// The log that we are still appending to.
std::unique_ptr<MetricsLog> current_log_;
// A paused, previously-current log.
std::unique_ptr<MetricsLog> paused_log_;
// Logs that have not yet been sent.
PersistedLogs initial_log_queue_;
PersistedLogs ongoing_log_queue_;
DISALLOW_COPY_AND_ASSIGN(MetricsLogManager);
};
} // namespace metrics
#endif // COMPONENTS_METRICS_METRICS_LOG_MANAGER_H_
|
