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
|
// 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.
#ifndef COMPONENTS_GCM_DRIVER_GCM_STATS_RECORDER_IMPL_H_
#define COMPONENTS_GCM_DRIVER_GCM_STATS_RECORDER_IMPL_H_
#include <stdint.h>
#include <string>
#include "base/containers/circular_deque.h"
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "components/gcm_driver/gcm_activity.h"
#include "google_apis/gcm/engine/connection_factory.h"
#include "google_apis/gcm/engine/mcs_client.h"
#include "google_apis/gcm/engine/registration_request.h"
#include "google_apis/gcm/engine/unregistration_request.h"
#include "google_apis/gcm/monitoring/gcm_stats_recorder.h"
namespace gcm {
enum class GCMDecryptionResult;
// Records GCM internal stats and activities for debugging purpose. Recording
// can be turned on/off by calling set_is_recording(...) function. It is turned
// off by default.
// This class is not thread safe. It is meant to be owned by a gcm client
// instance.
class GCMStatsRecorderImpl : public GCMStatsRecorder {
public:
GCMStatsRecorderImpl();
GCMStatsRecorderImpl(const GCMStatsRecorderImpl&) = delete;
GCMStatsRecorderImpl& operator=(const GCMStatsRecorderImpl&) = delete;
~GCMStatsRecorderImpl() override;
// Set a delegate to receive callback from the recorder.
void SetDelegate(Delegate* delegate);
// Clear all recorded activities.
void Clear();
// Records a message decryption failure caused by |result| for |app_id|.
void RecordDecryptionFailure(const std::string& app_id,
GCMDecryptionResult result);
// GCMStatsRecorder implementation:
void RecordCheckinInitiated(uint64_t android_id) override;
void RecordCheckinDelayedDueToBackoff(int64_t delay_msec) override;
void RecordCheckinSuccess() override;
void RecordCheckinFailure(const std::string& status,
bool will_retry) override;
void RecordConnectionInitiated(const std::string& host) override;
void RecordConnectionDelayedDueToBackoff(int64_t delay_msec) override;
void RecordConnectionSuccess() override;
void RecordConnectionFailure(int network_error) override;
void RecordConnectionResetSignaled(
ConnectionFactory::ConnectionResetReason reason) override;
void RecordRegistrationSent(const std::string& app_id,
const std::string& source) override;
void RecordRegistrationResponse(const std::string& app_id,
const std::string& source,
RegistrationRequest::Status status) override;
void RecordRegistrationRetryDelayed(const std::string& app_id,
const std::string& source,
int64_t delay_msec,
int retries_left) override;
void RecordUnregistrationSent(const std::string& app_id,
const std::string& source) override;
void RecordUnregistrationResponse(
const std::string& app_id,
const std::string& source,
UnregistrationRequest::Status status) override;
void RecordUnregistrationRetryDelayed(const std::string& app_id,
const std::string& source,
int64_t delay_msec,
int retries_left) override;
void RecordDataMessageReceived(const std::string& app_id,
const std::string& from,
int message_byte_size,
ReceivedMessageType message_type) override;
void RecordDataSentToWire(const std::string& app_id,
const std::string& receiver_id,
const std::string& message_id,
int queued) override;
void RecordNotifySendStatus(const std::string& app_id,
const std::string& receiver_id,
const std::string& message_id,
MCSClient::MessageSendStatus status,
size_t byte_size,
int ttl) override;
void RecordIncomingSendError(const std::string& app_id,
const std::string& receiver_id,
const std::string& message_id) override;
// Collect all recorded activities into |*recorded_activities|.
void CollectActivities(RecordedActivities* recorded_activities) const;
bool is_recording() const { return is_recording_; }
void set_is_recording(bool recording) { is_recording_ = recording; }
const base::circular_deque<CheckinActivity>& checkin_activities() const {
return checkin_activities_;
}
const base::circular_deque<ConnectionActivity>& connection_activities()
const {
return connection_activities_;
}
const base::circular_deque<RegistrationActivity>& registration_activities()
const {
return registration_activities_;
}
const base::circular_deque<ReceivingActivity>& receiving_activities() const {
return receiving_activities_;
}
const base::circular_deque<SendingActivity>& sending_activities() const {
return sending_activities_;
}
const base::circular_deque<DecryptionFailureActivity>&
decryption_failure_activities() const {
return decryption_failure_activities_;
}
protected:
// Notify the recorder delegate, if it exists, that an activity has been
// recorded.
void NotifyActivityRecorded();
void RecordCheckin(const std::string& event,
const std::string& details);
void RecordConnection(const std::string& event,
const std::string& details);
void RecordRegistration(const std::string& app_id,
const std::string& source,
const std::string& event,
const std::string& details);
void RecordReceiving(const std::string& app_id,
const std::string& from,
int message_byte_size,
const std::string& event,
const std::string& details);
void RecordSending(const std::string& app_id,
const std::string& receiver_id,
const std::string& message_id,
const std::string& event,
const std::string& details);
bool is_recording_;
raw_ptr<Delegate> delegate_;
base::circular_deque<CheckinActivity> checkin_activities_;
base::circular_deque<ConnectionActivity> connection_activities_;
base::circular_deque<RegistrationActivity> registration_activities_;
base::circular_deque<ReceivingActivity> receiving_activities_;
base::circular_deque<SendingActivity> sending_activities_;
base::circular_deque<DecryptionFailureActivity>
decryption_failure_activities_;
};
} // namespace gcm
#endif // COMPONENTS_GCM_DRIVER_GCM_STATS_RECORDER_IMPL_H_
|
