google-cloud-trace 0.26.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a4e0e04c7f4fe293e6bad7a5624670383578de2
-  data.tar.gz: 59c06ae1afb28e86a65045533de8a3be2f93ec44
+  metadata.gz: bb2670fad7d9b85c3b7104c80152e12fe04419c0
+  data.tar.gz: 4d09dae2b9e81c947aae3364f0009485fc0886e1
 SHA512:
-  metadata.gz: b79c75d65ba9a052dc70605e1b75110a73be6df69599655f742bcc45dd598b485715d827f4a7c54b709ab1665024c05a0809df548790f2eeb807fed660001a3e
-  data.tar.gz: 6043aee0288c6efd69c48044abeab5445077df1b4b854491009e0530b2495ecb40329d69d7395f83e882cf96bc66ea8f2dda1923d0a3ab05f65a73924aa605c3
+  metadata.gz: 45b1826655a68c86c68aed322ae5f1cc83753f1594479cf3c191b006cac50b0012736aa671088512253d1ef11fd1ec9a428487643deefa5f8508cca591d1851a
+  data.tar.gz: f10668b16724af1a1d67d78afeb6e140c781dc6fa7e1bad6781dfd41d9340713cd65aef1a9dc6e4c6c22e241e641dbaa9edbc988675d123cb064604b31444a0b

data/lib/google/cloud/trace/label_key.rb

@@ -70,8 +70,11 @@ module Google
         GAE_MEMCACHE_SIZE = "g.co/gae/memcache/size"
         GAE_REQUEST_LOG_ID = "g.co/gae/request_log_id"
 
+        RPC_HOST = "/rpc/host"
+        RPC_REQUEST_TYPE = "/rpc/request/type"
         RPC_REQUEST_SIZE = "/rpc/request/size"
         RPC_RESPONSE_SIZE = "/rpc/response/size"
+        RPC_STATUS_CODE = "/rpc/status_code"
 
         ##
         # Set the stack trace label in the given labels hash. The current call

data/lib/google/cloud/trace/patches/active_call_with_trace.rb

@@ -0,0 +1,45 @@
+# Copyright 2017 Google Inc. All rights reserved.
+#
+# 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.
+
+
+require "google/cloud/trace"
+
+module GRPC
+  ##
+  # Stackdriver Trace instrumentation of GRPC by patching GRPC::ActiveCall
+  # class. Intercept each GRPC request and create a Trace span with basic
+  # request information.
+  module ActiveCallWithTrace
+    SPAN_NAME = "gRPC request"
+
+    ##
+    # Override GRPC::ActiveCall#request_response method. Wrap the original
+    # method with a trace span that will get submitted with the overall request
+    # trace span tree.
+    def request_response *args
+      Google::Cloud::Trace.in_span SPAN_NAME do |span|
+        if span && !args.empty?
+          grpc_request = args[0]
+          label_key = Google::Cloud::Trace::LabelKey::RPC_REQUEST_TYPE
+          span.labels[label_key] = grpc_request.class.name.gsub(/^.*::/, "")
+        end
+
+        super
+      end
+    end
+  end
+
+  # Patch GRPC::ActiveCall#request_response method
+  ::GRPC::ActiveCall.send(:prepend, ActiveCallWithTrace)
+end

data/lib/google/cloud/trace/patches/call_with_trace.rb

@@ -0,0 +1,89 @@
+# Copyright 2017 Google Inc. All rights reserved.
+#
+# 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.
+
+
+require "google/cloud/trace"
+
+module GRPC
+  module Core
+    ##
+    # Stackdriver Trace instrumentation of GRPC by patching GRPC::Core::Call
+    # class. Add more RPC information into the trace span created by upstream
+    # patch from GRPC::ActiveCallWithTrace
+    module CallWithTrace
+      ##
+      # @private Add request labels from the Call object and message.
+      def self.add_request_labels call, message, labels
+        label_keys = Google::Cloud::Trace::LabelKey
+
+        message_size = message.to_s.bytesize.to_s
+
+        set_label labels, label_keys::RPC_REQUEST_SIZE, message_size
+        set_label labels, label_keys::RPC_HOST, call.peer.to_s
+      end
+
+      ##
+      # @private Add response labels from gRPC response
+      def self.add_response_labels response, labels
+        label_keys = Google::Cloud::Trace::LabelKey
+
+        response_size = response.message.to_s.bytesize.to_s
+        status = status_code_to_label response.status.code
+
+        set_label labels, label_keys::RPC_RESPONSE_SIZE, response_size
+        set_label labels, label_keys::RPC_STATUS_CODE, status
+      end
+
+      ##
+      # @private Helper method to set label
+      def self.set_label labels, key, value
+        labels[key] = value if value.is_a? ::String
+      end
+
+      ##
+      # @private Reverse lookup from numeric status code to readable string.
+      def self.status_code_to_label code
+        @lookup ||= Hash[GRPC::Core::StatusCodes.constants.map do |c|
+          [GRPC::Core::StatusCodes.const_get(c), c.to_s]
+        end]
+
+        @lookup[code]
+      end
+
+      ##
+      # Override GRPC::Core::Call#run_batch method. Reuse the "gRPC request"
+      # span created in ActiveCallWithTrace patch to add more information from
+      # the request.
+      def run_batch *args
+        span = Google::Cloud::Trace.get
+        # Make sure we're in a "gRPC request" span
+        span = nil if span && span.name != GRPC::ActiveCallWithTrace::SPAN_NAME
+
+        if span && !args.empty?
+          message = args[0]
+          CallWithTrace.add_request_labels self, message, span.labels
+        end
+
+        response = super
+
+        CallWithTrace.add_response_labels response, span.labels if span
+
+        response
+      end
+    end
+
+    # Patch GRPC::Core::Call#run_batch method
+    ::GRPC::Core::Call.send(:prepend, CallWithTrace)
+  end
+end

data/lib/google/cloud/trace/service.rb

@@ -59,13 +59,13 @@ module Google
         end
 
         def channel
-          require "grpc"
+          load_grpc
           GRPC::Core::Channel.new host, nil, chan_creds
         end
 
         def chan_creds
           return credentials if insecure?
-          require "grpc"
+          load_grpc
           GRPC::Core::ChannelCredentials.new.compose \
             GRPC::Core::CallCredentials.new credentials.client.updater_proc
         end
@@ -160,6 +160,12 @@ module Google
           # GaxError wraps BadStatus, but exposes it as #cause
           raise Google::Cloud::Error.from_error(e.cause)
         end
+
+        def load_grpc
+          require "grpc"
+          require "google/cloud/trace/patches/active_call_with_trace"
+          require "google/cloud/trace/patches/call_with_trace"
+        end
       end
     end
   end

data/lib/google/cloud/trace/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Trace
-      VERSION = "0.26.1".freeze
+      VERSION = "0.27.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-trace
 version: !ruby/object:Gem::Version
-  version: 0.26.1
+  version: 0.27.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -224,6 +224,8 @@ files:
 - lib/google/cloud/trace/label_key.rb
 - lib/google/cloud/trace/middleware.rb
 - lib/google/cloud/trace/notifications.rb
+- lib/google/cloud/trace/patches/active_call_with_trace.rb
+- lib/google/cloud/trace/patches/call_with_trace.rb
 - lib/google/cloud/trace/project.rb
 - lib/google/cloud/trace/rails.rb
 - lib/google/cloud/trace/result_set.rb