Add GCM check in status code metric collection. We also decided to collect registration success sig…

google_apis/gcm/engine/checkin_request.cc

 // 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 "google_apis/gcm/engine/checkin_request.h"
 
 #include "base/bind.h"
 #include "base/message_loop/message_loop.h"
+#include "base/metrics/histogram.h"
 #include "google_apis/gcm/protocol/checkin.pb.h"
 #include "net/http/http_status_code.h"
 #include "net/url_request/url_fetcher.h"
 #include "net/url_request/url_request_status.h"
 #include "url/gurl.h"
 
 namespace gcm {
 
 namespace {
 const char kCheckinURL[] = "https://android.clients.google.com/checkin";
 const char kRequestContentType[] = "application/x-protobuf";
 const int kRequestVersionValue = 2;
+
+// This enum is also used in an UMA histogram (GCMRegistrationRequestStatus
+// enum defined in tools/metrics/histograms/histogram.xml). Hence the entries
+// here shouldn't be deleted or re-ordered and new ones should be added to
+// the end.
+enum CheckinRequestStatus {
+  SUCCESS,                    // Checkin completed successfully.
+  URL_FETCHING_FAILED,        // URL fetching failed.
+  HTTP_BAD_REQUEST,           // The request was malformed.
+  HTTP_UNAUTHORIZED,          // The security token didn't match the android id.
+  HTTP_NOT_OK,                // HTTP status was not OK.
+  FAILED_PARSING_RESPONSE,    // Failed to parse the checkin response.
+  ZERO_ID_OR_TOKEN,           // Either returned android id or security token
+                              // was zero.
+  // NOTE: always keep this entry at the end. Add new status types only
+  // immediately above this line. Make sure to update the corresponding
+  // histogram enum accordingly.
+  STATUS_COUNT
+};
+
 }  // namespace
 
 CheckinRequest::CheckinRequest(
     const CheckinRequestCallback& callback,
     const net::BackoffEntry::Policy& backoff_policy,
     const checkin_proto::ChromeBuildProto& chrome_build_proto,
     int64 user_serial_number,
     uint64 android_id,
     uint64 security_token,
     net::URLRequestContextGetter* request_context_getter)
@@ skipping 56 matching lines @@
   }
 
   Start();
 }
 
 void CheckinRequest::OnURLFetchComplete(const net::URLFetcher* source) {
   std::string response_string;
   checkin_proto::AndroidCheckinResponse response_proto;
   if (!source->GetStatus().is_success()) {
     LOG(ERROR) << "Failed to get checkin response. Fetcher failed. Retrying.";
+    UMA_HISTOGRAM_ENUMERATION("GCM.CheckinRequestStatus",

[Alexei Svitkine (slow), 2014/02/12 17:49:05]

Nit: Instead of repeating this histogram macro in many places, can you make a
helper function that just takes the CheckinRequestStatus enum value as a
parameter and logs this histogram? The macro expands to a lot of code and its
better for generated machine code size to not repeat it too much, if possible.

[juyik, 2014/02/12 18:15:41]

Done.

+                              URL_FETCHING_FAILED,
+                              STATUS_COUNT);
     RetryWithBackoff(true);
     return;
   }
 
   net::HttpStatusCode response_status = static_cast<net::HttpStatusCode>(
       source->GetResponseCode());
   if (response_status == net::HTTP_BAD_REQUEST ||
       response_status == net::HTTP_UNAUTHORIZED) {
     // BAD_REQUEST indicates that the request was malformed.
     // UNAUTHORIZED indicates that security token didn't match the android id.
     LOG(ERROR) << "No point retrying the checkin with status: "
                << response_status << ". Checkin failed.";
+    if (response_status == net::HTTP_BAD_REQUEST) {
+      UMA_HISTOGRAM_ENUMERATION("GCM.CheckinRequestStatus",
+                                HTTP_BAD_REQUEST,
+                                STATUS_COUNT);
+    } else {
+      UMA_HISTOGRAM_ENUMERATION("GCM.CheckinRequestStatus",
+                                HTTP_UNAUTHORIZED,
+                                STATUS_COUNT);
+    }
     callback_.Run(0,0);
     return;
   }
 
   if (response_status != net::HTTP_OK ||
       !source->GetResponseAsString(&response_string) ||
       !response_proto.ParseFromString(response_string)) {
     LOG(ERROR) << "Failed to get checkin response. HTTP Status: "
                << response_status << ". Retrying.";
+    if (response_status != net::HTTP_OK) {
+      UMA_HISTOGRAM_ENUMERATION("GCM.CheckinRequestStatus",
+                                HTTP_NOT_OK,
+                                STATUS_COUNT);
+    } else {
+      UMA_HISTOGRAM_ENUMERATION("GCM.CheckinRequestStatus",
+                                FAILED_PARSING_RESPONSE,
+                                STATUS_COUNT);
+    }
     RetryWithBackoff(true);
     return;
   }
 
   if (!response_proto.has_android_id() ||
       !response_proto.has_security_token() ||
       response_proto.android_id() == 0 ||
       response_proto.security_token() == 0) {
     LOG(ERROR) << "Android ID or security token is 0. Retrying.";
+    UMA_HISTOGRAM_ENUMERATION("GCM.CheckinRequestStatus",
+                              ZERO_ID_OR_TOKEN,
+                              STATUS_COUNT);
     RetryWithBackoff(true);
     return;
   }
 
+  UMA_HISTOGRAM_ENUMERATION("GCM.CheckinRequestStatus", SUCCESS, STATUS_COUNT);
   callback_.Run(response_proto.android_id(), response_proto.security_token());
 }
 
 }  // namespace gcm