google-cloud-logging-v2 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a5b18c47d9df6eaf0d43a4f89ea4eec3ac43db7c5d3d9d859fac76616f02c7c
-  data.tar.gz: c920287b91f5d4504001bc968a6fedd1015f77aee4b48e7f9b63d566e4495676
+  metadata.gz: 1ce53e2503c512bc545694449e4238761c2dd4bf041533908147a00f5f3519f6
+  data.tar.gz: bfd9c950f2714023d5cca41896271b5108cca0cedc45ef28475a3084b6773001
 SHA512:
-  metadata.gz: 0bbde3376f1a65bf40cbdf8ac94b70a848d370176ad7c0e987c873a62dbdd3c43d8bd6d97ee835ef008d8022905822f8a0682cd577c03a18752aeee552ab1cbe
-  data.tar.gz: a7d3bfd943e9ab7df3858d8dd0e92b7fd178ec6542c1f15e0a00da9c2765a88edbd7d2bd843741b20f8694c6068e1b6d109a4ee8c64ad971d436048993239bd9
+  metadata.gz: 69c21ca6f0b6b1bd86581cdf2ac5667dcbdb1ef48916e1a92fd55bd0c9691633e82bb45cce08fb0aa2d02075edb9400b7fb1a1050a68cf70f52a15da32dbed04
+  data.tar.gz: 3facb8a86a51a6fcb7fbbabc202f6a9df9718bff690bfb3f65fbf863912dbfc8bd21a135fb81928fc67f4adf574d781e11edbca62be12a7191728fa870e6bcdb

data/lib/google/cloud/logging/v2/logging_service/client.rb

@@ -105,6 +105,14 @@ module Google
                   retry_codes:   [4, 13, 14]
                 }
 
+                default_config.rpcs.tail_log_entries.timeout = 3600.0
+                default_config.rpcs.tail_log_entries.retry_policy = {
+                  initial_delay: 0.1,
+                  max_delay:     60.0,
+                  multiplier:    1.3,
+                  retry_codes:   [4, 13, 14]
+                }
+
                 default_config
               end
               yield @configure if block_given?
@@ -425,6 +433,11 @@ module Google
             #         "billingAccounts/[BILLING_ACCOUNT_ID]"
             #         "folders/[FOLDER_ID]"
             #
+            #     May alternatively be one or more views
+            #       projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+            #       organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+            #       billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+            #       folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
             #
             #     Projects listed in the `project_ids` field are added to this list.
             #   @param filter [::String]
@@ -575,7 +588,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_logs(parent: nil, page_size: nil, page_token: nil)
+            # @overload list_logs(parent: nil, page_size: nil, page_token: nil, resource_names: nil)
             #   Pass arguments to `list_logs` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -596,6 +609,18 @@ module Google
             #     preceding call to this method.  `pageToken` must be the value of
             #     `nextPageToken` from the previous response.  The values of other method
             #     parameters should be identical to those in the previous call.
+            #   @param resource_names [::Array<::String>]
+            #     Optional. The resource name that owns the logs:
+            #       projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+            #       organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+            #       billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+            #       folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+            #
+            #     To support legacy queries, it could also be:
+            #         "projects/[PROJECT_ID]"
+            #         "organizations/[ORGANIZATION_ID]"
+            #         "billingAccounts/[BILLING_ACCOUNT_ID]"
+            #         "folders/[FOLDER_ID]"
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Logging::V2::ListLogsResponse]
@@ -642,6 +667,59 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Streaming read of log entries as they are ingested. Until the stream is
+            # terminated, it will continue reading logs.
+            #
+            # @param request [::Gapic::StreamInput, ::Enumerable<::Google::Cloud::Logging::V2::TailLogEntriesRequest, ::Hash>]
+            #   An enumerable of {::Google::Cloud::Logging::V2::TailLogEntriesRequest} instances.
+            # @param options [::Gapic::CallOptions, ::Hash]
+            #   Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Enumerable<::Google::Cloud::Logging::V2::TailLogEntriesResponse>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Enumerable<::Google::Cloud::Logging::V2::TailLogEntriesResponse>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def tail_log_entries request, options = nil
+              unless request.is_a? ::Enumerable
+                raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
+                request = request.to_enum
+              end
+
+              request = request.lazy.map do |req|
+                ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::Logging::V2::TailLogEntriesRequest
+              end
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.tail_log_entries.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Logging::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              options.apply_defaults timeout:      @config.rpcs.tail_log_entries.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.tail_log_entries.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @logging_service_stub.call_rpc :tail_log_entries, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the LoggingService API.
             #
@@ -803,6 +881,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :list_logs
+                ##
+                # RPC-specific configuration for `tail_log_entries`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :tail_log_entries
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -816,6 +899,8 @@ module Google
                   @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
                   list_logs_config = parent_rpcs&.list_logs if parent_rpcs&.respond_to? :list_logs
                   @list_logs = ::Gapic::Config::Method.new list_logs_config
+                  tail_log_entries_config = parent_rpcs&.tail_log_entries if parent_rpcs&.respond_to? :tail_log_entries
+                  @tail_log_entries = ::Gapic::Config::Method.new tail_log_entries_config
 
                   yield self if block_given?
                 end

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Logging
       module V2
-        VERSION = "0.2.0"
+        VERSION = "0.3.0"
       end
     end
   end

data/lib/google/logging/v2/logging_pb.rb

@@ -56,11 +56,30 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :parent, :string, 1
       optional :page_size, :int32, 2
       optional :page_token, :string, 3
+      repeated :resource_names, :string, 8
     end
     add_message "google.logging.v2.ListLogsResponse" do
       repeated :log_names, :string, 3
       optional :next_page_token, :string, 2
     end
+    add_message "google.logging.v2.TailLogEntriesRequest" do
+      repeated :resource_names, :string, 1
+      optional :filter, :string, 2
+      optional :buffer_window, :message, 3, "google.protobuf.Duration"
+    end
+    add_message "google.logging.v2.TailLogEntriesResponse" do
+      repeated :entries, :message, 1, "google.logging.v2.LogEntry"
+      repeated :suppression_info, :message, 2, "google.logging.v2.TailLogEntriesResponse.SuppressionInfo"
+    end
+    add_message "google.logging.v2.TailLogEntriesResponse.SuppressionInfo" do
+      optional :reason, :enum, 1, "google.logging.v2.TailLogEntriesResponse.SuppressionInfo.Reason"
+      optional :suppressed_count, :int32, 2
+    end
+    add_enum "google.logging.v2.TailLogEntriesResponse.SuppressionInfo.Reason" do
+      value :REASON_UNSPECIFIED, 0
+      value :RATE_LIMIT, 1
+      value :NOT_CONSUMED, 2
+    end
   end
 end
 
@@ -78,6 +97,10 @@ module Google
         ListMonitoredResourceDescriptorsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListMonitoredResourceDescriptorsResponse").msgclass
         ListLogsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogsRequest").msgclass
         ListLogsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogsResponse").msgclass
+        TailLogEntriesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.TailLogEntriesRequest").msgclass
+        TailLogEntriesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.TailLogEntriesResponse").msgclass
+        TailLogEntriesResponse::SuppressionInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.TailLogEntriesResponse.SuppressionInfo").msgclass
+        TailLogEntriesResponse::SuppressionInfo::Reason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.TailLogEntriesResponse.SuppressionInfo.Reason").enummodule
       end
     end
   end

data/lib/google/logging/v2/logging_services_pb.rb

@@ -56,6 +56,9 @@ module Google
             # Lists the logs in projects, organizations, folders, or billing accounts.
             # Only logs that have entries are listed.
             rpc :ListLogs, ::Google::Cloud::Logging::V2::ListLogsRequest, ::Google::Cloud::Logging::V2::ListLogsResponse
+            # Streaming read of log entries as they are ingested. Until the stream is
+            # terminated, it will continue reading logs.
+            rpc :TailLogEntries, stream(::Google::Cloud::Logging::V2::TailLogEntriesRequest), stream(::Google::Cloud::Logging::V2::TailLogEntriesResponse)
           end
 
           Stub = Service.rpc_stub_class

data/proto_docs/google/logging/v2/logging.rb

@@ -169,6 +169,11 @@ module Google
         #         "billingAccounts/[BILLING_ACCOUNT_ID]"
         #         "folders/[FOLDER_ID]"
         #
+        #     May alternatively be one or more views
+        #       projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+        #       organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+        #       billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+        #       folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
         #
         #     Projects listed in the `project_ids` field are added to this list.
         # @!attribute [rw] filter
@@ -279,6 +284,19 @@ module Google
         #     preceding call to this method.  `pageToken` must be the value of
         #     `nextPageToken` from the previous response.  The values of other method
         #     parameters should be identical to those in the previous call.
+        # @!attribute [rw] resource_names
+        #   @return [::Array<::String>]
+        #     Optional. The resource name that owns the logs:
+        #       projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+        #       organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+        #       billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+        #       folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+        #
+        #     To support legacy queries, it could also be:
+        #         "projects/[PROJECT_ID]"
+        #         "organizations/[ORGANIZATION_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]"
+        #         "folders/[FOLDER_ID]"
         class ListLogsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -299,6 +317,87 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # The parameters to `TailLogEntries`.
+        # @!attribute [rw] resource_names
+        #   @return [::Array<::String>]
+        #     Required. Name of a parent resource from which to retrieve log entries:
+        #
+        #         "projects/[PROJECT_ID]"
+        #         "organizations/[ORGANIZATION_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]"
+        #         "folders/[FOLDER_ID]"
+        #
+        #     May alternatively be one or more views:
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
+        #         "organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
+        #         "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A filter that chooses which log entries to return.  See [Advanced
+        #     Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
+        #     Only log entries that match the filter are returned.  An empty filter
+        #     matches all log entries in the resources listed in `resource_names`.
+        #     Referencing a parent resource that is not in `resource_names` will cause
+        #     the filter to return no results. The maximum length of the filter is 20000
+        #     characters.
+        # @!attribute [rw] buffer_window
+        #   @return [::Google::Protobuf::Duration]
+        #     Optional. The amount of time to buffer log entries at the server before
+        #     being returned to prevent out of order results due to late arriving log
+        #     entries. Valid values are between 0-60000 milliseconds. Defaults to 2000
+        #     milliseconds.
+        class TailLogEntriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Result returned from `TailLogEntries`.
+        # @!attribute [rw] entries
+        #   @return [::Array<::Google::Cloud::Logging::V2::LogEntry>]
+        #     A list of log entries. Each response in the stream will order entries with
+        #     increasing values of `LogEntry.timestamp`. Ordering is not guaranteed
+        #     between separate responses.
+        # @!attribute [rw] suppression_info
+        #   @return [::Array<::Google::Cloud::Logging::V2::TailLogEntriesResponse::SuppressionInfo>]
+        #     If entries that otherwise would have been included in the session were not
+        #     sent back to the client, counts of relevant entries omitted from the
+        #     session with the reason that they were not included. There will be at most
+        #     one of each reason per response. The counts represent the number of
+        #     suppressed entries since the last streamed response.
+        class TailLogEntriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Information about entries that were omitted from the session.
+          # @!attribute [rw] reason
+          #   @return [::Google::Cloud::Logging::V2::TailLogEntriesResponse::SuppressionInfo::Reason]
+          #     The reason that entries were omitted from the session.
+          # @!attribute [rw] suppressed_count
+          #   @return [::Integer]
+          #     A lower bound on the count of entries omitted due to `reason`.
+          class SuppressionInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # An indicator of why entries were omitted.
+            module Reason
+              # Unexpected default.
+              REASON_UNSPECIFIED = 0
+
+              # Indicates suppression occurred due to relevant entries being
+              # received in excess of rate limits. For quotas and limits, see
+              # [Logging API quotas and
+              # limits](https://cloud.google.com/logging/quotas#api-limits).
+              RATE_LIMIT = 1
+
+              # Indicates suppression occurred due to the client not consuming
+              # responses quickly enough.
+              NOT_CONSUMED = 2
+            end
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-logging-v2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common