google-cloud-logging 1.10.7 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcf1cecc45e21a908822e15ae13b14ee5b110e460f61c743442af832e35b3d03
-  data.tar.gz: 4328a9236c7380894d39281f14906e6a21a5623bf5f9e1a5823b9407be4891ee
+  metadata.gz: 1bebb4573f1d510e3c8c6d007a92edbafcdf06c1c1a545791429541e7ee1c3db
+  data.tar.gz: 69f4fff5db4ac937df49ee56b7b93fbcf55e4041610f84f318f56e70703fca6d
 SHA512:
-  metadata.gz: a5cfe2ab82077f691c247e91380c12e9ac632e5ea00cf95af069e93d6d2b20c300a80218c0fe8834785180b52660f8871d0ad0840f1fd343706d903680433326
-  data.tar.gz: e6ad1dd7d86df9605d3b2fd466ae386ac9115962ad43e2dc568bbbf6c8216f37a06ea184764629baa0c9632db487058847f9c9202be2facb0b5209530df31bfa
+  metadata.gz: 7a37da884d7f7f6bd6f7f908f907feda49b59894d7f1534d7b474c77e39e371ea96894185e9921e0a07166f70e2980fb0fc33852679c2dcf440d33cfa8bffdf0
+  data.tar.gz: c01f22ade5fd8c14957446b4e372f6e9476cb77c17b54a91079b86556156a5a6201e4cac80a5459fcaf34d791f623fb45396bd6cd643a57d29065d01cbea44a5

data/AUTHENTICATION.md

@@ -76,7 +76,8 @@ The environment variables that google-cloud-logging checks for project ID are:
 1. `LOGGING_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-logging checks for credentials are configured on {Google::Cloud::Logging::V2::Credentials}:
+The environment variables that google-cloud-logging checks for credentials are
+configured on `Google::Cloud::Logging::V2::LoggingService::Credentials`:
 
 1. `LOGGING_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `LOGGING_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Release History
 
+### 2.2.0 / 2021-03-10
+
+#### Features
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
+
+### 2.1.0 / 2020-09-16
+
+#### Features
+
+* quota_project can be set via library configuration
+
+### 2.0.0 / 2020-07-21
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new `google-cloud-logging-v2` gem as a dependency.
+The new dependency is a rewritten low-level client, 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 `google-cloud-logging-v2`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::Logging::V2` module,
+please review the docs for the new `google-cloud-logging-v2` gem. 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.
+
+### 1.10.9 / 2020-06-17
+
+#### Documentation
+
+* Improved field descriptions in the low-level interface.
+
+### 1.10.8 / 2020-06-12
+
+#### Documentation
+
+* Provide more details on low-level monitored resource data types
+
 ### 1.10.7 / 2020-05-28
 
 #### Documentation

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud-logging console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-logging requires Ruby 2.4+. You may choose to
+1. Install Ruby. google-cloud-logging 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-logging/
-   $ bundle update
+   $ bundle install
    ```
 
 ## Console

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/lib/google-cloud-logging.rb

@@ -43,8 +43,6 @@ module Google
     #   * `https://www.googleapis.com/auth/logging.admin`
     #
     # @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.
     #
     # @return [Google::Cloud::Logging::Project]
     #
@@ -66,11 +64,10 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   logging = gcloud.logging scope: platform_scope
     #
-    def logging scope: nil, timeout: nil, client_config: nil
+    def logging scope: nil, timeout: nil
       timeout ||= @timeout
-      Google::Cloud.logging @project, @keyfile, scope:         scope,
-                                                timeout:       timeout,
-                                                client_config: client_config
+      Google::Cloud.logging @project, @keyfile, scope:   scope,
+                                                timeout: timeout
     end
 
     ##
@@ -96,8 +93,6 @@ module Google
     #   * `https://www.googleapis.com/auth/logging.admin`
     #
     # @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.
     #
     # @return [Google::Cloud::Logging::Project]
     #
@@ -111,13 +106,11 @@ module Google
     #     puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
     #   end
     #
-    def self.logging project_id = nil, credentials = nil, scope: nil,
-                     timeout: nil, client_config: nil
+    def self.logging project_id = nil, credentials = nil, scope: nil, timeout: nil
       require "google/cloud/logging"
       Google::Cloud::Logging.new project_id: project_id,
                                  credentials: credentials,
-                                 scope: scope, timeout: timeout,
-                                 client_config: client_config
+                                 scope: scope, timeout: timeout
     end
   end
 end
@@ -139,6 +132,13 @@ Google::Cloud.configure.add_config! :logging do |config|
       "LOGGING_CREDENTIALS", "LOGGING_CREDENTIALS_JSON",
       "LOGGING_KEYFILE", "LOGGING_KEYFILE_JSON"
   end
+  default_scopes = [
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/cloud-platform.read-only",
+    "https://www.googleapis.com/auth/logging.admin",
+    "https://www.googleapis.com/auth/logging.read",
+    "https://www.googleapis.com/auth/logging.write"
+  ]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
@@ -146,10 +146,10 @@ Google::Cloud.configure.add_config! :logging do |config|
                     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, default_scopes, match: [String, Array]
+  config.add_field! :quota_project, nil, match: String
   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, "logging.googleapis.com", match: String
   config.add_field! :log_name, nil, match: String
   config.add_field! :log_name_map, nil, match: Hash
   config.add_field! :labels, nil, match: Hash

data/lib/google/cloud/logging.rb

@@ -63,8 +63,6 @@ module Google
       #   * `https://www.googleapis.com/auth/logging.admin`
       #
       # @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.
@@ -83,12 +81,16 @@ module Google
       #     puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
       #   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))
 
@@ -102,12 +104,8 @@ module Google
         project_id = project_id.to_s # Always cast to a string
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        Logging::Project.new(
-          Logging::Service.new(
-            project_id, credentials,
-            host: endpoint, timeout: timeout, client_config: client_config
-          )
-        )
+        service = Logging::Service.new project_id, credentials, host: endpoint, timeout: timeout
+        Logging::Project.new service
       end
 
       ##
@@ -127,8 +125,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.
       # * `log_name` - (String) Name of the application log file. Default:
@@ -186,4 +182,7 @@ module Google
       end
     end
   end
+
+  # @private
+  Logging = Cloud::Logging unless const_defined? :Logging
 end

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

@@ -65,7 +65,7 @@ module Google
 
         ##
         # @private Creates a new AsyncWriter instance.
-        def initialize logging, max_count: 10000, max_bytes: 10000000,
+        def initialize logging, max_count: 10_000, max_bytes: 10_000_000,
                        max_queue: 100, interval: 5, threads: 10,
                        partial_success: false
           # init MonitorMixin
@@ -210,7 +210,7 @@ module Google
             @stopped = true
             publish_batch!
             @cond.broadcast
-            @thread_pool.shutdown if @thread_pool
+            @thread_pool&.shutdown
           end
 
           self
@@ -457,7 +457,8 @@ module Google
         ##
         # @private
         class Batch
-          attr_reader :created_at, :entries
+          attr_reader :created_at
+          attr_reader :entries
 
           def initialize writer
             @writer = writer
@@ -499,7 +500,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/logging/convert.rb

@@ -39,14 +39,19 @@ module Google
         # @private Convert an Object to a Google::Protobuf::Value.
         def self.object_to_value obj
           case obj
-          when NilClass then Google::Protobuf::Value.new null_value: :NULL_VALUE
-          when Numeric then Google::Protobuf::Value.new number_value: obj
-          when String then Google::Protobuf::Value.new string_value: obj
-          when TrueClass then Google::Protobuf::Value.new bool_value: true
-          when FalseClass then Google::Protobuf::Value.new bool_value: false
-          when Hash then
+          when NilClass
+            Google::Protobuf::Value.new null_value: :NULL_VALUE
+          when Numeric
+            Google::Protobuf::Value.new number_value: obj
+          when String
+            Google::Protobuf::Value.new string_value: obj
+          when TrueClass
+            Google::Protobuf::Value.new bool_value: true
+          when FalseClass
+            Google::Protobuf::Value.new bool_value: false
+          when Hash
             Google::Protobuf::Value.new struct_value: hash_to_struct(obj)
-          when Array then
+          when Array
             Google::Protobuf::Value.new list_value: array_to_list(obj)
           else
             # TODO: Could raise ArgumentError here, or convert to a string

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

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/logging/v2/credentials"
+require "google/cloud/logging/v2/logging_service/credentials"
 
 module Google
   module Cloud
@@ -37,7 +37,7 @@ module Google
       #
       #   logging.project_id #=> "my-project"
       #
-      class Credentials < Google::Cloud::Logging::V2::Credentials
+      class Credentials < Google::Cloud::Logging::V2::LoggingService::Credentials
       end
     end
   end

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

@@ -422,9 +422,9 @@ module Google
         end
 
         ##
-        # @private Exports the Entry to a Google::Logging::V2::LogEntry object.
+        # @private Exports the Entry to a Google::Cloud::Logging::V2::LogEntry object.
         def to_grpc
-          grpc = Google::Logging::V2::LogEntry.new(
+          grpc = Google::Cloud::Logging::V2::LogEntry.new(
             log_name:        log_name.to_s,
             timestamp:       timestamp_grpc,
             # TODO: verify severity is the correct type?
@@ -444,7 +444,7 @@ module Google
         end
 
         ##
-        # @private New Entry from a Google::Logging::V2::LogEntry object.
+        # @private New Entry from a Google::Cloud::Logging::V2::LogEntry object.
         def self.from_grpc grpc
           return new if grpc.nil?
           new.tap do |e|
@@ -483,7 +483,7 @@ module Google
 
         ##
         # @private Formats the labels so they can be saved to a
-        # Google::Logging::V2::LogEntry object.
+        # Google::Cloud::Logging::V2::LogEntry object.
         def labels_grpc
           return {} if labels.nil?
           # Coerce symbols to strings
@@ -494,7 +494,7 @@ module Google
         end
 
         ##
-        # @private Adds the payload data to a Google::Logging::V2::LogEntry
+        # @private Adds the payload data to a Google::Cloud::Logging::V2::LogEntry
         # object.
         def append_payload grpc
           grpc.proto_payload = nil

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

@@ -27,7 +27,8 @@ module Google
         class HttpRequest
           ##
           # @private Create an empty HttpRequest object.
-          def initialize; end
+          def initialize
+          end
 
           ##
           # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
@@ -125,10 +126,10 @@ module Google
 
           ##
           # @private Exports the HttpRequest to a
-          # Google::Logging::Type::HttpRequest object.
+          # Google::Cloud::Logging::Type::HttpRequest object.
           def to_grpc
             return nil if empty?
-            Google::Logging::Type::HttpRequest.new(
+            Google::Cloud::Logging::Type::HttpRequest.new(
               request_method:                     request_method.to_s,
               request_url:                        url.to_s,
               request_size:                       size.to_i,
@@ -143,7 +144,7 @@ module Google
           end
 
           ##
-          # @private New HttpRequest from a Google::Logging::Type::HttpRequest
+          # @private New HttpRequest from a Google::Cloud::Logging::Type::HttpRequest
           # object.
           def self.from_grpc grpc
             return new if grpc.nil?

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

@@ -126,17 +126,17 @@ module Google
           #     puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
           #   end
           #
-          def all request_limit: nil
+          def all request_limit: nil, &block
             request_limit = request_limit.to_i if request_limit
             unless block_given?
               return enum_for :all, request_limit: request_limit
             end
             results = self
             loop do
-              results.each { |r| yield r }
+              results.each(&block)
               if request_limit
                 request_limit -= 1
-                break if request_limit < 0
+                break if request_limit.negative?
               end
               break unless results.next?
               results = results.next
@@ -145,7 +145,7 @@ module Google
 
           ##
           # @private New Entry::List from a
-          # Google::Logging::V2::ListLogEntryResponse object.
+          # Google::Cloud::Logging::V2::ListLogEntryResponse object.
           def self.from_grpc grpc_list, service, resources: nil, filter: nil,
                              order: nil, max: nil, projects: nil
             entries = new(Array(grpc_list.entries).map do |grpc_entry|

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

@@ -28,7 +28,8 @@ module Google
         class Operation
           ##
           # @private Create an empty Operation object.
-          def initialize; end
+          def initialize
+          end
 
           ##
           # An arbitrary operation identifier. Log entries with the same
@@ -61,10 +62,10 @@ module Google
 
           ##
           # @private Exports the Operation to a
-          # Google::Logging::V2::LogEntryOperation object.
+          # Google::Cloud::Logging::V2::LogEntryOperation object.
           def to_grpc
             return nil if empty?
-            Google::Logging::V2::LogEntryOperation.new(
+            Google::Cloud::Logging::V2::LogEntryOperation.new(
               id:       id.to_s,
               producer: producer.to_s,
               first:    !(!first),
@@ -74,7 +75,7 @@ module Google
 
           ##
           # @private New Google::Cloud::Logging::Entry::Operation from a
-          # Google::Logging::V2::LogEntryOperation object.
+          # Google::Cloud::Logging::V2::LogEntryOperation object.
           def self.from_grpc grpc
             return new if grpc.nil?
             new.tap do |o|