OpenCensus: Move measures, views and CensusContext to include file

include/grpcpp/opencensus.h

@@ -19,7 +19,10 @@
 #ifndef GRPCPP_OPENCENSUS_H
 #define GRPCPP_OPENCENSUS_H
 
+#include "opencensus/stats/view_descriptor.h"
+#include "opencensus/tags/tag_map.h"
 #include "opencensus/trace/span.h"
+#include "opencensus/trace/span_context.h"
 
 namespace grpc {
 class ServerContext;
@@ -42,6 +45,146 @@ void RegisterOpenCensusViewsForExport();
 // Returns the tracing Span for the current RPC.
 ::opencensus::trace::Span GetSpanFromServerContext(ServerContext* context);
 
+namespace experimental {
+
+// The tag keys set when recording RPC stats.
+::opencensus::tags::TagKey ClientMethodTagKey();
+::opencensus::tags::TagKey ClientStatusTagKey();
+::opencensus::tags::TagKey ServerMethodTagKey();
+::opencensus::tags::TagKey ServerStatusTagKey();
+
+// Names of measures used by the plugin--users can create views on these
+// measures but should not record data for them.
+extern const absl::string_view kRpcClientSentMessagesPerRpcMeasureName;
+extern const absl::string_view kRpcClientSentBytesPerRpcMeasureName;
+extern const absl::string_view kRpcClientReceivedMessagesPerRpcMeasureName;
+extern const absl::string_view kRpcClientReceivedBytesPerRpcMeasureName;
+extern const absl::string_view kRpcClientRoundtripLatencyMeasureName;
+extern const absl::string_view kRpcClientServerLatencyMeasureName;
+extern const absl::string_view kRpcClientStartedRpcsMeasureName;
+extern const absl::string_view kRpcClientRetriesPerCallMeasureName;
+extern const absl::string_view kRpcClientTransparentRetriesPerCallMeasureName;
+extern const absl::string_view kRpcClientRetryDelayPerCallMeasureName;
+
+extern const absl::string_view kRpcServerSentMessagesPerRpcMeasureName;
+extern const absl::string_view kRpcServerSentBytesPerRpcMeasureName;
+extern const absl::string_view kRpcServerReceivedMessagesPerRpcMeasureName;
+extern const absl::string_view kRpcServerReceivedBytesPerRpcMeasureName;
+extern const absl::string_view kRpcServerServerLatencyMeasureName;
+extern const absl::string_view kRpcServerStartedRpcsMeasureName;
+
+// Canonical gRPC view definitions.
+const ::opencensus::stats::ViewDescriptor& ClientSentMessagesPerRpcCumulative();
+const ::opencensus::stats::ViewDescriptor& ClientSentBytesPerRpcCumulative();
+const ::opencensus::stats::ViewDescriptor&
+ClientReceivedMessagesPerRpcCumulative();
+const ::opencensus::stats::ViewDescriptor&
+ClientReceivedBytesPerRpcCumulative();
+const ::opencensus::stats::ViewDescriptor& ClientRoundtripLatencyCumulative();
+const ::opencensus::stats::ViewDescriptor& ClientServerLatencyCumulative();
+const ::opencensus::stats::ViewDescriptor& ClientStartedRpcsCumulative();
+const ::opencensus::stats::ViewDescriptor& ClientCompletedRpcsCumulative();
+const ::opencensus::stats::ViewDescriptor& ClientRetriesPerCallCumulative();
+const ::opencensus::stats::ViewDescriptor& ClientRetriesCumulative();
+const ::opencensus::stats::ViewDescriptor&
+ClientTransparentRetriesPerCallCumulative();
+const ::opencensus::stats::ViewDescriptor& ClientTransparentRetriesCumulative();
+const ::opencensus::stats::ViewDescriptor& ClientRetryDelayPerCallCumulative();
+
+const ::opencensus::stats::ViewDescriptor& ServerSentBytesPerRpcCumulative();
+const ::opencensus::stats::ViewDescriptor&
+ServerReceivedBytesPerRpcCumulative();
+const ::opencensus::stats::ViewDescriptor& ServerServerLatencyCumulative();
+const ::opencensus::stats::ViewDescriptor& ServerStartedRpcsCumulative();
+const ::opencensus::stats::ViewDescriptor& ServerCompletedRpcsCumulative();
+const ::opencensus::stats::ViewDescriptor& ServerSentMessagesPerRpcCumulative();
+const ::opencensus::stats::ViewDescriptor&
+ServerReceivedMessagesPerRpcCumulative();
+
+const ::opencensus::stats::ViewDescriptor& ClientSentMessagesPerRpcMinute();
+const ::opencensus::stats::ViewDescriptor& ClientSentBytesPerRpcMinute();
+const ::opencensus::stats::ViewDescriptor& ClientReceivedMessagesPerRpcMinute();
+const ::opencensus::stats::ViewDescriptor& ClientReceivedBytesPerRpcMinute();
+const ::opencensus::stats::ViewDescriptor& ClientRoundtripLatencyMinute();
+const ::opencensus::stats::ViewDescriptor& ClientServerLatencyMinute();
+const ::opencensus::stats::ViewDescriptor& ClientStartedRpcsMinute();
+const ::opencensus::stats::ViewDescriptor& ClientCompletedRpcsMinute();
+const ::opencensus::stats::ViewDescriptor& ClientRetriesPerCallMinute();
+const ::opencensus::stats::ViewDescriptor& ClientRetriesMinute();
+const ::opencensus::stats::ViewDescriptor&
+ClientTransparentRetriesPerCallMinute();
+const ::opencensus::stats::ViewDescriptor& ClientTransparentRetriesMinute();
+const ::opencensus::stats::ViewDescriptor& ClientRetryDelayPerCallMinute();
+
+const ::opencensus::stats::ViewDescriptor& ServerSentMessagesPerRpcMinute();
+const ::opencensus::stats::ViewDescriptor& ServerSentBytesPerRpcMinute();
+const ::opencensus::stats::ViewDescriptor& ServerReceivedMessagesPerRpcMinute();
+const ::opencensus::stats::ViewDescriptor& ServerReceivedBytesPerRpcMinute();
+const ::opencensus::stats::ViewDescriptor& ServerServerLatencyMinute();
+const ::opencensus::stats::ViewDescriptor& ServerStartedRpcsMinute();
+const ::opencensus::stats::ViewDescriptor& ServerCompletedRpcsMinute();
+
+const ::opencensus::stats::ViewDescriptor& ClientSentMessagesPerRpcHour();
+const ::opencensus::stats::ViewDescriptor& ClientSentBytesPerRpcHour();
+const ::opencensus::stats::ViewDescriptor& ClientReceivedMessagesPerRpcHour();
+const ::opencensus::stats::ViewDescriptor& ClientReceivedBytesPerRpcHour();
+const ::opencensus::stats::ViewDescriptor& ClientRoundtripLatencyHour();
+const ::opencensus::stats::ViewDescriptor& ClientServerLatencyHour();
+const ::opencensus::stats::ViewDescriptor& ClientStartedRpcsHour();
+const ::opencensus::stats::ViewDescriptor& ClientCompletedRpcsHour();
+const ::opencensus::stats::ViewDescriptor& ClientRetriesPerCallHour();
+const ::opencensus::stats::ViewDescriptor& ClientRetriesHour();
+const ::opencensus::stats::ViewDescriptor&
+ClientTransparentRetriesPerCallHour();
+const ::opencensus::stats::ViewDescriptor& ClientTransparentRetriesHour();
+const ::opencensus::stats::ViewDescriptor& ClientRetryDelayPerCallHour();
+
+const ::opencensus::stats::ViewDescriptor& ServerSentMessagesPerRpcHour();
+const ::opencensus::stats::ViewDescriptor& ServerSentBytesPerRpcHour();
+const ::opencensus::stats::ViewDescriptor& ServerReceivedMessagesPerRpcHour();
+const ::opencensus::stats::ViewDescriptor& ServerReceivedBytesPerRpcHour();
+const ::opencensus::stats::ViewDescriptor& ServerServerLatencyHour();
+const ::opencensus::stats::ViewDescriptor& ServerStartedRpcsHour();
+const ::opencensus::stats::ViewDescriptor& ServerCompletedRpcsHour();
+
+// Thread compatible.
+class CensusContext {
+ public:
+  CensusContext() : span_(::opencensus::trace::Span::BlankSpan()), tags_({}) {}
+
+  explicit CensusContext(absl::string_view name,
+                         const ::opencensus::tags::TagMap& tags)
+      : span_(::opencensus::trace::Span::StartSpan(name)), tags_(tags) {}
+
+  CensusContext(absl::string_view name, const ::opencensus::trace::Span* parent,
+                const ::opencensus::tags::TagMap& tags)
+      : span_(::opencensus::trace::Span::StartSpan(name, parent)),
+        tags_(tags) {}
+
+  CensusContext(absl::string_view name,
+                const ::opencensus::trace::SpanContext& parent_ctxt)
+      : span_(::opencensus::trace::Span::StartSpanWithRemoteParent(
+            name, parent_ctxt)),
+        tags_({}) {}
+
+  void AddSpanAttribute(absl::string_view key,
+                        opencensus::trace::AttributeValueRef attribute) {
+    span_.AddAttribute(key, attribute);
+  }
+
+  const ::opencensus::trace::Span& Span() const { return span_; }
+  const ::opencensus::tags::TagMap& tags() const { return tags_; }
+
+  ::opencensus::trace::SpanContext Context() const { return Span().context(); }
+  void EndSpan() { Span().End(); }
+
+ private:
+  ::opencensus::trace::Span span_;
+  ::opencensus::tags::TagMap tags_;
+};
+
+}  // namespace experimental
+
 }  // namespace grpc
 
 #endif  // GRPCPP_OPENCENSUS_H

src/cpp/ext/filters/census/client_filter.cc

@@ -44,6 +44,7 @@
 #include <grpc/impl/codegen/gpr_types.h>
 #include <grpc/slice.h>
 #include <grpc/support/log.h>
+#include <grpcpp/opencensus.h>
 #include <grpcpp/support/config.h>
 
 #include "src/core/lib/channel/channel_args.h"

src/cpp/ext/filters/census/context.cc

@@ -23,6 +23,7 @@
 #include <new>
 
 #include "opencensus/tags/context_util.h"
+#include "opencensus/tags/tag_map.h"
 #include "opencensus/trace/context_util.h"
 #include "opencensus/trace/propagation/grpc_trace_bin.h"
 

src/cpp/ext/filters/census/context.h

@@ -26,55 +26,20 @@
 
 #include "absl/strings/string_view.h"
 #include "absl/strings/strip.h"
-#include "opencensus/tags/tag_map.h"
-#include "opencensus/trace/attribute_value_ref.h"
 #include "opencensus/trace/span.h"
 #include "opencensus/trace/span_context.h"
 
 #include <grpc/grpc.h>
 #include <grpc/slice.h>
 #include <grpc/status.h>
+#include <grpcpp/opencensus.h>
 
 #include "src/core/lib/channel/channel_stack.h"
 #include "src/core/lib/slice/slice.h"
 
 namespace grpc {
 
-// Thread compatible.
-class CensusContext {
- public:
-  CensusContext() : span_(::opencensus::trace::Span::BlankSpan()), tags_({}) {}
-
-  explicit CensusContext(absl::string_view name,
-                         const ::opencensus::tags::TagMap& tags)
-      : span_(::opencensus::trace::Span::StartSpan(name)), tags_(tags) {}
-
-  CensusContext(absl::string_view name, const ::opencensus::trace::Span* parent,
-                const ::opencensus::tags::TagMap& tags)
-      : span_(::opencensus::trace::Span::StartSpan(name, parent)),
-        tags_(tags) {}
-
-  CensusContext(absl::string_view name,
-                const ::opencensus::trace::SpanContext& parent_ctxt)
-      : span_(::opencensus::trace::Span::StartSpanWithRemoteParent(
-            name, parent_ctxt)),
-        tags_({}) {}
-
-  void AddSpanAttribute(absl::string_view key,
-                        opencensus::trace::AttributeValueRef attribute) {
-    span_.AddAttribute(key, attribute);
-  }
-
-  const ::opencensus::trace::Span& Span() const { return span_; }
-  const ::opencensus::tags::TagMap& tags() const { return tags_; }
-
-  ::opencensus::trace::SpanContext Context() const { return Span().context(); }
-  void EndSpan() { Span().End(); }
-
- private:
-  ::opencensus::trace::Span span_;
-  ::opencensus::tags::TagMap tags_;
-};
+using experimental::CensusContext;
 
 // Serializes the outgoing trace context. tracing_buf must be
 // opencensus::trace::propagation::kGrpcTraceBinHeaderLen bytes long.

src/cpp/ext/filters/census/grpc_plugin.cc

@@ -25,6 +25,7 @@
 #include <atomic>
 
 #include "absl/base/attributes.h"
+#include "absl/strings/string_view.h"
 #include "opencensus/tags/tag_key.h"
 #include "opencensus/trace/span.h"
 
@@ -35,7 +36,6 @@
 #include "src/cpp/common/channel_filter.h"
 #include "src/cpp/ext/filters/census/channel_filter.h"
 #include "src/cpp/ext/filters/census/client_filter.h"
-#include "src/cpp/ext/filters/census/context.h"
 #include "src/cpp/ext/filters/census/measures.h"
 #include "src/cpp/ext/filters/census/server_filter.h"
 
@@ -75,93 +75,103 @@ ::opencensus::trace::Span GetSpanFromServerContext(
     grpc::ServerContext* context) {
   if (context == nullptr) return opencensus::trace::Span::BlankSpan();
 
-  return reinterpret_cast<const grpc::CensusContext*>(context->census_context())
+  return reinterpret_cast<const grpc::experimental::CensusContext*>(
+             context->census_context())
       ->Span();
 }
 
 // These measure definitions should be kept in sync across opencensus
 // implementations--see
 // https://github.com/census-instrumentation/opencensus-java/blob/master/contrib/grpc_metrics/src/main/java/io/opencensus/contrib/grpc/metrics/RpcMeasureConstants.java.
-::opencensus::tags::TagKey ClientMethodTagKey() {
+::opencensus::tags::TagKey experimental::ClientMethodTagKey() {
   static const auto method_tag_key =
       ::opencensus::tags::TagKey::Register("grpc_client_method");
   return method_tag_key;
 }
 
-::opencensus::tags::TagKey ClientStatusTagKey() {
+::opencensus::tags::TagKey experimental::ClientStatusTagKey() {
   static const auto status_tag_key =
       ::opencensus::tags::TagKey::Register("grpc_client_status");
   return status_tag_key;
 }
 
-::opencensus::tags::TagKey ServerMethodTagKey() {
+::opencensus::tags::TagKey experimental::ServerMethodTagKey() {
   static const auto method_tag_key =
       ::opencensus::tags::TagKey::Register("grpc_server_method");
   return method_tag_key;
 }
 
-::opencensus::tags::TagKey ServerStatusTagKey() {
+::opencensus::tags::TagKey experimental::ServerStatusTagKey() {
   static const auto status_tag_key =
       ::opencensus::tags::TagKey::Register("grpc_server_status");
   return status_tag_key;
 }
 
 // Client
 ABSL_CONST_INIT const absl::string_view
-    kRpcClientSentMessagesPerRpcMeasureName =
+    experimental::kRpcClientSentMessagesPerRpcMeasureName =
         "grpc.io/client/sent_messages_per_rpc";
 
-ABSL_CONST_INIT const absl::string_view kRpcClientSentBytesPerRpcMeasureName =
-    "grpc.io/client/sent_bytes_per_rpc";
+ABSL_CONST_INIT const absl::string_view
+    experimental::kRpcClientSentBytesPerRpcMeasureName =
+        "grpc.io/client/sent_bytes_per_rpc";
 
 ABSL_CONST_INIT const absl::string_view
-    kRpcClientReceivedMessagesPerRpcMeasureName =
+    experimental::kRpcClientReceivedMessagesPerRpcMeasureName =
         "grpc.io/client/received_messages_per_rpc";
 
 ABSL_CONST_INIT const absl::string_view
-    kRpcClientReceivedBytesPerRpcMeasureName =
+    experimental::kRpcClientReceivedBytesPerRpcMeasureName =
         "grpc.io/client/received_bytes_per_rpc";
 
-ABSL_CONST_INIT const absl::string_view kRpcClientRoundtripLatencyMeasureName =
-    "grpc.io/client/roundtrip_latency";
+ABSL_CONST_INIT const absl::string_view
+    experimental::kRpcClientRoundtripLatencyMeasureName =
+        "grpc.io/client/roundtrip_latency";
 
-ABSL_CONST_INIT const absl::string_view kRpcClientServerLatencyMeasureName =
-    "grpc.io/client/server_latency";
+ABSL_CONST_INIT const absl::string_view
+    experimental::kRpcClientServerLatencyMeasureName =
+        "grpc.io/client/server_latency";
 
-ABSL_CONST_INIT const absl::string_view kRpcClientStartedRpcsMeasureName =
-    "grpc.io/client/started_rpcs";
+ABSL_CONST_INIT const absl::string_view
+    experimental::kRpcClientStartedRpcsMeasureName =
+        "grpc.io/client/started_rpcs";
 
-ABSL_CONST_INIT const absl::string_view kRpcClientRetriesPerCallMeasureName =
-    "grpc.io/client/retries_per_call";
+ABSL_CONST_INIT const absl::string_view
+    experimental::kRpcClientRetriesPerCallMeasureName =
+        "grpc.io/client/retries_per_call";
 
 ABSL_CONST_INIT const absl::string_view
-    kRpcClientTransparentRetriesPerCallMeasureName =
+    experimental::kRpcClientTransparentRetriesPerCallMeasureName =
         "grpc.io/client/transparent_retries_per_call";
 
-ABSL_CONST_INIT const absl::string_view kRpcClientRetryDelayPerCallMeasureName =
-    "grpc.io/client/retry_delay_per_call";
+ABSL_CONST_INIT const absl::string_view
+    experimental::kRpcClientRetryDelayPerCallMeasureName =
+        "grpc.io/client/retry_delay_per_call";
 
 // Server
 ABSL_CONST_INIT const absl::string_view
-    kRpcServerSentMessagesPerRpcMeasureName =
+    experimental::kRpcServerSentMessagesPerRpcMeasureName =
         "grpc.io/server/sent_messages_per_rpc";
 
-ABSL_CONST_INIT const absl::string_view kRpcServerSentBytesPerRpcMeasureName =
-    "grpc.io/server/sent_bytes_per_rpc";
+ABSL_CONST_INIT const absl::string_view
+    experimental::kRpcServerSentBytesPerRpcMeasureName =
+        "grpc.io/server/sent_bytes_per_rpc";
 
 ABSL_CONST_INIT const absl::string_view
-    kRpcServerReceivedMessagesPerRpcMeasureName =
+    experimental::kRpcServerReceivedMessagesPerRpcMeasureName =
         "grpc.io/server/received_messages_per_rpc";
 
 ABSL_CONST_INIT const absl::string_view
-    kRpcServerReceivedBytesPerRpcMeasureName =
+    experimental::kRpcServerReceivedBytesPerRpcMeasureName =
         "grpc.io/server/received_bytes_per_rpc";
 
-ABSL_CONST_INIT const absl::string_view kRpcServerServerLatencyMeasureName =
-    "grpc.io/server/server_latency";
+ABSL_CONST_INIT const absl::string_view
+    experimental::kRpcServerServerLatencyMeasureName =
+        "grpc.io/server/server_latency";
 
-ABSL_CONST_INIT const absl::string_view kRpcServerStartedRpcsMeasureName =
-    "grpc.io/server/started_rpcs";
+ABSL_CONST_INIT const absl::string_view
+    experimental::kRpcServerStartedRpcsMeasureName =
+        "grpc.io/server/started_rpcs";
 
 std::atomic<bool> g_open_census_stats_enabled(true);
 std::atomic<bool> g_open_census_tracing_enabled(true);