Merge pull request #2151 from sidrakesh93/master

Changes required for reporting metrics to performance database server

5 files changed, 428 insertions, 5 deletions

diff --git a/test/cpp/qps/perf_db.proto b/test/cpp/qps/perf_db.proto
new file mode 100644
index 0000000000..60e038406a
--- /dev/null
+++ b/test/cpp/qps/perf_db.proto
@@ -0,0 +1,71 @@
+// Copyright 2015, Google Inc.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//     * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+syntax = "proto3";
+
+import "test/cpp/qps/qpstest.proto";
+
+package grpc.testing;
+
+service PerfDbTransfer {
+  // Sends client info
+  rpc RecordSingleClientData(SingleUserRecordRequest)
+      returns (SingleUserRecordReply) {
+  }
+}
+
+// Metrics to be stored
+message Metrics {
+  double qps = 1;
+  double qps_per_core = 2;
+  double perc_lat_50 = 3;
+  double perc_lat_90 = 4;
+  double perc_lat_95 = 5;
+  double perc_lat_99 = 6;
+  double perc_lat_99_point_9 = 7;
+  double server_system_time = 8;
+  double server_user_time = 9;
+  double client_system_time = 10;
+  double client_user_time = 11;
+}
+
+// Request for storing a single user's data
+message SingleUserRecordRequest {
+  string hashed_id = 1;
+  string test_name = 2;
+  string sys_info = 3;
+  string tag = 4;
+  Metrics metrics = 5;
+  ClientConfig client_config = 6;
+  ServerConfig server_config = 7;
+}
+
+// Reply to request for storing single user's data
+message SingleUserRecordReply {
+}
diff --git a/test/cpp/qps/perf_db_client.cc b/test/cpp/qps/perf_db_client.cc
new file mode 100644
index 0000000000..08d20f0b8d
--- /dev/null
+++ b/test/cpp/qps/perf_db_client.cc
@@ -0,0 +1,143 @@
+/*
+ *
+ * Copyright 2015, Google Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+#include "test/cpp/qps/perf_db_client.h"
+
+namespace grpc {
+namespace testing {
+
+// sets the client and server config information
+void PerfDbClient::setConfigs(const ClientConfig& client_config,
+                              const ServerConfig& server_config) {
+  client_config_ = client_config;
+  server_config_ = server_config;
+}
+
+// sets the QPS
+void PerfDbClient::setQps(double qps) {
+  qps_ = qps;
+}
+
+// sets the QPS per core
+void PerfDbClient::setQpsPerCore(double qps_per_core) {
+  qps_per_core_ = qps_per_core;
+}
+
+// sets the 50th, 90th, 95th, 99th and 99.9th percentile latency
+void PerfDbClient::setLatencies(double perc_lat_50,
+                                double perc_lat_90,
+                                double perc_lat_95,
+                                double perc_lat_99,
+                                double perc_lat_99_point_9) {
+  perc_lat_50_ = perc_lat_50;
+  perc_lat_90_ = perc_lat_90;
+  perc_lat_95_ = perc_lat_95;
+  perc_lat_99_ = perc_lat_99;
+  perc_lat_99_point_9_ = perc_lat_99_point_9;
+}
+
+// sets the server and client, user and system times
+void PerfDbClient::setTimes(double server_system_time, double server_user_time,
+                            double client_system_time, double client_user_time) {
+  server_system_time_ = server_system_time;
+  server_user_time_ = server_user_time;
+  client_system_time_ = client_system_time;
+  client_user_time_ = client_user_time;
+}
+
+// sends the data to the performance database server
+bool PerfDbClient::sendData(std::string hashed_id, std::string test_name,
+                            std::string sys_info, std::string tag) {
+  // Data record request object
+  SingleUserRecordRequest single_user_record_request;
+
+  // setting access token, name of the test and the system information
+  single_user_record_request.set_hashed_id(hashed_id);
+  single_user_record_request.set_test_name(test_name);
+  single_user_record_request.set_sys_info(sys_info);
+  single_user_record_request.set_tag(tag);
+
+  // setting configs
+  *(single_user_record_request.mutable_client_config()) = client_config_;
+  *(single_user_record_request.mutable_server_config()) = server_config_;
+
+  Metrics* metrics = single_user_record_request.mutable_metrics();
+
+  // setting metrcs in data record request
+  if (qps_ != DBL_MIN) {
+    metrics->set_qps(qps_);
+  }
+  if (qps_per_core_ != DBL_MIN) {
+    metrics->set_qps_per_core(qps_per_core_);
+  }
+  if (perc_lat_50_ != DBL_MIN) {
+    metrics->set_perc_lat_50(perc_lat_50_);
+  }
+  if (perc_lat_90_ != DBL_MIN) {
+    metrics->set_perc_lat_90(perc_lat_90_);
+  }
+  if (perc_lat_95_ != DBL_MIN) {
+    metrics->set_perc_lat_95(perc_lat_95_);
+  }
+  if (perc_lat_99_ != DBL_MIN) {
+    metrics->set_perc_lat_99(perc_lat_99_);
+  }
+  if (perc_lat_99_point_9_ != DBL_MIN) {
+    metrics->set_perc_lat_99_point_9(perc_lat_99_point_9_);
+  }
+  if (server_system_time_ != DBL_MIN) {
+    metrics->set_server_system_time(server_system_time_);
+  }
+  if (server_user_time_ != DBL_MIN) {
+    metrics->set_server_user_time(server_user_time_);
+  }
+  if (client_system_time_ != DBL_MIN) {
+    metrics->set_client_system_time(client_system_time_);
+  }
+  if (client_user_time_ != DBL_MIN) {
+    metrics->set_client_user_time(client_user_time_);
+  }
+
+  SingleUserRecordReply single_user_record_reply;
+  ClientContext context;
+
+  Status status = stub_->RecordSingleClientData(
+      &context, single_user_record_request, &single_user_record_reply);
+  if (status.ok()) {
+    return true;  // data sent to database successfully
+  } else {
+    return false;  // error in data sending
+  }
+}
+}  // testing
+}  // grpc
diff --git a/test/cpp/qps/perf_db_client.h b/test/cpp/qps/perf_db_client.h
new file mode 100644
index 0000000000..ce7a88bbff
--- /dev/null
+++ b/test/cpp/qps/perf_db_client.h
@@ -0,0 +1,115 @@
+/*
+ *
+ * Copyright 2015, Google Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+#include <iostream>
+#include <memory>
+#include <string>
+#include <cfloat>
+
+#include <grpc/grpc.h>
+#include <grpc++/channel_arguments.h>
+#include <grpc++/channel_interface.h>
+#include <grpc++/client_context.h>
+#include <grpc++/create_channel.h>
+#include <grpc++/credentials.h>
+#include <grpc++/status.h>
+#include "test/cpp/qps/perf_db.grpc.pb.h"
+
+namespace grpc {
+namespace testing {
+
+// Manages data sending to performance database server
+class PerfDbClient {
+ public:
+  PerfDbClient() {
+    qps_ = DBL_MIN;
+    qps_per_core_ = DBL_MIN;
+    perc_lat_50_ = DBL_MIN;
+    perc_lat_90_ = DBL_MIN;
+    perc_lat_95_ = DBL_MIN;
+    perc_lat_99_ = DBL_MIN;
+    perc_lat_99_point_9_ = DBL_MIN;
+    server_system_time_ = DBL_MIN;
+    server_user_time_ = DBL_MIN;
+    client_system_time_ = DBL_MIN;
+    client_user_time_ = DBL_MIN;
+  }
+
+  void init(std::shared_ptr<ChannelInterface> channel) {
+    stub_ = PerfDbTransfer::NewStub(channel);
+  }
+
+  ~PerfDbClient() {}
+
+  // sets the client and server config information
+  void setConfigs(const ClientConfig& client_config,
+                  const ServerConfig& server_config);
+
+  // sets the qps
+  void setQps(double qps);
+
+  // sets the qps per core
+  void setQpsPerCore(double qps_per_core);
+
+  // sets the 50th, 90th, 95th, 99th and 99.9th percentile latency
+  void setLatencies(double perc_lat_50, double perc_lat_90,
+                    double perc_lat_95, double perc_lat_99,
+                    double perc_lat_99_point_9);
+
+  // sets the server and client, user and system times
+  void setTimes(double server_system_time, double server_user_time,
+                double client_system_time, double client_user_time);
+
+  // sends the data to the performance database server
+  bool sendData(std::string hashed_id, std::string test_name,
+                std::string sys_info, std::string tag);
+
+ private:
+  std::unique_ptr<PerfDbTransfer::Stub> stub_;
+  ClientConfig client_config_;
+  ServerConfig server_config_;
+  double qps_;
+  double qps_per_core_;
+  double perc_lat_50_;
+  double perc_lat_90_;
+  double perc_lat_95_;
+  double perc_lat_99_;
+  double perc_lat_99_point_9_;
+  double server_system_time_;
+  double server_user_time_;
+  double client_system_time_;
+  double client_user_time_;
+};
+
+}  // namespace testing
+}  // namespace grpc
diff --git a/test/cpp/qps/report.cc b/test/cpp/qps/report.cc
index 94aacdbd1c..ff01ec1501 100644
--- a/test/cpp/qps/report.cc
+++ b/test/cpp/qps/report.cc
@@ -67,7 +67,6 @@ void CompositeReporter::ReportTimes(const ScenarioResult& result) {
   }
 }
 
-
 void GprLogReporter::ReportQPS(const ScenarioResult& result) {
   gpr_log(GPR_INFO, "QPS: %.1f",
           result.latencies.Count() /
@@ -76,10 +75,9 @@ void GprLogReporter::ReportQPS(const ScenarioResult& result) {
 }
 
 void GprLogReporter::ReportQPSPerCore(const ScenarioResult& result) {
-  auto qps =
-      result.latencies.Count() /
-      average(result.client_resources,
-          [](ResourceUsage u) { return u.wall_time; });
+  auto qps = result.latencies.Count() /
+             average(result.client_resources,
+                     [](ResourceUsage u) { return u.wall_time; });
 
   gpr_log(GPR_INFO, "QPS: %.1f (%.1f/server core)", qps,
           qps / result.server_config.threads());
@@ -118,5 +116,71 @@ void GprLogReporter::ReportTimes(const ScenarioResult& result) {
                   [](ResourceUsage u) { return u.wall_time; }));
 }
 
+void PerfDbReporter::ReportQPS(const ScenarioResult& result) {
+  auto qps = result.latencies.Count() /
+             average(result.client_resources,
+                     [](ResourceUsage u) { return u.wall_time; });
+
+  perf_db_client_.setQps(qps);
+  perf_db_client_.setConfigs(result.client_config, result.server_config);
+}
+
+void PerfDbReporter::ReportQPSPerCore(const ScenarioResult& result) {
+  auto qps = result.latencies.Count() /
+             average(result.client_resources,
+                     [](ResourceUsage u) { return u.wall_time; });
+
+  auto qpsPerCore = qps / result.server_config.threads();
+
+  perf_db_client_.setQps(qps);
+  perf_db_client_.setQpsPerCore(qpsPerCore);
+  perf_db_client_.setConfigs(result.client_config, result.server_config);
+}
+
+void PerfDbReporter::ReportLatency(const ScenarioResult& result) {
+  perf_db_client_.setLatencies(result.latencies.Percentile(50) / 1000,
+                             result.latencies.Percentile(90) / 1000,
+                             result.latencies.Percentile(95) / 1000,
+                             result.latencies.Percentile(99) / 1000,
+                             result.latencies.Percentile(99.9) / 1000);
+  perf_db_client_.setConfigs(result.client_config, result.server_config);
+}
+
+void PerfDbReporter::ReportTimes(const ScenarioResult& result) {
+  double server_system_time =
+      100.0 * sum(result.server_resources,
+                  [](ResourceUsage u) { return u.system_time; }) /
+      sum(result.server_resources, [](ResourceUsage u) { return u.wall_time; });
+  double server_user_time =
+      100.0 * sum(result.server_resources,
+                  [](ResourceUsage u) { return u.user_time; }) /
+      sum(result.server_resources, [](ResourceUsage u) { return u.wall_time; });
+  double client_system_time =
+      100.0 * sum(result.client_resources,
+                  [](ResourceUsage u) { return u.system_time; }) /
+      sum(result.client_resources, [](ResourceUsage u) { return u.wall_time; });
+  double client_user_time =
+      100.0 * sum(result.client_resources,
+                  [](ResourceUsage u) { return u.user_time; }) /
+      sum(result.client_resources, [](ResourceUsage u) { return u.wall_time; });
+
+  perf_db_client_.setTimes(server_system_time, server_user_time, client_system_time,
+                         client_user_time);
+  perf_db_client_.setConfigs(result.client_config, result.server_config);
+}
+
+void PerfDbReporter::SendData() {
+  // send data to performance database
+  bool data_state =
+      perf_db_client_.sendData(hashed_id_, test_name_, sys_info_, tag_);
+
+  // check state of data sending
+  if (data_state) {
+    gpr_log(GPR_INFO, "Data sent to performance database successfully");
+  } else {
+    gpr_log(GPR_INFO, "Data could not be sent to performance database");
+  }
+}
+
 }  // namespace testing
 }  // namespace grpc
diff --git a/test/cpp/qps/report.h b/test/cpp/qps/report.h
index b1cf83fc23..aec3cbe80a 100644
--- a/test/cpp/qps/report.h
+++ b/test/cpp/qps/report.h
@@ -41,6 +41,7 @@
 
 #include "test/cpp/qps/driver.h"
 #include "test/cpp/qps/qpstest.grpc.pb.h"
+#include "test/cpp/qps/perf_db_client.h"
 
 namespace grpc {
 namespace testing {
@@ -103,6 +104,35 @@ class GprLogReporter : public Reporter {
   void ReportTimes(const ScenarioResult& result) GRPC_OVERRIDE;
 };
 
+/** Reporter for performance database tool */
+class PerfDbReporter : public Reporter {
+ public:
+  PerfDbReporter(const string& name, const string& hashed_id,
+                 const string& test_name, const string& sys_info,
+                 const string& server_address, const string& tag)
+      : Reporter(name),
+        hashed_id_(hashed_id),
+        test_name_(test_name),
+        sys_info_(sys_info),
+        tag_(tag) {
+    perf_db_client_.init(grpc::CreateChannel(
+        server_address, grpc::InsecureCredentials(), ChannelArguments()));
+  }
+  ~PerfDbReporter() GRPC_OVERRIDE { SendData(); };
+
+ private:
+  PerfDbClient perf_db_client_;
+  std::string hashed_id_;
+  std::string test_name_;
+  std::string sys_info_;
+  std::string tag_;
+  void ReportQPS(const ScenarioResult& result) GRPC_OVERRIDE;
+  void ReportQPSPerCore(const ScenarioResult& result) GRPC_OVERRIDE;
+  void ReportLatency(const ScenarioResult& result) GRPC_OVERRIDE;
+  void ReportTimes(const ScenarioResult& result) GRPC_OVERRIDE;
+  void SendData();
+};
+
 }  // namespace testing
 }  // namespace grpc