google-cloud-trace 0.25.0 → 0.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 537ea43256a80488f659a7b6ed8f41f23f935e13
-  data.tar.gz: 4e0d0e17d29ffac6d6323eaebf2838332f14c072
+  metadata.gz: 3a4e0e04c7f4fe293e6bad7a5624670383578de2
+  data.tar.gz: 59c06ae1afb28e86a65045533de8a3be2f93ec44
 SHA512:
-  metadata.gz: b874bb6c50a4b10f634311b69b45055551061b21f75125823edec6f78c181d87a0efb8ae241eb4e47a3fb7c28f259e2b6dc27c47b047332784a0e758505c7e56
-  data.tar.gz: 451c43e68ad1ca3561306c9f4a30a060ce33838d0fff9a11d303065aa0dd2f985bfe57c2c53115d0ab41230900b380ed79a8026d734deac164f809eb6222eb2b
+  metadata.gz: b79c75d65ba9a052dc70605e1b75110a73be6df69599655f742bcc45dd598b485715d827f4a7c54b709ab1665024c05a0809df548790f2eeb807fed660001a3e
+  data.tar.gz: 6043aee0288c6efd69c48044abeab5445077df1b4b854491009e0530b2495ecb40329d69d7395f83e882cf96bc66ea8f2dda1923d0a3ab05f65a73924aa605c3

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

@@ -0,0 +1,124 @@
+# 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 "stackdriver/core/async_actor"
+
+module Google
+  module Cloud
+    module Trace
+      ##
+      # # AsyncReporter
+      #
+      # @private Used by the {Google::Cloud::Trace::Middleware} to
+      # asynchronously update traces to Stackdriver Trace service when used in
+      # a Rack-based application.
+      class AsyncReporter
+        include Stackdriver::Core::AsyncActor
+
+        ##
+        # @private Default Maximum blacklog size for the job queue
+        DEFAULT_MAX_QUEUE_SIZE = 1000
+
+        ##
+        # The {Google::Cloud::Trace::Service} object to patch traces
+        attr_accessor :service
+
+        ##
+        # The max number of items the queue holds
+        attr_accessor :max_queue_size
+
+        ##
+        # @private Construct a new instance of AsyncReporter
+        def initialize service, max_queue_size = DEFAULT_MAX_QUEUE_SIZE
+          super()
+
+          @service = service
+          @max_queue_size = max_queue_size
+          @queue = []
+          @queue_resource = new_cond
+        end
+
+        ##
+        # Add the traces to the queue to be reported to Stackdriver Trace
+        # asynchronously. Signal the child thread to start processing the queue.
+        def patch_traces traces
+          ensure_thread
+
+          synchronize do
+            @queue.push traces
+            @queue_resource.broadcast
+
+            while @max_queue_size && @queue.size > max_queue_size
+              @queue_resource.wait 1
+
+              @queue.pop while @queue.size > max_queue_size
+            end
+          end
+        end
+
+        ##
+        # @private Callback function for AsyncActor module to process the queue
+        # in a loop
+        def run_backgrounder
+          traces = wait_next_item
+          return if traces.nil?
+
+          begin
+            service.patch_traces traces
+          rescue => e
+            @last_exception = e
+          end
+        end
+
+        ##
+        # @private Callback function when the async actor thread state changes
+        def on_async_state_change
+          synchronize do
+            @queue_resource.broadcast
+          end
+        end
+
+        ##
+        # Get the project id from underlying service object.
+        def project
+          service.project
+        end
+
+        private
+
+        ##
+        # @private Wait for the next item from the reporter queue. If there are
+        # no more items, it blocks the child thread until an item is enqueued.
+        def wait_next_item
+          synchronize do
+            @queue_resource.wait_while do
+              async_suspended? || (async_running? && @queue.empty?)
+            end
+            @queue.pop
+          end
+        end
+
+        ##
+        # @private Override the #backgrounder_stoppable? method from AsyncActor
+        # module. The actor can be gracefully stopped when queue is empty.
+        def backgrounder_stoppable?
+          synchronize do
+            @queue.empty?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# 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 "faraday"
+require "google/cloud/trace"
+
+module Google
+  module Cloud
+    module Trace
+      class FaradayMiddleware < Faraday::Middleware
+        ##
+        # Create a Trace span with the HTTP request/response information.
+        def call env
+          Google::Cloud::Trace.in_span "faraday_request" do |span|
+            add_request_labels span, env if span
+
+            response = @app.call env
+
+            add_response_labels span, env if span
+
+            response
+          end
+        end
+
+        protected
+
+        ##
+        # @private Set Trace span labels from request object
+        def add_request_labels span, env
+          labels = span.labels
+          label_keys = Google::Cloud::Trace::LabelKey
+
+          set_label labels, label_keys::HTTP_METHOD, env.method
+          set_label labels, label_keys::HTTP_URL, env.url.to_s
+
+          # Only sets request size if request is not sent yet.
+          unless env.status
+            request_body = env.body || ""
+            set_label labels, label_keys::RPC_REQUEST_SIZE,
+                      request_body.bytesize.to_s
+          end
+        end
+
+        ##
+        # @private Set Trace span labels from response
+        def add_response_labels span, env
+          labels = span.labels
+          label_keys = Google::Cloud::Trace::LabelKey
+
+          response = env.response
+          response_body = response.body || ""
+          response_status = response.status
+          response_url = response.headers[:location]
+
+          set_label labels, label_keys::RPC_RESPONSE_SIZE,
+                    response_body.bytesize.to_s
+          set_label labels, label_keys::HTTP_STATUS_CODE, response_status.to_s
+
+          if 300 <= response_status && response_status < 400 && response_url
+            set_label labels, label_keys::HTTP_REDIRECTED_URL, response_url
+          end
+        end
+
+        ##
+        # Sets the given label if the given value is a proper string.
+        #
+        # @private
+        # @param [Hash] labels The labels hash.
+        # @param [String] key The key of the label to set.
+        # @param [Object] value The value to set.
+        #
+        def set_label labels, key, value
+          labels[key] = value if value.is_a? ::String
+        end
+      end
+    end
+  end
+end

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

@@ -70,6 +70,9 @@ module Google
         GAE_MEMCACHE_SIZE = "g.co/gae/memcache/size"
         GAE_REQUEST_LOG_ID = "g.co/gae/request_log_id"
 
+        RPC_REQUEST_SIZE = "/rpc/request/size"
+        RPC_RESPONSE_SIZE = "/rpc/response/size"
+
         ##
         # Set the stack trace label in the given labels hash. The current call
         # stack is formatted so the Stackdriver UI will display it.

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

@@ -14,6 +14,7 @@
 
 
 require "google/cloud/env"
+require "google/cloud/trace/async_reporter"
 require "stackdriver/core/trace_context"
 
 module Google
@@ -112,8 +113,8 @@ module Google
         # Create a new Middleware for traces
         #
         # @param [Rack Application] app Rack application
-        # @param [Google::Cloud::Trace::Service] service The service object.
-        #     Optional if running on GCE.
+        # @param [Google::Cloud::Trace::Service, AsyncReporter] service
+        #   The service object to update traces. Optional if running on GCE.
         # @param [Hash] *kwargs Hash of configuration settings. Used for
         #   backward API compatibility. See the [Configuration
         #   Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
@@ -128,8 +129,12 @@ module Google
             @service = service
           else
             project_id = configuration.project_id
+
             if project_id
-              @service = Google::Cloud::Trace.new(project: project_id).service
+              keyfile = configuration.keyfile
+              tracer = Google::Cloud::Trace.new project: project_id,
+                                                keyfile: keyfile
+              @service = Google::Cloud::Trace::AsyncReporter.new tracer.service
             end
           end
         end

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

@@ -98,16 +98,9 @@ module Google
         #
         def self.init_middleware app
           trace_config = Trace.configure
-          project_id = trace_config.project_id
-          keyfile = trace_config.keyfile
 
-          tracer = Google::Cloud::Trace.new project: project_id,
-                                            keyfile: keyfile
-
-          app.middleware.insert_before \
-            Rack::Runtime,
-            Google::Cloud::Trace::Middleware,
-            service: tracer.service
+          app.middleware.insert_before Rack::Runtime,
+                                       Google::Cloud::Trace::Middleware
 
           trace_config.notifications.each do |type|
             Google::Cloud::Trace::Notifications.instrument \

data/lib/google/cloud/trace/v1/trace_service_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-trace
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.1
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: google-gax
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -204,7 +218,9 @@ files:
 - README.md
 - lib/google-cloud-trace.rb
 - lib/google/cloud/trace.rb
+- lib/google/cloud/trace/async_reporter.rb
 - lib/google/cloud/trace/credentials.rb
+- lib/google/cloud/trace/faraday_middleware.rb
 - lib/google/cloud/trace/label_key.rb
 - lib/google/cloud/trace/middleware.rb
 - lib/google/cloud/trace/notifications.rb