google-cloud-logging-v2 0.2.0 → 0.5.1

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

@@ -90,17 +90,17 @@ module Google
             # @return [::String]
             def log_path **args
               resources = {
-                "log:project"         => (proc do |project:, log:|
+                "log:project" => (proc do |project:, log:|
                   raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
 
                   "projects/#{project}/logs/#{log}"
                 end),
-                "log:organization"    => (proc do |organization:, log:|
+                "log:organization" => (proc do |organization:, log:|
                   raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
 
                   "organizations/#{organization}/logs/#{log}"
                 end),
-                "folder:log"          => (proc do |folder:, log:|
+                "folder:log" => (proc do |folder:, log:|
                   raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
 
                   "folders/#{folder}/logs/#{log}"

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

@@ -60,7 +60,7 @@ module Google
                 parent_config = while namespace.any?
                                   parent_name = namespace.join "::"
                                   parent_const = const_get parent_name
-                                  break parent_const.configure if parent_const&.respond_to? :configure
+                                  break parent_const.configure if parent_const.respond_to? :configure
                                   namespace.pop
                                 end
                 default_config = Client::Configuration.new parent_config
@@ -68,17 +68,17 @@ module Google
                 default_config.rpcs.list_log_metrics.timeout = 60.0
                 default_config.rpcs.list_log_metrics.retry_policy = {
                   initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [4, 13, 14]
+              max_delay: 60.0,
+              multiplier: 1.3,
+              retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.get_log_metric.timeout = 60.0
                 default_config.rpcs.get_log_metric.retry_policy = {
                   initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [4, 13, 14]
+              max_delay: 60.0,
+              multiplier: 1.3,
+              retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.create_log_metric.timeout = 60.0
@@ -86,17 +86,17 @@ module Google
                 default_config.rpcs.update_log_metric.timeout = 60.0
                 default_config.rpcs.update_log_metric.retry_policy = {
                   initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [4, 13, 14]
+              max_delay: 60.0,
+              multiplier: 1.3,
+              retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.delete_log_metric.timeout = 60.0
                 default_config.rpcs.delete_log_metric.retry_policy = {
                   initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [4, 13, 14]
+              max_delay: 60.0,
+              multiplier: 1.3,
+              retry_codes: [4, 13, 14]
                 }
 
                 default_config
@@ -160,7 +160,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              credentials ||= Credentials.default scope: @config.scope
+              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # but only if the default endpoint does not have a region prefix.
+              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                       @config.endpoint == Client.configure.endpoint &&
+                                       !@config.endpoint.split(".").first.include?("-")
+              credentials ||= Credentials.default scope: @config.scope,
+                                                  enable_self_signed_jwt: enable_self_signed_jwt
               if credentials.is_a?(String) || credentials.is_a?(Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
@@ -631,7 +637,7 @@ module Google
               config_attr :scope,         nil, ::String, ::Array, nil
               config_attr :lib_name,      nil, ::String, nil
               config_attr :lib_version,   nil, ::String, nil
-              config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
               config_attr :interceptors,  nil, ::Array, nil
               config_attr :timeout,       nil, ::Numeric, nil
               config_attr :metadata,      nil, ::Hash, nil
@@ -652,7 +658,7 @@ module Google
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
-                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                   Rpcs.new parent_rpcs
                 end
               end
@@ -664,7 +670,7 @@ module Google
               # Each configuration object is of type `Gapic::Config::Method` and includes
               # the following configuration fields:
               #
-              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
               #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
               #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
               #     include the following keys:
@@ -703,15 +709,15 @@ module Google
 
                 # @private
                 def initialize parent_rpcs = nil
-                  list_log_metrics_config = parent_rpcs&.list_log_metrics if parent_rpcs&.respond_to? :list_log_metrics
+                  list_log_metrics_config = parent_rpcs.list_log_metrics if parent_rpcs.respond_to? :list_log_metrics
                   @list_log_metrics = ::Gapic::Config::Method.new list_log_metrics_config
-                  get_log_metric_config = parent_rpcs&.get_log_metric if parent_rpcs&.respond_to? :get_log_metric
+                  get_log_metric_config = parent_rpcs.get_log_metric if parent_rpcs.respond_to? :get_log_metric
                   @get_log_metric = ::Gapic::Config::Method.new get_log_metric_config
-                  create_log_metric_config = parent_rpcs&.create_log_metric if parent_rpcs&.respond_to? :create_log_metric
+                  create_log_metric_config = parent_rpcs.create_log_metric if parent_rpcs.respond_to? :create_log_metric
                   @create_log_metric = ::Gapic::Config::Method.new create_log_metric_config
-                  update_log_metric_config = parent_rpcs&.update_log_metric if parent_rpcs&.respond_to? :update_log_metric
+                  update_log_metric_config = parent_rpcs.update_log_metric if parent_rpcs.respond_to? :update_log_metric
                   @update_log_metric = ::Gapic::Config::Method.new update_log_metric_config
-                  delete_log_metric_config = parent_rpcs&.delete_log_metric if parent_rpcs&.respond_to? :delete_log_metric
+                  delete_log_metric_config = parent_rpcs.delete_log_metric if parent_rpcs.respond_to? :delete_log_metric
                   @delete_log_metric = ::Gapic::Config::Method.new delete_log_metric_config
 
                   yield self if block_given?

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.5.1"
       end
     end
   end

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

@@ -27,7 +27,7 @@ module Google
           # Service for configuring sinks used to route log entries.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

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

@@ -27,7 +27,7 @@ module Google
           # Service for configuring logs-based metrics.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

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

@@ -27,7 +27,7 @@ module Google
           # Service for ingesting and querying logs.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode
@@ -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/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

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

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/timestamp.rb

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-logging-v2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +157,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: The Cloud Logging API lets you programmatically read and write log entries,
-  set up exclusions, create logs-based metrics, and manage export sinks.
+  set up exclusions, create logs-based metrics, and manage export sinks. Note that
+  google-cloud-logging-v2 is a version-specific client library. For most uses, we
+  recommend installing the main client library google-cloud-logging instead. See the
+  readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -217,14 +226,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Logging V2 API