Add activity recording capability to gcm internals page. User can refresh, start/stop recording, an…

google_apis/gcm/gcm_stats_recorder.h

+// 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 GOOGLE_APIS_GCM_GCM_STATS_RECORDER_H_
+#define GOOGLE_APIS_GCM_GCM_STATS_RECORDER_H_
+
+#include <deque>
+#include <string>
+#include <vector>
+
+#include "base/time/time.h"
+#include "google_apis/gcm/base/gcm_export.h"
+#include "google_apis/gcm/engine/mcs_client.h"
+
+namespace gcm {
+
+// Records GCM internal stats and activities for debugging purpose. Recording
+// can be turned on/off by calling SetRecording(...) 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 GCM_EXPORT GCMStatsRecorder {
+ public:
+  // Contains data that are common to all activity kinds below.
+  struct GCM_EXPORT Activity {
+    Activity();
+    virtual ~Activity();
+
+    base::Time time;
+    std::string event;  // A short description of the event.

[Nicolas Zea, 2014/04/01 18:53:21]

nit: align comments

[juyik, 2014/04/01 22:40:36]

Done.

+    std::string details;  // Any additional detail about the event.
+  };
+
+  // Contains relevant data of a send-message step.
+  struct GCM_EXPORT SendingActivity : Activity {
+    SendingActivity();
+    virtual ~SendingActivity() OVERRIDE;

[Nicolas Zea, 2014/04/01 18:53:21]

nit: override not needed

[juyik, 2014/04/01 22:40:36]

Done.

+
+    std::string app_id;
+    std::string receiver_id;
+    std::string message_id;
+  };
+
+  GCMStatsRecorder();
+  virtual ~GCMStatsRecorder();
+
+  // Indicates whether the recorder is currently recording activities or not.
+  bool is_recording() const {
+    return is_recording_;
+  }
+
+  // Turns recording on/off.
+  void SetRecording(bool recording);
+
+  // Clear all recorded activities.
+  void Clear();
+
+  // Records when the outgoing data message is sent to wire.

[Nicolas Zea, 2014/04/01 18:53:21]

nit: rather than say "Records when.." in these comments, "Records that" is a bit
clearer (and use past tense). So, in this case, it would be "Record that an
outgoing message was sent over the wire".

[juyik, 2014/04/01 22:40:36]

Done.

+  void RecordDataSentToWire(const std::string& app_id,
+                            const std::string& receiver_id,
+                            const std::string& message_id,
+                            int queued);
+  // Records when the MCS client sends a send status notification to callback.
+  void RecordNotifySendStatus(const std::string& app_id,
+                              const std::string& receiver_id,
+                              const std::string& message_id,
+                              MCSClient::MessageSendStatus status,
+                              int byte_size,
+                              int ttl);
+  // Records when a 'send error' message is received.
+  void RecordIncomingSendError(const std::string& app_id,
+                               const std::string& receiver_id,
+                               const std::string& message_id);
+
+  void CollectSendingActivities(std::vector<SendingActivity>* activities) const;

[fgorski, 2014/04/01 03:36:29]

Add documentation, including information about the order of entries.

[juyik, 2014/04/01 22:40:36]

Done.

+
+  const std::deque<SendingActivity>& sending_activities() const {
+    return sending_activities_;
+  }
+
+ protected:
+  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_;
+
+  std::deque<SendingActivity> sending_activities_;
+
+  DISALLOW_COPY_AND_ASSIGN(GCMStatsRecorder);
+};
+
+}  // namespace gcm
+
+#endif  // GOOGLE_APIS_GCM_GCM_STATS_RECORDER_H_