google-cloud-logging 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f630302c8714555f32d66a9a19a5da340c6bbd840b1a1ed9c7da1798b42254df
-  data.tar.gz: d0fb2056868a23c282082339be24ddd1aeca4c4ff9cc4659b1fd3091b5364596
+  metadata.gz: 3ab79fe662f67035257cff75fec93833d4bfce8db1c3621683e3bb9982a7791e
+  data.tar.gz: 469eb5b80af7c0314197626009b649d658e6104493c5ccf6cc75e9694904cde6
 SHA512:
-  metadata.gz: 484774d516102279b6197436dc1daee472eabd055d24f0d9e4a7460144aec2255cce2ad33bfa176b76713f5e252e72aa05014da53952587c15de9fc7e01688c0
-  data.tar.gz: 051e5a2e070aa2a2fbef148971fbf1d5e02d05c211720442682775591254803548a31745b359aee8a48be2eb4bd5a2d86671b6dc9ed150070fa550958e7181f3
+  metadata.gz: 38683f930c15541f2adaaec7804f5b22c945ac7e768f1511f20abf6d7c8bf587bbc8eaf16e35626bfccc7201f9daf87a582f4c04c4f4e072180cf5596af4fa44
+  data.tar.gz: 34dd2648e895ccc122b8de4be189f51f50f70ae38b8a72adced50f5900a0d29c5efa11566a8066656bea49354303937dbd1d3441a613981c50c6c2e56d06e07e

data/README.md

@@ -156,10 +156,39 @@ See the [Authentication
 Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/guides/authentication).
 for more ways to authenticate the client library.
 
+## 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+.
 
+However, Ruby 2.3 or later is strongly recommended, as earlier releases have
+reached or are nearing end-of-life. After June 1, 2018, Google will provide
+official support only for Ruby versions that are considered current and
+supported by Ruby Core (that is, Ruby versions that are either in normal
+maintenance or in security maintenance).
+See https://www.ruby-lang.org/en/downloads/branches/ for further details.
+
 ## Versioning
 
 This library follows [Semantic Versioning](http://semver.org/).

data/lib/google/cloud/logging.rb

@@ -55,6 +55,39 @@ module Google
     # implementation](#creating-a-ruby-logger-implementation) provided by this
     # library. Otherwise, read on to learn more about the Logging API.
     #
+    # ## 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
+    # ```x
+    #
     # ## Listing log entries
     #
     # Stackdriver Logging gathers log entries from many services, including

data/lib/google/cloud/logging/entry.rb

@@ -426,14 +426,14 @@ module Google
             e.insert_id = grpc.insert_id
             e.labels = Convert.map_to_hash(grpc.labels)
             e.payload = extract_payload(grpc)
-            e.instance_variable_set "@resource",
+            e.instance_variable_set :@resource,
                                     Resource.from_grpc(grpc.resource)
-            e.instance_variable_set "@http_request",
+            e.instance_variable_set :@http_request,
                                     HttpRequest.from_grpc(grpc.http_request)
-            e.instance_variable_set "@operation",
+            e.instance_variable_set :@operation,
                                     Operation.from_grpc(grpc.operation)
             e.trace = grpc.trace
-            e.instance_variable_set "@source_location",
+            e.instance_variable_set :@source_location,
                                     SourceLocation.from_grpc(
                                       grpc.source_location
                                     )

data/lib/google/cloud/logging/entry/list.rb

@@ -73,7 +73,9 @@ module Google
             grpc = @service.list_entries token: token, resources: @resources,
                                          filter: @filter, order: @order,
                                          max: @max, projects: @projects
-            self.class.from_grpc grpc, @service
+            self.class.from_grpc grpc, @service, resources: @resources,
+                                                 filter: @filter, order: @order,
+                                                 max: @max, projects: @projects
           end
 
           ##
@@ -150,14 +152,14 @@ module Google
               Entry.from_grpc grpc_entry
             end)
             token = grpc_list.next_page_token
-            token = nil if token == ""
-            entries.instance_variable_set "@token", token
-            entries.instance_variable_set "@service", service
-            entries.instance_variable_set "@projects", projects
-            entries.instance_variable_set "@resources", resources
-            entries.instance_variable_set "@filter", filter
-            entries.instance_variable_set "@order", order
-            entries.instance_variable_set "@max", max
+            token = nil if token == "".freeze
+            entries.instance_variable_set :@token,     token
+            entries.instance_variable_set :@service,   service
+            entries.instance_variable_set :@projects,  projects
+            entries.instance_variable_set :@resources, resources
+            entries.instance_variable_set :@filter,    filter
+            entries.instance_variable_set :@order,     order
+            entries.instance_variable_set :@max,       max
             entries
           end
 

data/lib/google/cloud/logging/log/list.rb

@@ -72,7 +72,8 @@ module Google
             ensure_service!
             grpc = @service.list_logs token: token, resource: @resource,
                                       max: @max
-            self.class.from_grpc grpc, @service
+            self.class.from_grpc grpc, @service, resource: @resource,
+                                                 max: @max
           end
 
           ##
@@ -132,11 +133,11 @@ module Google
           def self.from_grpc grpc_list, service, resource: nil, max: nil
             logs = new(Array(grpc_list.log_names))
             token = grpc_list.next_page_token
-            token = nil if token == ""
-            logs.instance_variable_set "@token", token
-            logs.instance_variable_set "@service", service
-            logs.instance_variable_set "@resource", resource
-            logs.instance_variable_set "@max", max
+            token = nil if token == "".freeze
+            logs.instance_variable_set :@token,    token
+            logs.instance_variable_set :@service,  service
+            logs.instance_variable_set :@resource, resource
+            logs.instance_variable_set :@max,      max
             logs
           end
 

data/lib/google/cloud/logging/metric/list.rb

@@ -72,7 +72,7 @@ module Google
             return nil unless next?
             ensure_service!
             grpc = @service.list_metrics token: token, max: @max
-            self.class.from_grpc grpc, @service
+            self.class.from_grpc grpc, @service, @max
           end
 
           ##
@@ -148,10 +148,10 @@ module Google
               Metric.from_grpc grpc_metric, service
             end)
             token = grpc_list.next_page_token
-            token = nil if token == ""
-            metrics.instance_variable_set "@token", token
-            metrics.instance_variable_set "@service", service
-            metrics.instance_variable_set "@max", max
+            token = nil if token == "".freeze
+            metrics.instance_variable_set :@token,   token
+            metrics.instance_variable_set :@service, service
+            metrics.instance_variable_set :@max,     max
             metrics
           end
 

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

@@ -95,7 +95,7 @@ module Google
           # Done if Google::Cloud.configure.use_logging is explicitly false
           return if Google::Cloud.configure.use_logging == false
 
-          # Verify credentials and set use_error_reporting to false if
+          # Verify credentials and set use_logging to false if
           # credentials are invalid
           unless valid_credentials? Logging.configure.project_id,
                                     Logging.configure.keyfile
@@ -114,7 +114,9 @@ module Google
           gcp_config = rails_config.google_cloud
           log_config = gcp_config.logging
 
-          Cloud.configure.use_logging ||= gcp_config.use_logging
+          if Cloud.configure.use_logging.nil?
+            Cloud.configure.use_logging = gcp_config.use_logging
+          end
           Logging.configure do |config|
             config.project_id ||= config.project
             config.project_id ||= log_config.project_id || log_config.project

data/lib/google/cloud/logging/resource_descriptor.rb

@@ -73,15 +73,15 @@ module Google
         # @private New ResourceDescriptor from a
         # Google::Api::MonitoredResourceDescriptor object.
         def self.from_grpc grpc
-          r = new
-          r.instance_variable_set "@type", grpc.type
-          r.instance_variable_set "@name", grpc.display_name
-          r.instance_variable_set "@description", grpc.description
           labels = Array(grpc.labels).map do |g|
             LabelDescriptor.from_grpc g
           end
-          r.instance_variable_set "@labels", labels
-          r
+          new.tap do |r|
+            r.instance_variable_set :@type,        grpc.type
+            r.instance_variable_set :@name,        grpc.display_name
+            r.instance_variable_set :@description, grpc.description
+            r.instance_variable_set :@labels,      labels
+          end
         end
 
         ##
@@ -124,11 +124,11 @@ module Google
             type_sym = { STRING: :string,
                          BOOL:   :boolean,
                          INT64:  :integer }[grpc.value_type]
-            l = new
-            l.instance_variable_set "@key", grpc.key
-            l.instance_variable_set "@type", type_sym
-            l.instance_variable_set "@description", grpc.description
-            l
+            new.tap do |l|
+              l.instance_variable_set :@key,         grpc.key
+              l.instance_variable_set :@type,        type_sym
+              l.instance_variable_set :@description, grpc.description
+            end
           end
         end
       end

data/lib/google/cloud/logging/resource_descriptor/list.rb

@@ -75,7 +75,7 @@ module Google
             list_grpc = @service.list_resource_descriptors(
               token: token, max: @max
             )
-            self.class.from_grpc list_grpc, @service
+            self.class.from_grpc list_grpc, @service, @max
           end
 
           ##
@@ -154,10 +154,10 @@ module Google
               ResourceDescriptor.from_grpc grpc
             end)
             token = grpc_list.next_page_token
-            token = nil if token == ""
-            rds.instance_variable_set "@token", token
-            rds.instance_variable_set "@service", service
-            rds.instance_variable_set "@max", max
+            token = nil if token == "".freeze
+            rds.instance_variable_set :@token,   token
+            rds.instance_variable_set :@service, service
+            rds.instance_variable_set :@max,     max
             rds
           end
 

data/lib/google/cloud/logging/sink/list.rb

@@ -71,7 +71,7 @@ module Google
             return nil unless next?
             ensure_service!
             list_grpc = @service.list_sinks token: token, max: @max
-            self.class.from_grpc list_grpc, @service
+            self.class.from_grpc list_grpc, @service, @max
           end
 
           ##
@@ -147,10 +147,10 @@ module Google
               Sink.from_grpc grpc, service
             end)
             token = grpc_list.next_page_token
-            token = nil if token == ""
-            sinks.instance_variable_set "@token", token
-            sinks.instance_variable_set "@service", service
-            sinks.instance_variable_set "@max", max
+            token = nil if token == "".freeze
+            sinks.instance_variable_set :@token,   token
+            sinks.instance_variable_set :@service, service
+            sinks.instance_variable_set :@max,     max
             sinks
           end
 

data/lib/google/cloud/logging/v2/doc/overview.rb

@@ -17,7 +17,7 @@ module Google
     # rubocop:disable LineLength
 
     ##
-    # # Ruby Client for Stackdriver Logging API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    # # Ruby Client for Stackdriver Logging API ([GA](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
     #
     # [Stackdriver Logging API][Product Documentation]:
     # Writes log entries and manages your Stackdriver Logging configuration.
@@ -63,4 +63,4 @@ module Google
       end
     end
   end
-end
+end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Logging
-      VERSION = "1.5.0".freeze
+      VERSION = "1.5.1".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-logging
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 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: API Client library for Stackdriver Logging