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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_DRIVE_EVENT_LOGGER_H_
#define COMPONENTS_DRIVE_EVENT_LOGGER_H_
#include <stddef.h>
#include <string>
#include <vector>
#include "base/compiler_specific.h"
#include "base/containers/circular_deque.h"
#include "base/logging.h"
#include "base/synchronization/lock.h"
#include "base/time/time.h"
#include "components/drive/drive_export.h"
namespace drive {
// The default history size used by EventLogger.
inline constexpr int kDefaultHistorySize = 1000;
// EventLogger is used to collect and expose text messages for diagnosing
// behaviors of Google APIs stuff. For instance, the collected messages are
// exposed to chrome:drive-internals.
class COMPONENTS_DRIVE_EXPORT EventLogger {
public:
// Represents a single event log.
struct Event {
Event(int id, logging::LogSeverity severity, const std::string& what);
int id; // Monotonically increasing ID starting from 0.
logging::LogSeverity severity; // Severity of the event.
base::Time when; // When the event occurred.
std::string what; // What happened.
};
// Creates an event logger that keeps the latest kDefaultHistorySize events.
EventLogger();
EventLogger(const EventLogger&) = delete;
EventLogger& operator=(const EventLogger&) = delete;
~EventLogger();
// Logs a message and its severity.
// Can be called from any thread as long as the object is alive.
void LogRawString(logging::LogSeverity severity, const std::string& what);
// Logs a message with formatting.
// Can be called from any thread as long as the object is alive.
PRINTF_FORMAT(3, 4)
void Log(logging::LogSeverity severity, const char* format, ...);
// Sets the history size. The existing history is cleared.
// Can be called from any thread as long as the object is alive.
void SetHistorySize(size_t history_size);
// Gets the list of latest events (the oldest event comes first).
// Can be called from any thread as long as the object is alive.
std::vector<Event> GetHistory();
private:
base::circular_deque<Event> history_; // guarded by lock_.
size_t history_size_; // guarded by lock_.
int next_event_id_; // guarded by lock_.
base::Lock lock_;
};
} // namespace drive
#endif // COMPONENTS_DRIVE_EVENT_LOGGER_H_
|
