Define canonical gRPC views. (#65)

Author: Ian Sturdy

opencensus/plugins/grpc/BUILD

@@ -30,6 +30,7 @@ cc_library(
         "internal/grpc_plugin.cc",
         "internal/measures.cc",
         "internal/server_filter.cc",
+        "internal/views.cc",
     ],
     hdrs = [
         "grpc_plugin.h",

opencensus/plugins/grpc/grpc_plugin.h

@@ -16,6 +16,7 @@
 #define OPENCENSUS_PLUGINS_GRPC_GRPC_PLUGIN_H_
 
 #include "absl/strings/string_view.h"
+#include "opencensus/stats/stats.h"
 #include "opencensus/trace/span.h"
 
 namespace grpc {
@@ -29,6 +30,12 @@ namespace opencensus {
 // defined below.
 void RegisterGrpcPlugin();
 
+// Registers the cumulative gRPC views so that they will be exported by any
+// registered stats exporter.
+// For on-task stats, construct a View using the ViewDescriptors below.
+// Experimental: These view definitions are subject to change.
+void ExperimentalRegisterGrpcViewsForExport();
+
 // Returns the tracing Span for the current RPC.
 opencensus::trace::Span GetSpanFromServerContext(grpc::ServerContext* context);
 
@@ -58,6 +65,65 @@ extern const absl::string_view kRpcServerFinishedCountMeasureName;
 extern const absl::string_view kRpcServerRequestCountMeasureName;
 extern const absl::string_view kRpcServerResponseCountMeasureName;
 
+// Canonical gRPC view definitions.
+// These view definitions are subject to change.
+const stats::ViewDescriptor& ClientErrorCountCumulative();
+const stats::ViewDescriptor& ClientRequestBytesCumulative();
+const stats::ViewDescriptor& ClientResponseBytesCumulative();
+const stats::ViewDescriptor& ClientRoundtripLatencyCumulative();
+const stats::ViewDescriptor& ClientServerElapsedTimeCumulative();
+const stats::ViewDescriptor& ClientStartedCountCumulative();
+const stats::ViewDescriptor& ClientFinishedCountCumulative();
+const stats::ViewDescriptor& ClientRequestCountCumulative();
+const stats::ViewDescriptor& ClientResponseCountCumulative();
+
+const stats::ViewDescriptor& ServerErrorCountCumulative();
+const stats::ViewDescriptor& ServerRequestBytesCumulative();
+const stats::ViewDescriptor& ServerResponseBytesCumulative();
+const stats::ViewDescriptor& ServerServerElapsedTimeCumulative();
+const stats::ViewDescriptor& ServerStartedCountCumulative();
+const stats::ViewDescriptor& ServerFinishedCountCumulative();
+const stats::ViewDescriptor& ServerRequestCountCumulative();
+const stats::ViewDescriptor& ServerResponseCountCumulative();
+
+const stats::ViewDescriptor& ClientErrorCountMinute();
+const stats::ViewDescriptor& ClientRequestBytesMinute();
+const stats::ViewDescriptor& ClientResponseBytesMinute();
+const stats::ViewDescriptor& ClientRoundtripLatencyMinute();
+const stats::ViewDescriptor& ClientServerElapsedTimeMinute();
+const stats::ViewDescriptor& ClientStartedCountMinute();
+const stats::ViewDescriptor& ClientFinishedCountMinute();
+const stats::ViewDescriptor& ClientRequestCountMinute();
+const stats::ViewDescriptor& ClientResponseCountMinute();
+
+const stats::ViewDescriptor& ServerErrorCountMinute();
+const stats::ViewDescriptor& ServerRequestBytesMinute();
+const stats::ViewDescriptor& ServerResponseBytesMinute();
+const stats::ViewDescriptor& ServerServerElapsedTimeMinute();
+const stats::ViewDescriptor& ServerStartedCountMinute();
+const stats::ViewDescriptor& ServerFinishedCountMinute();
+const stats::ViewDescriptor& ServerRequestCountMinute();
+const stats::ViewDescriptor& ServerResponseCountMinute();
+
+const stats::ViewDescriptor& ClientErrorCountHour();
+const stats::ViewDescriptor& ClientRequestBytesHour();
+const stats::ViewDescriptor& ClientResponseBytesHour();
+const stats::ViewDescriptor& ClientRoundtripLatencyHour();
+const stats::ViewDescriptor& ClientServerElapsedTimeHour();
+const stats::ViewDescriptor& ClientStartedCountHour();
+const stats::ViewDescriptor& ClientFinishedCountHour();
+const stats::ViewDescriptor& ClientRequestCountHour();
+const stats::ViewDescriptor& ClientResponseCountHour();
+
+const stats::ViewDescriptor& ServerErrorCountHour();
+const stats::ViewDescriptor& ServerRequestBytesHour();
+const stats::ViewDescriptor& ServerResponseBytesHour();
+const stats::ViewDescriptor& ServerServerElapsedTimeHour();
+const stats::ViewDescriptor& ServerStartedCountHour();
+const stats::ViewDescriptor& ServerFinishedCountHour();
+const stats::ViewDescriptor& ServerRequestCountHour();
+const stats::ViewDescriptor& ServerResponseCountHour();
+
 }  // namespace opencensus
 
 #endif  // OPENCENSUS_PLUGINS_GRPC_GRPC_PLUGIN_H_