google-cloud-logging 0.24.0 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b21d81a8dd0345896f6d8614d0fe7cdfe13eb1d4
-  data.tar.gz: 376e833691d63e7f868b959c21ac8907ea872d4a
+  metadata.gz: 1f29d7704de59cbe83e205aea50a6fe55b60ec46
+  data.tar.gz: c8875c7e34998704478b0bd3816ccb1d51509ad7
 SHA512:
-  metadata.gz: 7c76269efa35b6ac9dcb63e9020bde529907a0c01b894016e9c315dea259d30eae2310b1e402b4f77175898ae9b38aa0139ec92d82bf2c5d966d46d28fc3c83e
-  data.tar.gz: 44157406a87996ac911cc0b1fb22a1e41d2ba9aa06b8ed642c015b4cc8aa22dbfb3752b7299c8146b87522f00d94b20e44620b8e0ab4b2a19d011222ddd96f08
+  metadata.gz: 742fcd4d417677dcb457a7947032e07103b0f01e5b316229a9c4baed266a0c3135cf11fe530c29a7d71efe240a687bf99b86de389a7a78ed2f6efabebd5c12c8
+  data.tar.gz: 43ea0ca38d5518f1af9bc1be4ece7cb4b483f08407ec95e1ebd704ae5ed690e0e04091b679c044621d991bf7354df3d7ec802aa3a4fe5907e01166084f44eb17

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

@@ -14,7 +14,6 @@
 
 
 require "logger"
-require "orderedhash"
 
 module Google
   module Cloud
@@ -90,7 +89,7 @@ module Google
         end
 
         ##
-        # A OrderedHash of Thread IDs to Stackdriver request trace ID. The
+        # A Hash of Thread IDs to Stackdriver request trace ID. The
         # Stackdriver trace ID is a shared request identifier across all
         # Stackdriver services.
         #
@@ -142,7 +141,7 @@ module Google
           @resource = resource
           @labels = labels
           @level = 0 # DEBUG is the default behavior
-          @request_info = OrderedHash.new
+          @request_info = {}
           @closed = false
           # Unused, but present for API compatibility
           @formatter = ::Logger::Formatter.new

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

@@ -58,8 +58,8 @@ module Google
               channel: channel,
               timeout: timeout,
               client_config: client_config,
-              app_name: "gcloud-ruby",
-              app_version: Google::Cloud::Logging::VERSION)
+              lib_name: "gccl",
+              lib_version: Google::Cloud::Logging::VERSION)
         end
         attr_accessor :mocked_logging
 
@@ -71,8 +71,8 @@ module Google
               channel: channel,
               timeout: timeout,
               client_config: client_config,
-              app_name: "gcloud-ruby",
-              app_version: Google::Cloud::Logging::VERSION)
+              lib_name: "gccl",
+              lib_version: Google::Cloud::Logging::VERSION)
         end
         attr_accessor :mocked_sinks
 
@@ -84,8 +84,8 @@ module Google
               channel: channel,
               timeout: timeout,
               client_config: client_config,
-              app_name: "gcloud-ruby",
-              app_version: Google::Cloud::Logging::VERSION)
+              lib_name: "gccl",
+              lib_version: Google::Cloud::Logging::VERSION)
         end
         attr_accessor :mocked_metrics
 

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

@@ -46,8 +46,6 @@ module Google
           # The default port of the service.
           DEFAULT_SERVICE_PORT = 443
 
-          CODE_GEN_NAME_VERSION = "gapic/0.1.0".freeze
-
           DEFAULT_TIMEOUT = 30
 
           PAGE_DESCRIPTORS = {
@@ -137,10 +135,6 @@ module Google
           #   or the specified config is missing data points.
           # @param timeout [Numeric]
           #   The default timeout, in seconds, for calls made through this client.
-          # @param app_name [String]
-          #   The codename of the calling service.
-          # @param app_version [String]
-          #   The version of the calling service.
           def initialize \
               service_path: SERVICE_ADDRESS,
               port: DEFAULT_SERVICE_PORT,
@@ -149,8 +143,10 @@ module Google
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
-              app_name: "gax",
-              app_version: Google::Gax::VERSION
+              app_name: nil,
+              app_version: nil,
+              lib_name: nil,
+              lib_version: ""
             # These require statements are intentionally placed here to initialize
             # the gRPC module only when it's required.
             # See https://github.com/googleapis/toolkit/issues/446
@@ -158,9 +154,16 @@ module Google
             require "google/logging/v2/logging_config_services_pb"
 
 
-            google_api_client = "#{app_name}/#{app_version} " \
-              "#{CODE_GEN_NAME_VERSION} gax/#{Google::Gax::VERSION} " \
-              "ruby/#{RUBY_VERSION}".freeze
+            if app_name || app_version
+              warn "`app_name` and `app_version` are no longer being used in the request headers."
+            end
+
+            google_api_client = "gl-ruby/#{RUBY_VERSION}"
+            google_api_client << " #{lib_name}/#{lib_version}" if lib_name
+            google_api_client << " gapic/ gax/#{Google::Gax::VERSION}"
+            google_api_client << " grpc/#{GRPC::VERSION}"
+            google_api_client.freeze
+
             headers = { :"x-goog-api-client" => google_api_client }
             client_config_file = Pathname.new(__dir__).join(
               "config_service_v2_client_config.json"
@@ -213,10 +216,8 @@ module Google
           # Lists sinks.
           #
           # @param parent [String]
-          #   Required. The resource name where this sink was created:
-          #
-          #       "projects/[PROJECT_ID]"
-          #       "organizations/[ORGANIZATION_ID]"
+          #   Required. The parent resource whose sinks are to be listed.
+          #   Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
           # @param page_size [Integer]
           #   The maximum number of resources contained in the underlying API
           #   response. If page streaming is performed per-resource, this
@@ -267,10 +268,12 @@ module Google
           # Gets a sink.
           #
           # @param sink_name [String]
-          #   Required. The resource name of the sink to return:
+          #   Required. The parent resource name of the sink:
           #
           #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
           #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
+          #
+          #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -294,22 +297,34 @@ module Google
             @get_sink.call(req, options)
           end
 
-          # Creates a sink.
+          # Creates a sink that exports specified log entries to a destination.  The
+          # export of newly-ingested log entries begins immediately, unless the current
+          # time is outside the sink's start and end times or the sink's
+          # +writer_identity+ is not permitted to write to the destination.  A sink can
+          # export log entries only from the resource owning the sink.
           #
           # @param parent [String]
           #   Required. The resource in which to create the sink:
           #
           #       "projects/[PROJECT_ID]"
           #       "organizations/[ORGANIZATION_ID]"
+          #
+          #   Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
           # @param sink [Google::Logging::V2::LogSink]
           #   Required. The new sink, whose +name+ parameter is a sink identifier that
           #   is not already in use.
           # @param unique_writer_identity [true, false]
-          #   Optional. Whether the sink will have a dedicated service account returned
-          #   in the sink's writer_identity. Set this field to be true to export
-          #   logs from one project to a different project. This field is ignored for
-          #   non-project sinks (e.g. organization sinks) because those sinks are
-          #   required to have dedicated service accounts.
+          #   Optional. Determines the kind of IAM identity returned as +writer_identity+
+          #   in the new sink.  If this value is omitted or set to false, and if the
+          #   sink's parent is a project, then the value returned as +writer_identity+ is
+          #   +cloud-logs@google.com+, the same identity used before the addition of
+          #   writer identities to this API. The sink's destination must be in the same
+          #   project as the sink itself.
+          #
+          #   If this field is set to true, or if the sink is owned by a non-project
+          #   resource such as an organization, then the value of +writer_identity+ will
+          #   be a unique service account used only for exports from the new sink.  For
+          #   more information, see +writer_identity+ in LogSink.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -339,11 +354,18 @@ module Google
             @create_sink.call(req, options)
           end
 
-          # Updates or creates a sink.
+          # Updates a sink. If the named sink doesn't exist, then this method is
+          # identical to
+          # {sinks.create}[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create].
+          # If the named sink does exist, then this method replaces the following
+          # fields in the existing sink with values from the new sink: +destination+,
+          # +filter+, +output_version_format+, +start_time+, and +end_time+.
+          # The updated filter might also have a new +writer_identity+; see the
+          # +unique_writer_identity+ field.
           #
           # @param sink_name [String]
-          #   Required. The resource name of the sink to update, including the parent
-          #   resource and the sink identifier:
+          #   Required. The full resource name of the sink to update, including the
+          #   parent resource and the sink identifier:
           #
           #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
           #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
@@ -351,14 +373,20 @@ module Google
           #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
           # @param sink [Google::Logging::V2::LogSink]
           #   Required. The updated sink, whose name is the same identifier that appears
-          #   as part of +sinkName+.  If +sinkName+ does not exist, then
+          #   as part of +sink_name+.  If +sink_name+ does not exist, then
           #   this method creates a new sink.
           # @param unique_writer_identity [true, false]
-          #   Optional. Whether the sink will have a dedicated service account returned
-          #   in the sink's writer_identity. Set this field to be true to export
-          #   logs from one project to a different project. This field is ignored for
-          #   non-project sinks (e.g. organization sinks) because those sinks are
-          #   required to have dedicated service accounts.
+          #   Optional. See
+          #   {sinks.create}[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create]
+          #   for a description of this field.  When updating a sink, the effect of this
+          #   field on the value of +writer_identity+ in the updated sink depends on both
+          #   the old and new values of this field:
+          #
+          #   +   If the old and new values of this field are both false or both true,
+          #       then there is no change to the sink's +writer_identity+.
+          #   +   If the old value was false and the new value is true, then
+          #       +writer_identity+ is changed to a unique service account.
+          #   +   It is an error if the old value was true and the new value is false.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -388,16 +416,19 @@ module Google
             @update_sink.call(req, options)
           end
 
-          # Deletes a sink.
+          # Deletes a sink. If the sink has a unique +writer_identity+, then that
+          # service account is also deleted.
           #
           # @param sink_name [String]
-          #   Required. The resource name of the sink to delete, including the parent
-          #   resource and the sink identifier:
+          #   Required. The full resource name of the sink to delete, including the
+          #   parent resource and the sink identifier:
           #
           #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
           #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
           #
-          #   It is an error if the sink does not exist.
+          #   It is an error if the sink does not exist.  Example:
+          #   +"projects/my-project-id/sinks/my-sink-id"+.  It is an error if
+          #   the sink does not exist.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.

data/lib/google/cloud/logging/v2/config_service_v2_client_config.json

@@ -2,11 +2,11 @@
   "interfaces": {
     "google.logging.v2.ConfigServiceV2": {
       "retry_codes": {
-          "idempotent": [
-            "DEADLINE_EXCEEDED",
-            "UNAVAILABLE"
-          ],
-          "non_idempotent": []
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

data/lib/google/cloud/logging/v2/doc/google/api/label.rb

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2017, Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# http://www.apache.org/licenses/LICENSE-2.0
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

data/lib/google/cloud/logging/v2/doc/google/api/monitored_resource.rb

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2017, Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# http://www.apache.org/licenses/LICENSE-2.0
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

data/lib/google/cloud/logging/v2/doc/google/logging/type/http_request.rb

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2017, Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# http://www.apache.org/licenses/LICENSE-2.0
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

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

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2017, Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# http://www.apache.org/licenses/LICENSE-2.0
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -79,6 +79,16 @@ module Google
       #   @return [Google::Logging::V2::LogEntryOperation]
       #     Optional. Information about an operation associated with the log entry, if
       #     applicable.
+      # @!attribute [rw] trace
+      #   @return [String]
+      #     Optional. Resource name of the trace associated with the log entry, if any.
+      #     If it contains a relative resource name, the name is assumed to be relative
+      #     to +//tracing.googleapis.com+. Example:
+      #     +projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824+
+      # @!attribute [rw] source_location
+      #   @return [Google::Logging::V2::LogEntrySourceLocation]
+      #     Optional. Source code location information associated with the log entry,
+      #     if any.
       class LogEntry; end
 
       # Additional information about a potentially long-running operation with which
@@ -99,6 +109,26 @@ module Google
       #   @return [true, false]
       #     Optional. Set this to True if this is the last log entry in the operation.
       class LogEntryOperation; end
+
+      # Additional information about the source code location that produced the log
+      # entry.
+      # @!attribute [rw] file
+      #   @return [String]
+      #     Optional. Source file name. Depending on the runtime environment, this
+      #     might be a simple name or a fully-qualified name.
+      # @!attribute [rw] line
+      #   @return [Integer]
+      #     Optional. Line within the source file. 1-based; 0 indicates no line number
+      #     available.
+      # @!attribute [rw] function
+      #   @return [String]
+      #     Optional. Human-readable name of the function or method being invoked, with
+      #     optional context such as the class or package name. This information may be
+      #     used in contexts such as the logs viewer, where a file and line number are
+      #     less meaningful. The format can vary by language. For example:
+      #     +qual.if.ied.Class.method+ (Java), +dir/package.func+ (Go), +function+
+      #     (Python).
+      class LogEntrySourceLocation; end
     end
   end
 end

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

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2017, Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# http://www.apache.org/licenses/LICENSE-2.0
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -87,14 +87,14 @@ module Google
       # The parameters to +ListLogEntries+.
       # @!attribute [rw] project_ids
       #   @return [Array<String>]
-      #     Deprecated. One or more project identifiers or project numbers from which
-      #     to retrieve log entries.  Example: +"my-project-1A"+. If
-      #     present, these project identifiers are converted to resource format and
-      #     added to the list of resources in +resourceNames+. Callers should use
-      #     +resourceNames+ rather than this parameter.
+      #     Deprecated. Use +resource_names+ instead.  One or more project identifiers
+      #     or project numbers from which to retrieve log entries.  Example:
+      #     +"my-project-1A"+. If present, these project identifiers are converted to
+      #     resource name format and added to the list of resources in
+      #     +resource_names+.
       # @!attribute [rw] resource_names
       #   @return [Array<String>]
-      #     Required. One or more cloud resources from which to retrieve log
+      #     Required. Names of one or more resources from which to retrieve log
       #     entries:
       #
       #         "projects/[PROJECT_ID]"
@@ -105,7 +105,10 @@ module Google
       #   @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.
+      #     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 listed in +resource_names+ will cause the filter to return no
+      #     results.
       #     The maximum length of the filter is 20000 characters.
       # @!attribute [rw] order_by
       #   @return [String]
@@ -134,9 +137,16 @@ module Google
       #     A list of log entries.
       # @!attribute [rw] next_page_token
       #   @return [String]
-      #     If there might be more results than appear in this response, then
+      #     If there might be more results than those appearing in this response, then
       #     +nextPageToken+ is included.  To get the next set of results, call this
       #     method again using the value of +nextPageToken+ as +pageToken+.
+      #
+      #     If a value for +next_page_token+ appears and the +entries+ field is empty,
+      #     it means that the search found no log entries so far but it did not have
+      #     time to search all the possible log entries.  Retry the method with this
+      #     value for +page_token+ to continue the search.  Alternatively, consider
+      #     speeding up the search by changing your filter to specify a single log name
+      #     or resource type, or to narrow the time range of the search.
       class ListLogEntriesResponse; end
 
       # The parameters to ListMonitoredResourceDescriptors
@@ -159,10 +169,43 @@ module Google
       #     A list of resource descriptors.
       # @!attribute [rw] next_page_token
       #   @return [String]
-      #     If there might be more results than appear in this response, then
+      #     If there might be more results than those appearing in this response, then
       #     +nextPageToken+ is included.  To get the next set of results, call this
       #     method again using the value of +nextPageToken+ as +pageToken+.
       class ListMonitoredResourceDescriptorsResponse; end
+
+      # The parameters to ListLogs.
+      # @!attribute [rw] parent
+      #   @return [String]
+      #     Required. The resource name that owns the logs:
+      #
+      #         "projects/[PROJECT_ID]"
+      #         "organizations/[ORGANIZATION_ID]"
+      # @!attribute [rw] page_size
+      #   @return [Integer]
+      #     Optional. The maximum number of results to return from this request.
+      #     Non-positive values are ignored.  The presence of +nextPageToken+ in the
+      #     response indicates that more results might be available.
+      # @!attribute [rw] page_token
+      #   @return [String]
+      #     Optional. If present, then retrieve the next batch of results from the
+      #     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.
+      class ListLogsRequest; end
+
+      # Result returned from ListLogs.
+      # @!attribute [rw] log_names
+      #   @return [Array<String>]
+      #     A list of log names. For example,
+      #     +"projects/my-project/syslog"+ or
+      #     +"organizations/123/cloudresourcemanager.googleapis.com%2Factivity"+.
+      # @!attribute [rw] next_page_token
+      #   @return [String]
+      #     If there might be more results than those appearing in this response, then
+      #     +nextPageToken+ is included.  To get the next set of results, call this
+      #     method again using the value of +nextPageToken+ as +pageToken+.
+      class ListLogsResponse; end
     end
   end
 end