google-cloud-trace 0.39.0 → 0.41.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f15f8177b7c46712bfa65de95e962f1d33ee86e7772af0252fa0f992f842095
-  data.tar.gz: d2eef2c11e859c11a73a573a95a10f9b755d230770b9c91f5ed758ddbefdb3b5
+  metadata.gz: 1bf4b8064f4be89ea155e7b9cdd564e5084fef1dd5abd41e4c01e70ab8194854
+  data.tar.gz: ea29cb8fd87df1b282e69ace53dd7bc8571de85a56507a3508ffc30ad9d7c813
 SHA512:
-  metadata.gz: 921009ab5e7b4c391fc663d5f2e9c81c5122b4101d53f13664a89bdae60ac2cf115f684d6fe6950df36ad5d77d688ab74c45adf2c818e0740d5f145ba61269cf
-  data.tar.gz: c4536a16227854be8b0dbb8cc42b3741cbe3e52729bdb27b85e7dc032e224fd03ac95d1d9b6fe0594d61443bea50e3a8a8c3b9319bc18597c3a3e33ec361a42b
+  metadata.gz: 407239b9dc8b6ea0ead1910f1d09cd78c0c32d3300cd0389329d3c48a7c47921baf1c636515c1ed975248e58c1cbe6d683608b95be4999693475398b696e4380
+  data.tar.gz: d95c4415b120ce14b91b0c8019049d4b2db6c7a3473d3e3feeeb8cc512941dd5396b14103bdb44c54b243dc889c751b78f2ab7ebba21293f6dc833fbf1421b76

data/AUTHENTICATION.md

@@ -76,7 +76,7 @@ The environment variables that google-cloud-trace checks for project ID are:
 1. `TRACE_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-trace checks for credentials are configured on {Google::Cloud::Trace::V2::Credentials}:
+The environment variables that google-cloud-trace checks for credentials are configured on {Google::Cloud::Trace::Credentials}:
 
 1. `TRACE_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `TRACE_KEYFILE` - Path to JSON file, or JSON contents
@@ -95,7 +95,8 @@ client = Google::Cloud::Trace.new
 
 ### Configuration
 
-The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+The **Project ID** and the path to the **Credentials JSON** file can be configured
+instead of placing them in environment variables or providing them as arguments.
 
 ```ruby
 require "google/cloud/trace"

data/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Release History
 
+### 0.41.3 / 2021-07-08
+
+#### Documentation
+
+* Update AUTHENTICATION.md in handwritten packages
+
+### 0.41.2 / 2021-06-22
+
+#### Bug Fixes
+
+* Error reporting no longer fails due to loading the wrong constant
+* Fixed a crash in the gRPC patch when no span is present in the current trace
+
+### 0.41.1 / 2021-06-17
+
+#### Bug Fixes
+
+* Fixed Ruby 3 keyword argument error in GRPC::ActiveCallWithTrace patch
+
+### 0.41.0 / 2021-03-11
+
+#### Features
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
+
+### 0.40.0 / 2020-07-23
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new gems `google-cloud-trace-v1` and `google-cloud-trace-v2`,
+as dependencies.
+The new dependencies are rewritten low-level clients, produced by a next-
+generation client code generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in low-level clients.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the old `Google::Devtools::Cloudtrace`,
+`Google::Cloud::Trace::V1`, or `Google::Cloud::Trace::V2` modules, please
+review the docs for the new low-level gems to see usage changes. In particular:
+
+* Some classes have been renamed, notably the client class itself.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
 ### 0.39.0 / 2020-07-07
 
 #### Features

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud-trace console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-trace requires Ruby 2.4+. You may choose to
+1. Install Ruby. google-cloud-trace requires Ruby 2.5+. You may choose to
    manage your Ruby and gem installations with [RVM](https://rvm.io/),
    [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).
@@ -45,7 +45,7 @@ there is a small amount of setup:
 
    ```sh
    $ cd google-cloud-trace/
-   $ bundle exec rake bundleupdate
+   $ bundle install
    ```
 
 ## Console
@@ -119,15 +119,14 @@ If you alter an example's title, you may encounter breaking tests.
 ### Trace Acceptance Tests
 
 The Trace acceptance tests interact with the live service API. Follow the
-instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
+instructions in the {file:AUTHENTICATION.md Authentication Guide} for enabling
 the Trace API. Occasionally, some API features may not yet be generally
 available, making it difficult for some contributors to successfully run the
 entire acceptance test suite. However, please ensure that you do successfully
 run acceptance tests for any code areas covered by your pull request.
 
 To run the acceptance tests, first create and configure a project in the Google
-Developers Console, as described in the {file:AUTHENTICATION.md Authentication
-guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
+Developers Console, as described in the {file:AUTHENTICATION.md Authentication Guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
 the KEYFILE location on your system.
 
 Before you can run the Trace acceptance tests, you must first create indexes

data/LOGGING.md

@@ -3,7 +3,7 @@
 To enable logging for this library, set the logger for the underlying
 [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger
 that you set may be a Ruby stdlib
-[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
+[`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
 [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Stackdriver

data/OVERVIEW.md

@@ -157,5 +157,4 @@ trace_client.patch_traces trace
 ## Additional information
 
 Stackdriver Trace can be configured to be used in Rack applications or to use
-gRPC's logging. To learn more, see the {file:INSTRUMENTATION.md Instrumentation
-Guide} and {file:LOGGING.md Logging guide}.
+gRPC's logging. To learn more, see the {file:INSTRUMENTATION.md Instrumentation Guide} and {file:LOGGING.md Logging guide}.

data/lib/google-cloud-trace.rb

@@ -57,10 +57,9 @@ module Google
     #     puts "Retrieved trace ID: #{trace.trace_id}"
     #   end
     #
-    def trace scope: nil, timeout: nil, client_config: nil
+    def trace scope: nil, timeout: nil
       Google::Cloud.trace @project, @keyfile, scope: scope,
-                                              timeout: (timeout || @timeout),
-                                              client_config: client_config
+                                              timeout: (timeout || @timeout)
     end
 
     ##
@@ -99,12 +98,15 @@ module Google
     #     puts "Retrieved trace ID: #{trace.trace_id}"
     #   end
     #
-    def self.trace project_id = nil, credentials = nil, scope: nil,
-                   timeout: nil, client_config: nil
+    def self.trace project_id = nil,
+                   credentials = nil,
+                   scope: nil,
+                   timeout: nil
       require "google/cloud/trace"
-      Google::Cloud::Trace.new project_id: project_id, credentials: credentials,
-                               scope: scope, timeout: timeout,
-                               client_config: client_config
+      Google::Cloud::Trace.new project_id: project_id,
+                               credentials: credentials,
+                               scope: scope,
+                               timeout: timeout
     end
   end
 end
@@ -127,17 +129,23 @@ Google::Cloud.configure.add_config! :trace do |config|
       "TRACE_KEYFILE", "TRACE_KEYFILE_JSON"
     )
   end
+  endpoint = "cloudtrace.googleapis.com".freeze
+  scopes = [
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/trace.append",
+    "https://www.googleapis.com/auth/trace.readonly"
+  ].freeze
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
-  config.add_field! :credentials, default_creds,
+  config.add_field! :credentials,
+                    default_creds,
                     match: [String, Hash, Google::Auth::Credentials],
                     allow_nil: true
   config.add_alias! :keyfile, :credentials
-  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :scope, scopes, match: [String, Array]
   config.add_field! :timeout, nil, match: Integer
-  config.add_field! :client_config, nil, match: Hash
-  config.add_field! :endpoint, nil, match: String
+  config.add_field! :endpoint, endpoint, match: String
   config.add_field! :capture_stack, nil, enum: [true, false]
   config.add_field! :sampler, nil
   config.add_field! :span_id_generator, nil, match: Proc

data/lib/google/cloud/trace.rb

@@ -68,8 +68,6 @@ module Google
       #   * `https://www.googleapis.com/auth/cloud-platform`
       #
       # @param [Integer] timeout Default timeout to use in requests. Optional.
-      # @param [Hash] client_config A hash of values to override the default
-      #   behavior of the API client. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
       # @param [String] project Alias for the `project_id` argument. Deprecated.
@@ -88,12 +86,16 @@ module Google
       #     puts "Retrieved trace ID: #{trace.trace_id}"
       #   end
       #
-      def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
-                   client_config: nil, endpoint: nil, project: nil, keyfile: nil
+      def self.new project_id: nil,
+                   credentials: nil,
+                   scope: nil,
+                   timeout: nil,
+                   endpoint: nil,
+                   project: nil,
+                   keyfile: nil
         project_id    ||= (project || default_project_id)
         scope         ||= configure.scope
         timeout       ||= configure.timeout
-        client_config ||= configure.client_config
         endpoint      ||= configure.endpoint
         credentials   ||= (keyfile || default_credentials(scope: scope))
 
@@ -104,12 +106,8 @@ module Google
         project_id = project_id.to_s # Always cast to a string
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        Trace::Project.new(
-          Trace::Service.new(
-            project_id, credentials,
-            host: endpoint, timeout: timeout, client_config: client_config
-          )
-        )
+        service = Trace::Service.new project_id, credentials, host: endpoint, timeout: timeout
+        Trace::Project.new service
       end
 
       ##
@@ -128,8 +126,6 @@ module Google
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `client_config` - (Hash) A hash of values to override the default
-      #   behavior of the API client.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.
       # * `capture_stack` - (Boolean) Whether to capture stack traces for each
@@ -267,7 +263,8 @@ module Google
       #     end
       #   end
       #
-      def self.in_span name, kind: Google::Cloud::Trace::SpanKind::UNSPECIFIED,
+      def self.in_span name,
+                       kind: Google::Cloud::Trace::SpanKind::UNSPECIFIED,
                        labels: {}
         parent = get
         if parent
@@ -285,4 +282,11 @@ module Google
       end
     end
   end
+
+  # Aliases for compatibility with older spellings.
+  # @private
+  module Devtools
+    # @private
+    Cloudtrace = ::Google::Cloud::Trace unless const_defined? :Cloudtrace
+  end
 end

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

@@ -36,7 +36,7 @@ module Google
 
         ##
         # @private Creates a new AsyncReporter instance.
-        def initialize service, max_count: 1000, max_bytes: 4000000,
+        def initialize service, max_count: 1000, max_bytes: 4_000_000,
                        max_queue: 100, interval: 5, threads: 10
           # init MonitorMixin
           super()
@@ -111,7 +111,7 @@ module Google
             @stopped = true
             patch_batch!
             @cond.broadcast
-            @thread_pool.shutdown if @thread_pool
+            @thread_pool&.shutdown
           end
 
           self
@@ -219,7 +219,7 @@ module Google
                 @cond.wait
               else
                 # still waiting for the interval to publish the batch...
-                @cond.wait(@batch.publish_wait)
+                @cond.wait @batch.publish_wait
               end
             end
           end
@@ -282,7 +282,7 @@ module Google
         def default_error_callbacks
           # This is memoized to reduce calls to the configuration.
           @default_error_callbacks ||= begin
-            error_callback = Google::Cloud::Pubsub.configure.on_error
+            error_callback = Google::Cloud::Trace.configure.on_error
             error_callback ||= Google::Cloud.configure.on_error
             if error_callback
               [error_callback]
@@ -295,7 +295,8 @@ module Google
         ##
         # @private
         class Batch
-          attr_reader :created_at, :traces
+          attr_reader :created_at
+          attr_reader :traces
 
           def initialize reporter
             @reporter = reporter
@@ -337,7 +338,7 @@ module Google
 
           def publish_wait
             publish_wait = publish_at - Time.now
-            return 0 if publish_wait < 0
+            return 0 if publish_wait.negative?
             publish_wait
           end
 

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

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/trace/v1/credentials"
+require "google/cloud/trace/v1/trace_service/credentials"
 
 module Google
   module Cloud
@@ -37,7 +37,7 @@ module Google
       #
       #   trace.project_id #=> "my-project"
       #
-      class Credentials < Google::Cloud::Trace::V1::Credentials
+      class Credentials < Google::Cloud::Trace::V1::TraceService::Credentials
       end
     end
   end

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

@@ -32,7 +32,7 @@ module Google
         attr_reader :traces
 
         def initialize message, traces = nil
-          super(message)
+          super message
           @traces = traces if traces
         end
       end
@@ -50,7 +50,7 @@ module Google
         attr_reader :traces
 
         def initialize message, traces = nil
-          super(message)
+          super message
           @traces = traces if traces
         end
       end

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

@@ -39,10 +39,9 @@ module Google
         #   faraday.adapter  Faraday.default_adapter  # use Net::HTTP adapter
         # end
         # ```
-
-        def initialize app, enable_cross_project_tracing: false
-          super(app)
-          @enable_cross_project_tracing = enable_cross_project_tracing || false
+        def initialize app, opts = {}
+          @enable_cross_project_tracing = opts[:enable_cross_project_tracing] || false
+          super app
         end
 
         ##
@@ -114,9 +113,8 @@ module Google
         ##
         # @private Add X-Cloud-Trace-Context for request header
         def add_trace_context_header env
-          if (trace_ctx = Stackdriver::Core::TraceContext.get)
-            env[:request_headers]["X-Cloud-Trace-Context"] = trace_ctx.to_string
-          end
+          trace_ctx = Stackdriver::Core::TraceContext.get
+          env[:request_headers]["X-Cloud-Trace-Context"] = trace_ctx.to_string if trace_ctx
         end
       end
     end

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

@@ -118,7 +118,7 @@ module Google
           json_frames = []
           collecting_frames = !truncate_stack
           stack_frames.each do |frame|
-            collecting_frames ||= truncate_stack.call(frame)
+            collecting_frames ||= truncate_stack.call frame
             next unless collecting_frames
             next unless !filter_stack || filter_stack.call(frame)
             json_frames <<

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

@@ -154,7 +154,7 @@ module Google
         def initialize app, service: nil, **kwargs
           @app = app
 
-          load_config kwargs
+          load_config(**kwargs)
 
           if service
             @service = service
@@ -203,7 +203,7 @@ module Google
         # @return [Stackdriver::Core::TraceContext] The trace context.
         #
         def get_trace_context env
-          Stackdriver::Core::TraceContext.parse_rack_env(env) do |tc|
+          Stackdriver::Core::TraceContext.parse_rack_env env do |tc|
             if tc.sampled?.nil?
               sampler = configuration.sampler ||
                         Google::Cloud::Trace::TimeSampler.default
@@ -240,12 +240,11 @@ module Google
         # @param [Hash] env The Rack environment.
         #
         def send_trace trace, env
-          if @service && trace.trace_context.sampled?
-            begin
-              @service.patch_traces trace
-            rescue StandardError => ex
-              handle_error ex, logger: env["rack.logger"]
-            end
+          return unless @service && trace.trace_context.sampled?
+          begin
+            @service.patch_traces trace
+          rescue StandardError => e
+            handle_error e, logger: env["rack.logger"]
           end
         end
 

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

@@ -71,7 +71,7 @@ module Google
                             label_namespace: DEFAULT_LABEL_NAMESPACE,
                             capture_stack: false
           require "active_support/notifications"
-          ActiveSupport::Notifications.subscribe(type) do |*args|
+          ActiveSupport::Notifications.subscribe type do |*args|
             event = ActiveSupport::Notifications::Event.new(*args)
             handle_notification_event event, max_length, label_namespace,
                                       capture_stack
@@ -83,19 +83,18 @@ module Google
         def self.handle_notification_event event, maxlen, label_namespace,
                                            capture_stack
           cur_span = Google::Cloud::Trace.get
-          if cur_span && event.time && event.end
-            labels = payload_to_labels event, maxlen, label_namespace
-            if capture_stack
-              Google::Cloud::Trace::LabelKey.set_stack_trace \
-                labels,
-                skip_frames: 2,
-                truncate_stack: REMOVE_NOTIFICATION_FRAMEWORK
-            end
-            cur_span.create_span event.name,
-                                 start_time: event.time,
-                                 end_time: event.end,
-                                 labels: labels
+          return unless cur_span && event.time && event.end
+          labels = payload_to_labels event, maxlen, label_namespace
+          if capture_stack
+            Google::Cloud::Trace::LabelKey.set_stack_trace \
+              labels,
+              skip_frames: 2,
+              truncate_stack: REMOVE_NOTIFICATION_FRAMEWORK
           end
+          cur_span.create_span event.name,
+                               start_time: event.time,
+                               end_time: event.end,
+                               labels: labels
         end
 
         ##
@@ -104,7 +103,7 @@ module Google
           labels = {}
           event.payload.each do |k, v|
             if v.is_a? ::String
-              v = v[0, maxlen - 3] + "..." if maxlen && v.size > maxlen
+              v = "#{v[0, maxlen - 3]}..." if maxlen && v.size > maxlen
               labels["#{label_namespace}#{k}"] = v.to_s
             end
           end