google-cloud-trace 0.33.0 → 0.33.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7becd377ee3ddaa69c4cb68f69936d1b44f30d15ea11fdd310b3be018b483d4
-  data.tar.gz: 6bdd288a7aab1639b8be40585290458e990b4c0521db644e2e9828b08fd096da
+  metadata.gz: 72f583302c7f227c7286b69a817b865126bb46f4e81db80032758a17cbd29bbb
+  data.tar.gz: cdba7500b430fadb4aca52ab717a0604aa2217f1fa5afc7341f5f0f070d015cf
 SHA512:
-  metadata.gz: efee8c87c8d583cbb9947e049bf6a593aee6c5e69f6a0f67c3d2863a7fe75495ce52885ec9f011992c0c59d2c8d39153438aa2af4d88cae07144e1498ad90ad8
-  data.tar.gz: 499852250ad78d5d368828c727a89617c2116feb219ab6fad2b835857dc13d7b12dc7744336d17a261aa655569c15869496e4bb903a7100549d08c9c538a85cf
+  metadata.gz: 82a08cfe8604df23297959ce11f140dd316cfa3b692ed27d7b4ff1c7a2854836a38f67e7b835082f6ba1dc27ff78e8b03093487414c4d347b8e1501a2b347bf9
+  data.tar.gz: 8519a7df8948dc32b16540f0ee1f2e2d0d92d61af90081e824e14f6a1fc499960d9c15b90fc056c2107763119b972129080db4d0dc7adbb6ef39517a7dc89c05

data/README.md

@@ -183,6 +183,28 @@ 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).
 
+## Enabling Logging
+
+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 shown below, or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger) that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.0+.

data/lib/google/cloud/trace.rb

@@ -190,6 +190,39 @@ module Google
     # trace_client.patch_traces trace
     # ```
     #
+    # ## Enabling Logging
+    #
+    # 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 shown below, or a
+    # [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+    # that will write logs to [Stackdriver
+    # Logging](https://cloud.google.com/logging/). See
+    # [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+    # and the gRPC
+    # [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb)
+    # for additional information.
+    #
+    # Configuring a Ruby stdlib logger:
+    #
+    # ```ruby
+    # require "logger"
+    #
+    # module MyLogger
+    #   LOGGER = Logger.new $stderr, level: Logger::WARN
+    #   def logger
+    #     LOGGER
+    #   end
+    # end
+    #
+    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+    # module GRPC
+    #   extend MyLogger
+    # end
+    # ```
+    #
     module Trace
       THREAD_KEY = :__stackdriver_trace_span__
 

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

@@ -128,7 +128,7 @@ module Google
           # Done if Google::Cloud.configure.use_trace is explicitly false
           return if Google::Cloud.configure.use_trace == false
 
-          # Verify credentials and set use_error_reporting to false if
+          # Verify credentials and set use_trace to false if
           # credentials are invalid
           unless valid_credentials? Trace.configure.project_id,
                                     Trace.configure.credentials

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

@@ -30,7 +30,8 @@ module Google
       #
       # 1.  It allows you to blacklist certain URI paths that should never be
       #     traced. For example, the Google App Engine health check request
-      #     path `/_ah/health` is blacklisted by default.
+      #     path `/_ah/health` is blacklisted by default. Kubernetes default
+      #     health check `/healthz` is also ignored.
       # 2.  It spaces samples out by delaying a minimum time between each
       #     sample. This enforces a maximum QPS for this Ruby process.
       #
@@ -38,7 +39,7 @@ module Google
         ##
         # Default list of paths for which to disable traces. Currently includes
         # App Engine Flex health checks.
-        DEFAULT_PATH_BLACKLIST = ["/_ah/health"].freeze
+        DEFAULT_PATH_BLACKLIST = ["/_ah/health", "/healthz"].freeze
 
         ##
         # Create a TimeSampler for the given QPS.

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Trace
-      VERSION = "0.33.0".freeze
+      VERSION = "0.33.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.33.0
+  version: 0.33.1
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -290,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Application Instrumentation and API Client library for Stackdriver Trace