google-cloud-trace 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d574f63df936d1b723a90b85edd1b3d47bdf9277551a3381805dc81948f307bd
-  data.tar.gz: 2c74ee01e1ea547d8c571af74a012c89007843c8f63677ecf0a65c582006db14
+  metadata.gz: e966113a0dd811127a2df67d641bcc1308a0232ed590f6f921601b955ce2fe3f
+  data.tar.gz: 288a292aae2e0938ae288f33409013c3f4b004f65861eacabe8ca0f95714ebce
 SHA512:
-  metadata.gz: 25ee616dfaba762ca236c4501c1e385ae498f6d85f177c18eab8b6508c64d710d877a885a49565d537c561c79b5dd788cb059c43ca574d91800f3da6b458b7af
-  data.tar.gz: 12339946132e7d8bc218ff64ab1cb191ea3a9dc3a93e25e4e03b42713d42df763aa2809051c52ab8adb181075d0913903d1d849e9bfb47ff9fc58ee4b0214426
+  metadata.gz: 7dd26958194e2388e6952503f9b77ef0c22e5babad557da194aa3a27b6d2579ae319f42bc1ef3a330ea511635e929b4b2e934bf5feafd917174fa922e961b1e9
+  data.tar.gz: e7091c7efe42d1cd5ea8c42a8dad29a4071ab6f36a135939e24d760cf22faf2efaac7b7b2c872f8b11f221583826fe32865ef09d5a330b806b4fceaad21cd0d3

data/README.md

@@ -1,11 +1,11 @@
 # google-cloud-trace
 
-[Stackdriver Trace](https://cloud.google.com/trace/) is a distributed tracing 
-system that collects latency data from your applications and displays it in the 
+[Stackdriver Trace](https://cloud.google.com/trace/) is a distributed tracing
+system that collects latency data from your applications and displays it in the
 Google Cloud Platform Console. You can track how requests propagate through your
-application and receive detailed near real-time performance insights. 
-Stackdriver Trace automatically analyzes all of your application's traces to 
-generate in-depth latency reports to surface performance degradations, and can 
+application and receive detailed near real-time performance insights.
+Stackdriver Trace automatically analyzes all of your application's traces to
+generate in-depth latency reports to surface performance degradations, and can
 capture traces from all of your VMs, containers, or Google App Engine projects.
 
 - [google-cloud-trace API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-trace/latest)
@@ -35,26 +35,26 @@ gem "google-cloud-trace"
 $ bundle install
 ```
 
-Alternatively, check out the [`stackdriver`](../stackdriver) gem that includes 
+Alternatively, check out the [`stackdriver`](../stackdriver) gem that includes
 the `google-cloud-trace` gem.
 
 ## Enable Stackdriver Trace API
 
-The Stackdriver Trace library needs the [Stackdriver Trace 
-API](https://console.cloud.google.com/apis/library/cloudtrace.googleapis.com) 
-to be enabled on your Google Cloud project. Make sure it's enabled if not 
+The Stackdriver Trace library needs the [Stackdriver Trace
+API](https://console.cloud.google.com/apis/library/cloudtrace.googleapis.com)
+to be enabled on your Google Cloud project. Make sure it's enabled if not
 already.
 
 ## Tracing on Rack-based frameworks
 
-The Stackdriver Trace library for Ruby makes it easy to integrate Stackdriver 
-Trace into popular Rack-based Ruby web frameworks such as Ruby on Rails and 
-Sinatra. When the library integration is enabled, it automatically traces 
+The Stackdriver Trace library for Ruby makes it easy to integrate Stackdriver
+Trace into popular Rack-based Ruby web frameworks such as Ruby on Rails and
+Sinatra. When the library integration is enabled, it automatically traces
 incoming requests in the application.
 
 ### With Ruby on Rails
 
-You can load the Railtie that comes with the library into your Ruby 
+You can load the Railtie that comes with the library into your Ruby
 on Rails application by explicitly requiring it during the application startup:
 
 ```ruby
@@ -62,12 +62,12 @@ on Rails application by explicitly requiring it during the application startup:
 require "google/cloud/trace/rails"
 ```
 
-If you're using the `stackdriver` gem, it automatically loads the Railtie into 
+If you're using the `stackdriver` gem, it automatically loads the Railtie into
 your application when it starts.
 
 ### With other Rack-based frameworks
 
-Other Rack-based frameworks, such as Sinatra, can use the Rack Middleware 
+Other Rack-based frameworks, such as Sinatra, can use the Rack Middleware
 provided by the library:
 
 ```ruby
@@ -78,7 +78,7 @@ use Google::Cloud::Trace::Middleware
 ### Adding Custom Trace Spans
 
 The Stackdriver Trace Rack Middleware automatically creates a trace record for
-incoming requests. You can add additional custom trace spans within each 
+incoming requests. You can add additional custom trace spans within each
 request:
 
 ```ruby
@@ -93,26 +93,26 @@ end
 
 ### Configuring the library
 
-You can customize the behavior of the Stackdriver Trace library for Ruby. See 
-the [configuration guide](../stackdriver/configuration.md) for a list of 
+You can customize the behavior of the Stackdriver Trace library for Ruby. See
+the [configuration guide](../stackdriver/configuration.md) for a list of
 possible configuration options.
 
 ## Running on Google Cloud Platform
 
-The Stackdriver Trace library for Ruby should work without you manually 
-providing authentication credentials for instances running on Google Cloud 
-Platform, as long as the Stackdriver Trace API access scope is enabled on that 
+The Stackdriver Trace library for Ruby should work without you manually
+providing authentication credentials for instances running on Google Cloud
+Platform, as long as the Stackdriver Trace API access scope is enabled on that
 instance.
 
 ### App Engine
 
-On Google App Engine, the Stackdriver Trace API access scope is enabled by 
-default, and the Stackdriver Trace library for Ruby can be used without 
+On Google App Engine, the Stackdriver Trace API access scope is enabled by
+default, and the Stackdriver Trace library for Ruby can be used without
 providing credentials or a project ID
 
 ### Container Engine
 
-On Google Container Engine, you must explicitly add the `trace.append` OAuth 
+On Google Container Engine, you must explicitly add the `trace.append` OAuth
 scope when creating the cluster:
 
 ```sh
@@ -121,32 +121,32 @@ $ gcloud container clusters create example-cluster-name --scopes https://www.goo
 
 ### Compute Engine
 
-For Google Compute Engine instances, you need to explicitly enable the 
-`trace.append` Stackdriver Trace API access scope for each instance. When 
-creating a new instance through the Google Cloud Platform Console, you can do 
-this under Identity and API access: Use the Compute Engine default service 
+For Google Compute Engine instances, you need to explicitly enable the
+`trace.append` Stackdriver Trace API access scope for each instance. When
+creating a new instance through the Google Cloud Platform Console, you can do
+this under Identity and API access: Use the Compute Engine default service
 account and select "Allow full access to all Cloud APIs" under Access scopes.
 
-To use something other than the Compute Engine default service account see the 
-docs for Creating and Enabling Service Accounts for Instances and the Running 
+To use something other than the Compute Engine default service account see the
+docs for Creating and Enabling Service Accounts for Instances and the Running
 elsewhere section below. The important thing is that the service account you use
 has the Cloud Trace Agent role.
 
 ## Running locally and elsewhere
 
-To run the Stackdriver Trace outside of Google Cloud Platform, you must supply 
+To run the Stackdriver Trace outside of Google Cloud Platform, you must supply
 your GCP project ID and appropriate service account credentials directly to the
-Stackdriver Trace. This applies to running the library on your own workstation, 
-on your datacenter's computers, or on the VM instances of another cloud 
-provider. See the [Authentication section](#authentication) for instructions on 
+Stackdriver Trace. This applies to running the library on your own workstation,
+on your datacenter's computers, or on the VM instances of another cloud
+provider. See the [Authentication section](#authentication) for instructions on
 how to do so.
 
 ## Authentication
 
-The Instrumentation client and API use Service Account credentials to connect 
-to Google Cloud services. When running on Google Cloud Platform environments, 
-the credentials will be discovered automatically. When running on other 
-environments the Service Account credentials can be specified by providing in 
+The Instrumentation client and API use Service Account credentials to connect
+to Google Cloud services. When running on Google Cloud Platform environments,
+the credentials will be discovered automatically. When running on other
+environments the Service Account credentials can be specified by providing in
 several ways.
 
 The best way to provide authentication information if you're using Ruby on Rails
@@ -166,7 +166,7 @@ end
 
 Other Rack-based applications that are loading the Rack Middleware directly can use
 the configration interface:
- 
+
 ```ruby
 require "google/cloud/trace"
 Google::Cloud.configure do |config|
@@ -179,8 +179,8 @@ Google::Cloud.configure do |config|
 end
 ```
 
-This library also supports the other authentication methods provided by the 
-`google-cloud-ruby` suite. Instructions and configuration options are covered 
+This library also supports the other authentication methods provided by the
+`google-cloud-ruby` suite. Instructions and configuration options are covered
 in the [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-trace/guides/authentication).
 
 ## Supported Ruby Versions
@@ -191,19 +191,19 @@ This library is supported on Ruby 2.0+.
 
 This library follows [Semantic Versioning](http://semver.org/).
 
-It is currently in major version zero (0.y.z), which means that anything may 
+It is currently in major version zero (0.y.z), which means that anything may
 change at any time and the public API should not be considered stable.
 
 ## Contributing
 
 Contributions to this library are always welcome and highly encouraged.
 
-See the 
-[Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing) 
+See the
+[Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing)
 for more information on how to get started.
 
 Please note that this project is released with a Contributor Code of Conduct. By
-participating in this project you agree to abide by its terms. See 
+participating in this project you agree to abide by its terms. See
 [Code of Conduct](../CODE_OF_CONDUCT.md) for more information.
 
 ## License
@@ -213,8 +213,8 @@ This library is licensed under Apache 2.0. Full license text is available in
 
 ## Support
 
-Please 
+Please
 [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues).
-Don't hesitate to 
-[ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby) 
+Don't hesitate to
+[ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby)
 about the client or APIs on [StackOverflow](http://stackoverflow.com).

data/lib/google-cloud-trace.rb

@@ -20,6 +20,8 @@
 
 gem "google-cloud-core"
 require "google/cloud"
+require "google/cloud/config"
+require "googleauth"
 
 module Google
   module Cloud
@@ -34,7 +36,11 @@ module Google
     #   set of resources and operations that the connection can access. See
     #   [Using OAuth 2.0 to Access Google
     #   APIs](https://developers.google.com/identity/protocols/OAuth2).
-    #   The default scope is `https://www.googleapis.com/auth/cloud-platform`
+    #
+    #   The default scope is:
+    #
+    #   * `https://www.googleapis.com/auth/cloud-platform`
+    #
     # @param [Integer] timeout Default timeout to use in requests. Optional.
     #
     # @return [Google::Cloud::Trace::Project]
@@ -73,7 +79,11 @@ module Google
     #   set of resources and operations that the connection can access. See
     #   [Using OAuth 2.0 to Access Google
     #   APIs](https://developers.google.com/identity/protocols/OAuth2).
-    #   The default scope is `https://www.googleapis.com/auth/cloud-platform`
+    #
+    #   The default scope is:
+    #
+    #   * `https://www.googleapis.com/auth/cloud-platform`
+    #
     # @param [Integer] timeout Default timeout to use in requests. Optional.
     #
     # @return [Google::Cloud::Trace::Project]
@@ -97,3 +107,38 @@ module Google
     end
   end
 end
+
+# Add trace to top-level configuration
+Google::Cloud.configure do |config|
+  unless config.field? :use_trace
+    config.add_field! :use_trace, nil, enum: [true, false]
+  end
+end
+
+# Set the default trace configuration
+Google::Cloud.configure.add_config! :trace do |config|
+  default_project = Google::Cloud::Config.deferred do
+    ENV["TRACE_PROJECT"]
+  end
+  default_creds = Google::Cloud::Config.deferred do
+    Google::Cloud::Config.credentials_from_env(
+      "TRACE_CREDENTIALS", "TRACE_CREDENTIALS_JSON",
+      "TRACE_KEYFILE", "TRACE_KEYFILE_JSON"
+    )
+  end
+
+  config.add_field! :project_id, default_project, match: String, allow_nil: true
+  config.add_alias! :project, :project_id
+  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! :timeout, nil, match: Integer
+  config.add_field! :client_config, nil, match: Hash
+  config.add_field! :capture_stack, nil, enum: [true, false]
+  config.add_field! :sampler, nil
+  config.add_field! :span_id_generator, nil, match: Proc
+  config.add_field! :notifications, nil, match: Array
+  config.add_field! :max_data_length, nil, match: Integer
+end

data/lib/google/cloud/trace.rb

@@ -27,6 +27,8 @@ require "google/cloud/trace/span_kind"
 require "google/cloud/trace/time_sampler"
 require "google/cloud/trace/trace_record"
 require "google/cloud/trace/utils"
+require "google/cloud/config"
+require "google/cloud/env"
 require "stackdriver/core"
 
 module Google
@@ -191,12 +193,6 @@ module Google
     module Trace
       THREAD_KEY = :__stackdriver_trace_span__
 
-      # Initialize :error_reporting as a nested Configuration under
-      # Google::Cloud if haven't already
-      unless Google::Cloud.configure.option? :trace
-        Google::Cloud.configure.add_options :trace
-      end
-
       ##
       # Creates a new object for connecting to the Stackdriver Trace service.
       # Each call creates a new connection.
@@ -215,7 +211,11 @@ module Google
       #   the set of resources and operations that the connection can access.
       #   See [Using OAuth 2.0 to Access Google
       #   APIs](https://developers.google.com/identity/protocols/OAuth2).
-      #   The default scope is `https://www.googleapis.com/auth/cloud-platform`
+      #
+      #   The default scope is:
+      #
+      #   * `https://www.googleapis.com/auth/cloud-platform`
+      #
       # @param [Integer] timeout Default timeout to use in requests. Optional.
       # @param [String] project Alias for the `project_id` argument. Deprecated.
       # @param [String] keyfile Alias for the `credentials` argument.
@@ -235,11 +235,15 @@ module Google
       #
       def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
                    client_config: nil, project: nil, keyfile: nil
-        project_id ||= (project || Trace::Project.default_project_id)
+        project_id ||= (project || default_project_id)
         project_id = project_id.to_s # Always cast to a string
-        fail ArgumentError, "project_id is missing" if project_id.empty?
+        raise ArgumentError, "project_id is missing" if project_id.empty?
+
+        scope ||= configure.scope
+        timeout ||= configure.timeout
+        client_config ||= configure.client_config
 
-        credentials ||= (keyfile || Trace::Credentials.default(scope: scope))
+        credentials ||= (keyfile || default_credentials(scope: scope))
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Trace::Credentials.new credentials, scope: scope
         end
@@ -247,7 +251,70 @@ module Google
         Trace::Project.new(
           Trace::Service.new(
             project_id, credentials, timeout: timeout,
-                                     client_config: client_config))
+                                     client_config: client_config
+          )
+        )
+      end
+
+      ##
+      # Configure the Stackdriver Trace instrumentation Middleware.
+      #
+      # The following Stackdriver Trace configuration parameters are
+      # supported:
+      #
+      # * `project_id` - (String) Project identifier for the Stackdriver
+      #   Trace service you are connecting to. (The parameter `project` is
+      #   considered deprecated, but may also be used.)
+      # * `credentials` - (String, Hash, Google::Auth::Credentials) The path to
+      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
+      #   Google::Auth::Credentials object. (See {Trace::Credentials}) (The
+      #   parameter `keyfile` is considered deprecated, but may also be used.)
+      # * `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.
+      # * `capture_stack` - (Boolean) Whether to capture stack traces for each
+      #   span. Default: `false`
+      # * `sampler` - (Proc) A sampler Proc makes the decision whether to record
+      #   a trace for each request. Default: `Google::Cloud::Trace::TimeSampler`
+      # * `span_id_generator` - (Proc) A generator Proc that generates the name
+      #   String for new TraceRecord. Default: `random numbers`
+      # * `notifications` - (Array) An array of ActiveSupport notification types
+      #   to include in traces. Rails-only option. Default:
+      #   `Google::Cloud::Trace::Railtie::DEFAULT_NOTIFICATIONS`
+      # * `max_data_length` - (Integer) The maximum length of span properties
+      #   recorded with ActiveSupport notification events. Rails-only option.
+      #   Default:
+      #   `Google::Cloud::Trace::Notifications::DEFAULT_MAX_DATA_LENGTH`
+      #
+      # See the [Configuration
+      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
+      # for full configuration parameters.
+      #
+      # @return [Google::Cloud::Config] The configuration object
+      #   the Google::Cloud::Trace module uses.
+      #
+      def self.configure
+        yield Google::Cloud.configure.trace if block_given?
+
+        Google::Cloud.configure.trace
+      end
+
+      ##
+      # @private Default project.
+      def self.default_project_id
+        Google::Cloud.configure.trace.project_id ||
+          Google::Cloud.configure.project_id ||
+          Google::Cloud.env.project_id
+      end
+
+      ##
+      # @private Default credentials.
+      def self.default_credentials scope: nil
+        Google::Cloud.configure.trace.credentials ||
+          Google::Cloud.configure.credentials ||
+          Trace::Credentials.default(scope: scope)
       end
 
       ##
@@ -347,22 +414,6 @@ module Google
           yield nil
         end
       end
-
-      ##
-      # Configure the Stackdriver Trace instrumentation Middleware.
-      #
-      # See the [Configuration
-      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
-      # for full configuration parameters.
-      #
-      # @return [Stackdriver::Core::Configuration] The configuration object
-      #   the Google::Cloud::ErrorReporting module uses.
-      #
-      def self.configure
-        yield Google::Cloud.configure.trace if block_given?
-
-        Google::Cloud.configure.trace
-      end
     end
   end
 end

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

@@ -77,7 +77,7 @@ module Google
 
           begin
             service.patch_traces traces
-          rescue => e
+          rescue StandardError => e
             warn ["#{e.class}: #{e.message}", e.backtrace].join("\n\t")
             @last_exception = e
           end

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

@@ -38,19 +38,19 @@ module Google
       #   trace.project_id #=> "my-project"
       #
       class Credentials < Google::Auth::Credentials
-        SCOPE = ["https://www.googleapis.com/auth/cloud-platform"]
-        PATH_ENV_VARS = %w(TRACE_CREDENTIALS
+        SCOPE = ["https://www.googleapis.com/auth/cloud-platform"].freeze
+        PATH_ENV_VARS = %w[TRACE_CREDENTIALS
                            TRACE_KEYFILE
                            GOOGLE_CLOUD_CREDENTIALS
                            GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(TRACE_CREDENTIALS_JSON
+                           GCLOUD_KEYFILE].freeze
+        JSON_ENV_VARS = %w[TRACE_CREDENTIALS_JSON
                            TRACE_KEYFILE_JSON
                            GOOGLE_CLOUD_CREDENTIALS_JSON
                            GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON)
+                           GCLOUD_KEYFILE_JSON].freeze
         DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"]
+          ["~/.config/gcloud/application_default_credentials.json"].freeze
       end
     end
   end

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

@@ -68,7 +68,7 @@ module Google
                     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
+          if response_status >= 300 && response_status < 400 && response_url
             set_label labels, label_keys::HTTP_REDIRECTED_URL, response_url
           end
         end

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

@@ -22,59 +22,60 @@ module Google
       # A collection of well-known label keys for trace spans.
       #
       module LabelKey
-        AGENT = "/agent"
-        COMPONENT = "/component"
-        ERROR_MESSAGE = "/error/message"
-        ERROR_NAME = "/error/name"
-        HTTP_CLIENT_CITY = "/http/client_city"
-        HTTP_CLIENT_COUNTRY = "/http/client_country"
-        HTTP_CLIENT_PROTOCOL = "/http/client_protocol"
-        HTTP_CLIENT_REGION = "/http/client_region"
-        HTTP_HOST = "/http/host"
-        HTTP_METHOD = "/http/method"
-        HTTP_REDIRECTED_URL = "/http/redirected_url"
-        HTTP_REQUEST_SIZE = "/http/request/size"
-        HTTP_RESPONSE_SIZE = "/http/response/size"
-        HTTP_STATUS_CODE = "/http/status_code"
-        HTTP_URL = "/http/url"
-        HTTP_USER_AGENT = "/http/user_agent"
-        PID = "/pid"
-        STACKTRACE = "/stacktrace"
-        TID = "/tid"
+        AGENT = "/agent".freeze
+        COMPONENT = "/component".freeze
+        ERROR_MESSAGE = "/error/message".freeze
+        ERROR_NAME = "/error/name".freeze
+        HTTP_CLIENT_CITY = "/http/client_city".freeze
+        HTTP_CLIENT_COUNTRY = "/http/client_country".freeze
+        HTTP_CLIENT_PROTOCOL = "/http/client_protocol".freeze
+        HTTP_CLIENT_REGION = "/http/client_region".freeze
+        HTTP_HOST = "/http/host".freeze
+        HTTP_METHOD = "/http/method".freeze
+        HTTP_REDIRECTED_URL = "/http/redirected_url".freeze
+        HTTP_REQUEST_SIZE = "/http/request/size".freeze
+        HTTP_RESPONSE_SIZE = "/http/response/size".freeze
+        HTTP_STATUS_CODE = "/http/status_code".freeze
+        HTTP_URL = "/http/url".freeze
+        HTTP_USER_AGENT = "/http/user_agent".freeze
+        PID = "/pid".freeze
+        STACKTRACE = "/stacktrace".freeze
+        TID = "/tid".freeze
 
-        GAE_APPLICATION_ERROR = "g.co/gae/application_error"
-        GAE_APP_MODULE = "g.co/gae/app/module"
-        GAE_APP_MODULE_VERSION = "g.co/gae/app/module_version"
-        GAE_APP_VERSION = "g.co/gae/app/version"
-        GAE_DATASTORE_COUNT = "g.co/gae/datastore/count"
-        GAE_DATASTORE_CURSOR = "g.co/gae/datastore/cursor"
-        GAE_DATASTORE_ENTITY_WRITES = "g.co/gae/datastore/entity_writes"
-        GAE_DATASTORE_HAS_ANCESTOR = "g.co/gae/datastore/has_ancestor"
-        GAE_DATASTORE_HAS_CURSOR = "g.co/gae/datastore/has_cursor"
-        GAE_DATASTORE_HAS_TRANSACTION = "g.co/gae/datastore/has_transaction"
-        GAE_DATASTORE_INDEX_WRITES = "g.co/gae/datastore/index_writes"
-        GAE_DATASTORE_KIND = "g.co/gae/datastore/kind"
-        GAE_DATASTORE_LIMIT = "g.co/gae/datastore/limit"
-        GAE_DATASTORE_MORE_RESULTS = "g.co/gae/datastore/more_results"
-        GAE_DATASTORE_OFFSET = "g.co/gae/datastore/offset"
+        GAE_APPLICATION_ERROR = "g.co/gae/application_error".freeze
+        GAE_APP_MODULE = "g.co/gae/app/module".freeze
+        GAE_APP_MODULE_VERSION = "g.co/gae/app/module_version".freeze
+        GAE_APP_VERSION = "g.co/gae/app/version".freeze
+        GAE_DATASTORE_COUNT = "g.co/gae/datastore/count".freeze
+        GAE_DATASTORE_CURSOR = "g.co/gae/datastore/cursor".freeze
+        GAE_DATASTORE_ENTITY_WRITES = "g.co/gae/datastore/entity_writes".freeze
+        GAE_DATASTORE_HAS_ANCESTOR = "g.co/gae/datastore/has_ancestor".freeze
+        GAE_DATASTORE_HAS_CURSOR = "g.co/gae/datastore/has_cursor".freeze
+        GAE_DATASTORE_HAS_TRANSACTION =
+          "g.co/gae/datastore/has_transaction".freeze
+        GAE_DATASTORE_INDEX_WRITES = "g.co/gae/datastore/index_writes".freeze
+        GAE_DATASTORE_KIND = "g.co/gae/datastore/kind".freeze
+        GAE_DATASTORE_LIMIT = "g.co/gae/datastore/limit".freeze
+        GAE_DATASTORE_MORE_RESULTS = "g.co/gae/datastore/more_results".freeze
+        GAE_DATASTORE_OFFSET = "g.co/gae/datastore/offset".freeze
         GAE_DATASTORE_REQUESTED_ENTITY_DELETES =
-          "g.co/gae/datastore/requested_entity_deletes"
+          "g.co/gae/datastore/requested_entity_deletes".freeze
         GAE_DATASTORE_REQUESTED_ENTITY_PUTS =
-          "g.co/gae/datastore/requested_entity_puts"
-        GAE_DATASTORE_SIZE = "g.co/gae/datastore/size"
-        GAE_DATASTORE_SKIPPED = "g.co/gae/datastore/skipped"
+          "g.co/gae/datastore/requested_entity_puts".freeze
+        GAE_DATASTORE_SIZE = "g.co/gae/datastore/size".freeze
+        GAE_DATASTORE_SKIPPED = "g.co/gae/datastore/skipped".freeze
         GAE_DATASTORE_TRANSACTION_HANDLE =
-          "g.co/gae/datastore/transaction_handle"
-        GAE_ERROR_MESSAGE = "g.co/gae/error_message"
-        GAE_MEMCACHE_COUNT = "g.co/gae/memcache/count"
-        GAE_MEMCACHE_SIZE = "g.co/gae/memcache/size"
-        GAE_REQUEST_LOG_ID = "g.co/gae/request_log_id"
+          "g.co/gae/datastore/transaction_handle".freeze
+        GAE_ERROR_MESSAGE = "g.co/gae/error_message".freeze
+        GAE_MEMCACHE_COUNT = "g.co/gae/memcache/count".freeze
+        GAE_MEMCACHE_SIZE = "g.co/gae/memcache/size".freeze
+        GAE_REQUEST_LOG_ID = "g.co/gae/request_log_id".freeze
 
-        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"
+        RPC_HOST = "/rpc/host".freeze
+        RPC_REQUEST_TYPE = "/rpc/request/type".freeze
+        RPC_REQUEST_SIZE = "/rpc/request/size".freeze
+        RPC_RESPONSE_SIZE = "/rpc/response/size".freeze
+        RPC_STATUS_CODE = "/rpc/status_code".freeze
 
         ##
         # Set the stack trace label in the given labels hash. The current call

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

@@ -131,9 +131,9 @@ module Google
             project_id = configuration.project_id
 
             if project_id
-              keyfile = configuration.keyfile
-              tracer = Google::Cloud::Trace.new project: project_id,
-                                                keyfile: keyfile
+              credentials = configuration.credentials
+              tracer = Google::Cloud::Trace.new project_id: project_id,
+                                                credentials: credentials
               @service = Google::Cloud::Trace::AsyncReporter.new tracer.service
             end
           end
@@ -212,7 +212,7 @@ module Google
           if @service && trace.trace_context.sampled?
             begin
               @service.patch_traces trace
-            rescue => ex
+            rescue StandardError => ex
               msg = "Transmit to Stackdriver Trace failed: #{ex.inspect}"
               logger = env["rack.logger"]
               if logger
@@ -349,9 +349,9 @@ module Google
         def configure_result span, result
           if result.is_a?(::Array) && result.size == 3
             span.labels[Google::Cloud::Trace::LabelKey::HTTP_STATUS_CODE] =
-                result[0].to_s
+              result[0].to_s
             result[1]["X-Cloud-Trace-Context"] =
-                span.trace.trace_context.to_string
+              span.trace.trace_context.to_string
           end
           result
         end
@@ -364,12 +364,14 @@ module Google
         # already.
         #
         def load_config **kwargs
-          configuration.capture_stack = kwargs[:capture_stack] ||
-                                        configuration.capture_stack
-          configuration.sampler = kwargs[:sampler] ||
-                                  configuration.sampler
-          configuration.span_id_generator = kwargs[:span_id_generator] ||
-                                            configuration.span_id_generator
+          capture_stack = kwargs[:capture_stack]
+          configuration.capture_stack = capture_stack unless capture_stack.nil?
+
+          sampler = kwargs[:sampler]
+          configuration.sampler = sampler unless sampler.nil?
+
+          generator = kwargs[:span_id_generator]
+          configuration.span_id_generator = generator unless generator.nil?
 
           init_default_config
         end
@@ -377,9 +379,8 @@ module Google
         ##
         # Fallback to default configuration values if not defined already
         def init_default_config
-          configuration.project_id ||= Cloud.configure.project_id ||
-                                       Trace::Project.default_project_id
-          configuration.keyfile ||= Cloud.configure.keyfile
+          configuration.project_id ||= Trace.default_project_id
+          configuration.credentials ||= Cloud.configure.credentials
           configuration.capture_stack ||= false
         end
 

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

@@ -27,7 +27,7 @@ module Google
 
         ##
         # The default prefix for label keys
-        DEFAULT_LABEL_NAMESPACE = "/ruby/"
+        DEFAULT_LABEL_NAMESPACE = "/ruby/".freeze
 
         ##
         # Stack truncation method that removes the ActiveSupport::Notifications
@@ -104,7 +104,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
             end
           end

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

@@ -21,7 +21,7 @@ module GRPC
   # class. Intercept each GRPC request and create a Trace span with basic
   # request information.
   module ActiveCallWithTrace
-    SPAN_NAME = "gRPC request"
+    SPAN_NAME = "gRPC request".freeze
 
     ##
     # Override GRPC::ActiveCall#request_response method. Wrap the original

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

@@ -70,7 +70,7 @@ module Google
         def project_id
           service.project
         end
-        alias_method :project, :project_id
+        alias project project_id
 
         ##
         # Create a new empty trace record for this project. Uses the current
@@ -197,22 +197,13 @@ module Google
                               page_token: page_token
         end
 
-        ##
-        # @private Default project.
-        def self.default_project_id
-          ENV["TRACE_PROJECT"] ||
-            ENV["GOOGLE_CLOUD_PROJECT"] ||
-            ENV["GCLOUD_PROJECT"] ||
-            Google::Cloud.env.project_id
-        end
-
         protected
 
         ##
         # @private Raise an error unless an active connection to the service is
         # available.
         def ensure_service!
-          fail "Must have active connection to service" unless service
+          raise "Must have active connection to service" unless service
         end
       end
     end

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

@@ -131,7 +131,7 @@ module Google
           # Verify credentials and set use_error_reporting to false if
           # credentials are invalid
           unless valid_credentials? Trace.configure.project_id,
-                                    Trace.configure.keyfile
+                                    Trace.configure.credentials
             Cloud.configure.use_trace = false
             return
           end
@@ -140,6 +140,8 @@ module Google
           Google::Cloud.configure.use_trace ||= Rails.env.production?
         end
 
+        # rubocop:disable all
+
         ##
         # @private Merge Rails configuration into Trace instrumentation
         # configuration.
@@ -147,23 +149,32 @@ module Google
           gcp_config = rails_config.google_cloud
           trace_config = gcp_config.trace
 
-          Cloud.configure.use_trace ||= gcp_config.use_trace
+          if Cloud.configure.use_trace.nil?
+            Cloud.configure.use_trace = gcp_config.use_trace
+          end
           Trace.configure do |config|
-            config.project_id ||= trace_config.project_id ||
-                                  gcp_config.project_id
-            config.keyfile ||= trace_config.keyfile || gcp_config.keyfile
+            config.project_id ||= (config.project ||
+              trace_config.project_id || trace_config.project ||
+              gcp_config.project_id || gcp_config.project)
+            config.credentials ||= (config.keyfile ||
+              trace_config.credentials || trace_config.keyfile ||
+              gcp_config.credentials || gcp_config.keyfile)
             config.notifications ||= trace_config.notifications
             config.max_data_length ||= trace_config.max_data_length
-            config.capture_stack ||= trace_config.capture_stack
+            if config.capture_stack.nil?
+              config.capture_stack = trace_config.capture_stack
+            end
             config.sampler ||= trace_config.sampler
             config.span_id_generator ||= trace_config.span_id_generator
           end
         end
 
+        # rubocop:enable all
+
         ##
         # Fallback to default config values if config parameters not provided.
         def self.init_default_config
-          Trace.configure.project_id ||= Trace::Project.default_project_id
+          Trace.configure.project_id ||= Trace.default_project_id
         end
 
         ##

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

@@ -66,7 +66,8 @@ module Google
                 timeout: timeout,
                 client_config: client_config,
                 lib_name: "gccl",
-                lib_version: Google::Cloud::Trace::VERSION)
+                lib_version: Google::Cloud::Trace::VERSION
+              )
             end
         end
         attr_accessor :mocked_lowlevel_client
@@ -94,21 +95,22 @@ module Google
           Google::Cloud::Trace::TraceRecord.from_grpc trace_proto
         end
 
+        # rubocop:disable Metrics/MethodLength
+
         ##
         # Searches for traces matching the given criteria.
         #
-        # rubocop:disable Metrics/MethodLength
         def list_traces project_id, start_time, end_time,
                         filter: nil,
                         order_by: nil,
                         view: nil,
                         page_size: nil,
                         page_token: nil
-          if page_token
-            call_opts = Google::Gax::CallOptions.new page_token: page_token
-          else
-            call_opts = Google::Gax::CallOptions.new
-          end
+          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
@@ -121,6 +123,7 @@ module Google
                                         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,
@@ -131,6 +134,8 @@ module Google
             page_token: page_token
         end
 
+        # rubocop:enable Metrics/MethodLength
+
         # @private
         def inspect
           "#{self.class}(#{@project})"

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

@@ -116,13 +116,14 @@ module Google
           @labels = labels
         end
 
+        # rubocop:disable Metrics/AbcSize
+
         ##
         # Standard value equality check for this object.
         #
         # @param [Object] other
         # @return [Boolean]
         #
-        # rubocop:disable Metrics/AbcSize
         def eql? other
           other.is_a?(Google::Cloud::Trace::Span) &&
             trace.trace_context == other.trace.trace_context &&
@@ -135,7 +136,9 @@ module Google
             end_time == other.end_time &&
             labels == other.labels
         end
-        alias_method :==, :eql?
+        alias == eql?
+
+        # rubocop:enable Metrics/AbcSize
 
         ##
         # Create a new Span object from a TraceSpan protobuf and insert it
@@ -297,7 +300,7 @@ module Google
         # starts them if not.
         #
         def start!
-          fail "Span already started" if start_time
+          raise "Span already started" if start_time
           ensure_started
         end
 
@@ -309,8 +312,8 @@ module Google
         # finishes them if not.
         #
         def finish!
-          fail "Span not yet started" unless start_time
-          fail "Span already finished" if end_time
+          raise "Span not yet started" unless start_time
+          raise "Span already finished" if end_time
           ensure_finished
         end
 
@@ -417,7 +420,7 @@ module Google
         # @private
         #
         def ensure_exists!
-          fail "Span has been deleted" unless trace
+          raise "Span has been deleted" unless trace
         end
 
         ##
@@ -429,7 +432,7 @@ module Google
         def ensure_no_cycle! new_parent
           ptr = new_parent
           until ptr.nil?
-            fail "Move would result in a cycle" if ptr.equal?(self)
+            raise "Move would result in a cycle" if ptr.equal?(self)
             ptr = ptr.parent
           end
         end

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

@@ -44,19 +44,20 @@ module Google
         # Create an empty Trace object. If a trace context is provided, it is
         # used to locate this trace within that context.
         #
-        # @param [String] project The ID of the project containing this trace.
+        # @param [String] project_id The ID of the project containing this
+        #   trace.
         # @param [Stackdriver::Core::TraceContext] trace_context The context
         #     within which to locate this trace (i.e. sets the trace ID and
         #     the context parent span, if present.) If no context is provided,
         #     a new trace with a new trace ID is created.
         #
-        def initialize project, trace_context = nil, span_id_generator: nil
-          @project = project
+        def initialize project_id, trace_context = nil, span_id_generator: nil
+          @project_id = project_id
           @trace_context = trace_context || Stackdriver::Core::TraceContext.new
           @root_spans = []
           @spans_by_id = {}
           @span_id_generator =
-            span_id_generator || ::Proc.new { rand(0xffffffffffffffff) + 1 }
+            span_id_generator || ::Proc.new { rand(1..0xffffffffffffffff) }
         end
 
         ##
@@ -70,7 +71,7 @@ module Google
             trace_context == other.trace_context &&
             @spans_by_id == other.instance_variable_get(:@spans_by_id)
         end
-        alias_method :==, :eql?
+        alias == eql?
 
         ##
         # Create a new Trace object from a trace protobuf.
@@ -88,7 +89,7 @@ module Google
           parent_span_ids = find_root_span_ids span_protos
 
           span_id = parent_span_ids.size == 1 ? parent_span_ids.first : 0
-          span_id = nil if span_id == 0
+          span_id = nil if span_id.zero?
           tc = Stackdriver::Core::TraceContext.new trace_id: trace_id,
                                                    span_id: span_id
           trace = new trace_proto.project_id, tc
@@ -111,7 +112,7 @@ module Google
             span.to_grpc trace_context.span_id.to_i
           end
           Google::Devtools::Cloudtrace::V1::Trace.new \
-            project_id: project,
+            project_id: project_id,
             trace_id: trace_id,
             spans: span_protos
         end
@@ -121,8 +122,8 @@ module Google
         #
         # @return [String]
         #
-        attr_reader :project
-        alias_method :project_id, :project
+        attr_reader :project_id
+        alias project project_id
 
         ##
         # The context for this trace.
@@ -191,7 +192,7 @@ module Google
                         start_time: nil, end_time: nil,
                         labels: {}
           parent_span_id = parent_span_id.to_i
-          parent_span_id = trace_context.span_id.to_i if parent_span_id == 0
+          parent_span_id = trace_context.span_id.to_i if parent_span_id.zero?
           parent_span = @spans_by_id[parent_span_id]
           if parent_span
             parent_span.create_span name,
@@ -243,7 +244,7 @@ module Google
                                  start_time, end_time, labels
           span_id = span_id.to_i
           parent_span_id = parent_span_id.to_i
-          span_id = unique_span_id if span_id == 0
+          span_id = unique_span_id if span_id.zero?
           span = Google::Cloud::Trace::Span.new \
             self, span_id, parent_span_id, parent, name, kind,
             start_time, end_time, labels

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Trace
-      VERSION = "0.30.0".freeze
+      VERSION = "0.31.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.30.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-26 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -16,28 +16,28 @@ 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: stackdriver-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: google-gax
   requirement: !ruby/object:Gem::Requirement
@@ -154,16 +154,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -290,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Application Instrumentation and API Client library for Stackdriver Trace