Stackdriver exporters: set user agent on gRPC channel. (#234)

Author: g-easy

opencensus/common/internal/grpc/BUILD

@@ -31,6 +31,17 @@ cc_library(
     ],
 )
 
+cc_library(
+    name = "with_user_agent",
+    srcs = ["with_user_agent.cc"],
+    hdrs = ["with_user_agent.h"],
+    copts = DEFAULT_COPTS,
+    deps = [
+        "//opencensus/common:version",
+        "@com_github_grpc_grpc//:grpc++",
+    ],
+)
+
 # Tests
 # ========================================================================= #
 

opencensus/common/internal/grpc/with_user_agent.cc

@@ -0,0 +1,32 @@
+// Copyright 2018, OpenCensus Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "opencensus/common/internal/grpc/with_user_agent.h"
+
+#include <string>
+
+#include <grpcpp/support/channel_arguments.h>
+#include "opencensus/common/version.h"
+
+namespace opencensus {
+namespace common {
+
+grpc::ChannelArguments WithUserAgent() {
+  grpc::ChannelArguments args;
+  args.SetUserAgentPrefix("opencensus-cpp/" OPENCENSUS_VERSION);
+  return args;
+}
+
+}  // namespace common
+}  // namespace opencensus

opencensus/common/internal/grpc/with_user_agent.h

@@ -0,0 +1,30 @@
+// Copyright 2018, OpenCensus Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef OPENCENSUS_COMMON_INTERNAL_GRPC_WITH_USER_AGENT_H_
+#define OPENCENSUS_COMMON_INTERNAL_GRPC_WITH_USER_AGENT_H_
+
+#include <grpcpp/support/channel_arguments.h>
+
+namespace opencensus {
+namespace common {
+
+// Returns grpc::ChannelArguments to prepend the OpenCensus user agent.
+grpc::ChannelArguments WithUserAgent();
+
+}  // namespace common
+}  // namespace opencensus
+
+#endif  // OPENCENSUS_COMMON_INTERNAL_GRPC_WITH_USER_AGENT_H_

opencensus/exporters/stats/stackdriver/BUILD

@@ -28,6 +28,7 @@ cc_library(
         ":stackdriver_utils",
         "//google/monitoring/v3:metric_service",
         "//opencensus/common/internal/grpc:status",
+        "//opencensus/common/internal/grpc:with_user_agent",
         "//opencensus/stats",
         "@com_github_grpc_grpc//:grpc++",
         "@com_google_absl//absl/base",

opencensus/exporters/stats/stackdriver/internal/stackdriver_exporter.cc

@@ -29,6 +29,7 @@
 #include "google/monitoring/v3/metric_service.grpc.pb.h"
 #include "google/protobuf/empty.pb.h"
 #include "opencensus/common/internal/grpc/status.h"
+#include "opencensus/common/internal/grpc/with_user_agent.h"
 #include "opencensus/exporters/stats/stackdriver/internal/stackdriver_utils.h"
 #include "opencensus/stats/stats.h"
 
@@ -73,8 +74,10 @@ Handler::Handler(const StackdriverOptions& opts)
     : opts_(opts),
       project_id_(absl::StrCat(kProjectIdPrefix, opts.project_id)),
       stub_(google::monitoring::v3::MetricService::NewStub(
-          ::grpc::CreateChannel(kGoogleStackdriverStatsAddress,
-                                ::grpc::GoogleDefaultCredentials()))) {}
+          ::grpc::CreateCustomChannel(kGoogleStackdriverStatsAddress,
+                                      ::grpc::GoogleDefaultCredentials(),
+                                      ::opencensus::common::WithUserAgent()))) {
+}
 
 void Handler::ExportViewData(
     const std::vector<std::pair<opencensus::stats::ViewDescriptor,

opencensus/exporters/trace/stackdriver/BUILD

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-load("//opencensus:copts.bzl", "DEFAULT_COPTS", "TEST_COPTS")
+load("//opencensus:copts.bzl", "DEFAULT_COPTS")
 
 licenses(["notice"])  # Apache License 2.0
 
@@ -31,6 +31,7 @@ cc_library(
         "//google/devtools/cloudtrace/v2:tracing_proto",
         "//opencensus/common:version",
         "//opencensus/common/internal/grpc:status",
+        "//opencensus/common/internal/grpc:with_user_agent",
         "//opencensus/trace",
         "@com_github_grpc_grpc//:grpc++",
         "@com_google_absl//absl/base:core_headers",

opencensus/exporters/trace/stackdriver/internal/stackdriver_exporter.cc

@@ -24,6 +24,7 @@
 #include "absl/time/clock.h"
 #include "google/devtools/cloudtrace/v2/tracing.grpc.pb.h"
 #include "opencensus/common/internal/grpc/status.h"
+#include "opencensus/common/internal/grpc/with_user_agent.h"
 #include "opencensus/common/version.h"
 #include "opencensus/trace/exporter/span_data.h"
 #include "opencensus/trace/exporter/span_exporter.h"
@@ -271,8 +272,9 @@ void Handler::Export(
 
 // static
 void StackdriverExporter::Register(const StackdriverOptions& opts) {
-  auto creds = grpc::GoogleDefaultCredentials();
-  auto channel = ::grpc::CreateChannel(kGoogleStackdriverTraceAddress, creds);
+  auto channel = ::grpc::CreateCustomChannel(
+      kGoogleStackdriverTraceAddress, ::grpc::GoogleDefaultCredentials(),
+      ::opencensus::common::WithUserAgent());
   ::opencensus::trace::exporter::SpanExporter::RegisterHandler(
       absl::make_unique<Handler>(opts, channel));
 }