google-cloud-trace 0.39.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f15f8177b7c46712bfa65de95e962f1d33ee86e7772af0252fa0f992f842095
-  data.tar.gz: d2eef2c11e859c11a73a573a95a10f9b755d230770b9c91f5ed758ddbefdb3b5
+  metadata.gz: b07562091331ce0fc0545ba69eb4dd28c878416fd1db5f3a6f0134b2070b548b
+  data.tar.gz: 2274912890a1bb15293e2121c3ce4e1e694a430919c0290624cf929683522895
 SHA512:
-  metadata.gz: 921009ab5e7b4c391fc663d5f2e9c81c5122b4101d53f13664a89bdae60ac2cf115f684d6fe6950df36ad5d77d688ab74c45adf2c818e0740d5f145ba61269cf
-  data.tar.gz: c4536a16227854be8b0dbb8cc42b3741cbe3e52729bdb27b85e7dc032e224fd03ac95d1d9b6fe0594d61443bea50e3a8a8c3b9319bc18597c3a3e33ec361a42b
+  metadata.gz: 42f181e09853565ae566548c08dfc69f88c727cfbec9b77663c21889d8c6ded86eff582471c31cceba816d47f0ba6f326773408c7ec87671949bf137c1d2f470
+  data.tar.gz: 706749ea6b9625ea23243e16540666d8e4e1855ceb832f45c7dfd7069cde78b9fbab5f76ec9846ed598e7bda3468224172271db7c77fbe95f91501f3f5944fb4

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

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Release History
 
+### 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/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/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/result_set.rb

@@ -158,7 +158,9 @@ module Google
         def next_page
           return nil unless results_pending?
           service.list_traces \
-            project, start_time, end_time,
+            project,
+            start_time,
+            end_time,
             filter: filter,
             order_by: order_by,
             view: view,
@@ -167,26 +169,32 @@ module Google
         end
 
         ##
-        # Create a new ResultSet given a Google::Gax::PagedEnumerable::Page,
+        # Create a new ResultSet given a Gapic::PagedEnumerable::Page,
         # and all the query parameters.
         #
         # @private
         #
-        def self.from_gax_page service, project_id,
-                               page, start_time, end_time,
-                               filter: nil,
-                               order_by: nil,
-                               view: nil,
-                               page_size: nil,
-                               page_token: nil
+        def self.from_gapic_page service,
+                                 project_id,
+                                 page,
+                                 start_time,
+                                 end_time,
+                                 filter: nil,
+                                 order_by: nil,
+                                 view: nil,
+                                 page_size: nil,
+                                 page_token: nil
           next_page_token = page.next_page_token
           next_page_token = nil unless page.next_page_token?
           results = page.map do |proto|
             Google::Cloud::Trace::TraceRecord.from_grpc proto
           end
-          new service, project_id,
-              results, next_page_token,
-              start_time, end_time,
+          new service,
+              project_id,
+              results,
+              next_page_token,
+              start_time,
+              end_time,
               filter: filter,
               order_by: order_by,
               view: view,

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

@@ -16,7 +16,6 @@
 require "google/cloud/errors"
 require "google/cloud/trace/version"
 require "google/cloud/trace/v1"
-require "google/gax/errors"
 require "uri"
 
 module Google
@@ -28,17 +27,18 @@ module Google
       # @private
       #
       class Service
-        attr_accessor :project, :credentials, :timeout, :client_config, :host
+        attr_accessor :project, :credentials, :timeout, :host
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials, timeout: nil, client_config: nil,
+        def initialize project,
+                       credentials,
+                       timeout: nil,
                        host: nil
           @project = project
           @credentials = credentials
           @timeout = timeout
-          @client_config = client_config || {}
-          @host = host || V1::TraceServiceClient::SERVICE_ADDRESS
+          @host = host
         end
 
         def lowlevel_client
@@ -50,15 +50,13 @@ module Google
               require "google/cloud/trace/patches/active_call_with_trace"
               require "google/cloud/trace/patches/call_with_trace"
 
-              V1::TraceServiceClient.new(
-                credentials: credentials,
-                timeout: timeout,
-                client_config: client_config,
-                service_address: service_address,
-                service_port: service_port,
-                lib_name: "gccl",
-                lib_version: Google::Cloud::Trace::VERSION
-              )
+              V1::TraceService::Client.new do |config|
+                config.credentials = credentials if credentials
+                config.timeout = timeout if timeout
+                config.endpoint = host if host
+                config.lib_name = "gccl"
+                config.lib_version = Google::Cloud::Trace::VERSION
+              end
             end
         end
         attr_accessor :mocked_lowlevel_client
@@ -67,55 +65,50 @@ module Google
         # Sends new traces to Stackdriver Trace or updates existing traces.
         def patch_traces traces
           traces = Array(traces)
-          traces_proto = Google::Devtools::Cloudtrace::V1::Traces.new
+          traces_proto = Google::Cloud::Trace::V1::Traces.new
           traces.each do |trace|
             traces_proto.traces.push trace.to_grpc
           end
-          execute do
-            lowlevel_client.patch_traces @project, traces_proto
-          end
+
+          lowlevel_client.patch_traces project_id: @project, traces: traces_proto
           traces
         end
 
         ##
         # Returns a trace given its ID
         def get_trace trace_id
-          trace_proto = execute do
-            lowlevel_client.get_trace @project, trace_id
-          end
+          trace_proto = lowlevel_client.get_trace project_id: @project, trace_id: trace_id
           Google::Cloud::Trace::TraceRecord.from_grpc trace_proto
         end
 
         ##
         # Searches for traces matching the given criteria.
         #
-        def list_traces project_id, start_time, end_time,
+        def list_traces project_id,
+                        start_time,
+                        end_time,
                         filter: nil,
                         order_by: nil,
                         view: nil,
                         page_size: nil,
                         page_token: nil
-          call_opts = if page_token
-                        Google::Gax::CallOptions.new page_token: page_token
-                      else
-                        Google::Gax::CallOptions.new
-                      end
           start_proto = Google::Cloud::Trace::Utils.time_to_grpc start_time
           end_proto = Google::Cloud::Trace::Utils.time_to_grpc end_time
-          paged_enum = execute do
-            lowlevel_client.list_traces project_id,
-                                        view: view,
-                                        page_size: page_size,
-                                        start_time: start_proto,
-                                        end_time: end_proto,
-                                        filter: filter,
-                                        order_by: order_by,
-                                        options: call_opts
-          end
-
-          Google::Cloud::Trace::ResultSet.from_gax_page \
-            self, project_id,
-            paged_enum.page, start_time, end_time,
+          paged_enum = lowlevel_client.list_traces  project_id: project_id,
+                                                    view: view,
+                                                    page_size: page_size,
+                                                    start_time: start_proto,
+                                                    end_time: end_proto,
+                                                    filter: filter,
+                                                    order_by: order_by,
+                                                    page_token: page_token
+
+          Google::Cloud::Trace::ResultSet.from_gapic_page \
+            self,
+            project_id,
+            paged_enum.page,
+            start_time,
+            end_time,
             filter: filter,
             order_by: order_by,
             view: view,
@@ -127,25 +120,6 @@ module Google
         def inspect
           "#{self.class}(#{@project})"
         end
-
-        protected
-
-        def service_address
-          return nil if host.nil?
-          URI.parse("//#{host}").host
-        end
-
-        def service_port
-          return nil if host.nil?
-          URI.parse("//#{host}").port
-        end
-
-        def execute
-          yield
-        rescue Google::Gax::GaxError => e
-          # GaxError wraps BadStatus, but exposes it as #cause
-          raise Google::Cloud::Error.from_error(e.cause)
-        end
       end
     end
   end

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

@@ -140,7 +140,7 @@ module Google
         # Create a new Span object from a TraceSpan protobuf and insert it
         # into the given trace.
         #
-        # @param [Google::Devtools::Cloudtrace::V1::TraceSpan] span_proto The
+        # @param [Google::Cloud::Trace::V1::Tracespan] span_proto The
         #     span protobuf from the V1 gRPC Trace API.
         # @param [Google::Cloud::Trace::TraceRecord] trace The trace object
         #     to contain the span.
@@ -169,13 +169,13 @@ module Google
         #
         # @param [Integer] default_parent_id The parent span ID to use if the
         #     span has no parent in the trace tree. Optional; defaults to 0.
-        # @return [Google::Devtools::Cloudtrace::V1::TraceSpan] The generated
+        # @return [Google::Cloud::Trace::V1::TraceSpan] The generated
         #     protobuf.
         #
         def to_grpc default_parent_id = 0
           start_proto = Google::Cloud::Trace::Utils.time_to_grpc start_time
           end_proto = Google::Cloud::Trace::Utils.time_to_grpc end_time
-          Google::Devtools::Cloudtrace::V1::TraceSpan.new \
+          Google::Cloud::Trace::V1::TraceSpan.new \
             span_id: span_id.to_i,
             kind: kind.to_sym,
             name: name,

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

@@ -76,7 +76,7 @@ module Google
         ##
         # Create a new Trace object from a trace protobuf.
         #
-        # @param [Google::Devtools::Cloudtrace::V1::Trace] trace_proto The
+        # @param [Google::Cloud::Trace::V1::Trace] trace_proto The
         #     trace protobuf from the V1 gRPC Trace API.
         # @return [Trace, nil] A corresponding Trace object, or `nil` if the
         #     proto does not represent an existing trace object.
@@ -104,14 +104,14 @@ module Google
         # Convert this Trace object to an equivalent Trace protobuf suitable
         # for the V1 gRPC Trace API.
         #
-        # @return [Google::Devtools::Cloudtrace::V1::Trace] The generated
+        # @return [Google::Cloud::Trace::V1::Trace] The generated
         #     protobuf.
         #
         def to_grpc
           span_protos = @spans_by_id.values.map do |span|
             span.to_grpc trace_context.span_id.to_i
           end
-          Google::Devtools::Cloudtrace::V1::Trace.new \
+          Google::Cloud::Trace::V1::Trace.new \
             project_id: project_id,
             trace_id: trace_id,
             spans: span_protos