google-cloud-logging 0.21.0 → 0.21.1

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

@@ -50,6 +50,10 @@ module Google
         config.google_cloud = ::ActiveSupport::OrderedOptions.new unless
           config.respond_to? :google_cloud
         config.google_cloud.logging = ::ActiveSupport::OrderedOptions.new
+        config.google_cloud.logging.monitored_resource =
+          ::ActiveSupport::OrderedOptions.new
+        config.google_cloud.logging.monitored_resource.labels =
+          ::ActiveSupport::OrderedOptions.new
 
         initializer "Stackdriver.Logging", before: :initialize_logger do |app|
           if self.class.use_logging? app.config
@@ -58,16 +62,17 @@ module Google
 
             project_id = log_config.project_id || gcp_config.project_id
             keyfile = log_config.keyfile || gcp_config.keyfile
+            resource_type = log_config.monitored_resource.type
+            resource_labels = log_config.monitored_resource.labels
 
             logging = Google::Cloud::Logging.new project: project_id,
                                                  keyfile: keyfile
             resource =
-              Google::Cloud::Logging::Middleware.build_monitoring_resource
+              Logging::Middleware.build_monitored_resource resource_type,
+                                                           resource_labels
             log_name = log_config.log_name || DEFAULT_LOG_NAME
 
-            app.config.logger = Google::Cloud::Logging::Logger.new logging,
-                                                                   log_name,
-                                                                   resource
+            app.config.logger = logging.logger log_name, resource
             app.middleware.insert_before Rails::Rack::Logger,
                                          Google::Cloud::Logging::Middleware,
                                          logger: app.config.logger
@@ -81,9 +86,10 @@ module Google
         # able to authenticate. Also either Rails needs to be in "production"
         # environment or config.stackdriver.use_logging is explicitly true.
         #
-        # @param config The Rails.application.config
+        # @param [Rails::Railtie::Configuration] config The
+        #   Rails.application.config
         #
-        # @return [Boolean]
+        # @return [Boolean] Whether to use Stackdriver Logging
         #
         def self.use_logging? config
           gcp_config = config.google_cloud

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

@@ -254,10 +254,10 @@ module Google
               parent,
               page_size: nil,
               options: nil
-            req = Google::Logging::V2::ListSinksRequest.new(
-              parent: parent
-            )
-            req.page_size = page_size unless page_size.nil?
+            req = Google::Logging::V2::ListSinksRequest.new({
+              parent: parent,
+              page_size: page_size
+            }.delete_if { |_, v| v.nil? })
             @list_sinks.call(req, options)
           end
 
@@ -283,9 +283,9 @@ module Google
           def get_sink \
               sink_name,
               options: nil
-            req = Google::Logging::V2::GetSinkRequest.new(
+            req = Google::Logging::V2::GetSinkRequest.new({
               sink_name: sink_name
-            )
+            }.delete_if { |_, v| v.nil? })
             @get_sink.call(req, options)
           end
 
@@ -318,10 +318,10 @@ module Google
               parent,
               sink,
               options: nil
-            req = Google::Logging::V2::CreateSinkRequest.new(
+            req = Google::Logging::V2::CreateSinkRequest.new({
               parent: parent,
               sink: sink
-            )
+            }.delete_if { |_, v| v.nil? })
             @create_sink.call(req, options)
           end
 
@@ -355,10 +355,10 @@ module Google
               sink_name,
               sink,
               options: nil
-            req = Google::Logging::V2::UpdateSinkRequest.new(
+            req = Google::Logging::V2::UpdateSinkRequest.new({
               sink_name: sink_name,
               sink: sink
-            )
+            }.delete_if { |_, v| v.nil? })
             @update_sink.call(req, options)
           end
 
@@ -385,9 +385,9 @@ module Google
           def delete_sink \
               sink_name,
               options: nil
-            req = Google::Logging::V2::DeleteSinkRequest.new(
+            req = Google::Logging::V2::DeleteSinkRequest.new({
               sink_name: sink_name
-            )
+            }.delete_if { |_, v| v.nil? })
             @delete_sink.call(req, options)
           end
         end

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

@@ -0,0 +1,81 @@
+# Copyright 2016 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
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Api
+    # An object that describes the schema of a MonitoredResource object using a
+    # type name and a set of labels.  For example, the monitored resource
+    # descriptor for Google Compute Engine VM instances has a type of
+    # +"gce_instance"+ and specifies the use of the labels +"instance_id"+ and
+    # +"zone"+ to identify particular VM instances.
+    #
+    # Different APIs can support different monitored resource types. APIs generally
+    # provide a +list+ method that returns the monitored resource descriptors used
+    # by the API.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     Optional. The resource name of the monitored resource descriptor:
+    #     +"projects/{project_id}/monitoredResourceDescriptors/{type}"+ where
+    #     {type} is the value of the +type+ field in this object and
+    #     {project_id} is a project ID that provides API-specific context for
+    #     accessing the type.  APIs that do not use project information can use the
+    #     resource name format +"monitoredResourceDescriptors/{type}"+.
+    # @!attribute [rw] type
+    #   @return [String]
+    #     Required. The monitored resource type. For example, the type
+    #     +"cloudsql_database"+ represents databases in Google Cloud SQL.
+    #     The maximum length of this value is 256 characters.
+    # @!attribute [rw] display_name
+    #   @return [String]
+    #     Optional. A concise name for the monitored resource type that might be
+    #     displayed in user interfaces. It should be a Title Cased Noun Phrase,
+    #     without any article or other determiners. For example,
+    #     +"Google Cloud SQL Database"+.
+    # @!attribute [rw] description
+    #   @return [String]
+    #     Optional. A detailed description of the monitored resource type that might
+    #     be used in documentation.
+    # @!attribute [rw] labels
+    #   @return [Array<Google::Api::LabelDescriptor>]
+    #     Required. A set of labels used to describe instances of this monitored
+    #     resource type. For example, an individual Google Cloud SQL database is
+    #     identified by values for the labels +"database_id"+ and +"zone"+.
+    class MonitoredResourceDescriptor; end
+
+    # An object representing a resource that can be used for monitoring, logging,
+    # billing, or other purposes. Examples include virtual machine instances,
+    # databases, and storage devices such as disks. The +type+ field identifies a
+    # MonitoredResourceDescriptor object that describes the resource's
+    # schema. Information in the +labels+ field identifies the actual resource and
+    # its attributes according to the schema. For example, a particular Compute
+    # Engine VM instance could be represented by the following object, because the
+    # MonitoredResourceDescriptor for +"gce_instance"+ has labels
+    # +"instance_id"+ and +"zone"+:
+    #
+    #     { "type": "gce_instance",
+    #       "labels": { "instance_id": "12345678901234",
+    #                   "zone": "us-central1-a" }}
+    # @!attribute [rw] type
+    #   @return [String]
+    #     Required. The monitored resource type. This field must match
+    #     the +type+ field of a MonitoredResourceDescriptor object. For
+    #     example, the type of a Cloud SQL database is +"cloudsql_database"+.
+    # @!attribute [rw] labels
+    #   @return [Hash{String => String}]
+    #     Required. Values for all of the labels listed in the associated monitored
+    #     resource descriptor. For example, Cloud SQL databases use the labels
+    #     +"database_id"+ and +"zone"+.
+    class MonitoredResource; end
+  end
+end

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

@@ -0,0 +1,80 @@
+# Copyright 2016 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
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Logging
+    module Type
+      # A common proto for logging HTTP requests. Only contains semantics
+      # defined by the HTTP specification. Product-specific logging
+      # information MUST be defined in a separate message.
+      # @!attribute [rw] request_method
+      #   @return [String]
+      #     The request method. Examples: +"GET"+, +"HEAD"+, +"PUT"+, +"POST"+.
+      # @!attribute [rw] request_url
+      #   @return [String]
+      #     The scheme (http, https), the host name, the path and the query
+      #     portion of the URL that was requested.
+      #     Example: +"http://example.com/some/info?color=red"+.
+      # @!attribute [rw] request_size
+      #   @return [Integer]
+      #     The size of the HTTP request message in bytes, including the request
+      #     headers and the request body.
+      # @!attribute [rw] status
+      #   @return [Integer]
+      #     The response code indicating the status of response.
+      #     Examples: 200, 404.
+      # @!attribute [rw] response_size
+      #   @return [Integer]
+      #     The size of the HTTP response message sent back to the client, in bytes,
+      #     including the response headers and the response body.
+      # @!attribute [rw] user_agent
+      #   @return [String]
+      #     The user agent sent by the client. Example:
+      #     +"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"+.
+      # @!attribute [rw] remote_ip
+      #   @return [String]
+      #     The IP address (IPv4 or IPv6) of the client that issued the HTTP
+      #     request. Examples: +"192.168.1.1"+, +"FE80::0202:B3FF:FE1E:8329"+.
+      # @!attribute [rw] server_ip
+      #   @return [String]
+      #     The IP address (IPv4 or IPv6) of the origin server that the request was
+      #     sent to.
+      # @!attribute [rw] referer
+      #   @return [String]
+      #     The referer URL of the request, as defined in
+      #     {HTTP/1.1 Header Field Definitions}[http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html].
+      # @!attribute [rw] latency
+      #   @return [Google::Protobuf::Duration]
+      #     The request processing latency on the server, from the time the request was
+      #     received until the response was sent.
+      # @!attribute [rw] cache_lookup
+      #   @return [true, false]
+      #     Whether or not a cache lookup was attempted.
+      # @!attribute [rw] cache_hit
+      #   @return [true, false]
+      #     Whether or not an entity was served from cache
+      #     (with or without validation).
+      # @!attribute [rw] cache_validated_with_origin_server
+      #   @return [true, false]
+      #     Whether or not the response was validated with the origin server before
+      #     being served from cache. This field is only meaningful if +cache_hit+ is
+      #     True.
+      # @!attribute [rw] cache_fill_bytes
+      #   @return [Integer]
+      #     The number of HTTP response bytes inserted into cache. Set only when a
+      #     cache fill was attempted.
+      class HttpRequest; end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+# Copyright 2016 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
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Logging
+    module V2
+      # An individual entry in a log.
+      # @!attribute [rw] log_name
+      #   @return [String]
+      #     Required. The resource name of the log to which this log entry
+      #     belongs. The format of the name is
+      #     +"projects/<project-id>/logs/<log-id>"+.  Examples:
+      #     +"projects/my-projectid/logs/syslog"+,
+      #     +"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"+.
+      #
+      #     The log ID part of resource name must be less than 512 characters
+      #     long and can only include the following characters: upper and
+      #     lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
+      #     characters: forward-slash, underscore, hyphen, and period.
+      #     Forward-slash (+/+) characters in the log ID must be URL-encoded.
+      # @!attribute [rw] resource
+      #   @return [Google::Api::MonitoredResource]
+      #     Required. The monitored resource associated with this log entry.
+      #     Example: a log entry that reports a database error would be
+      #     associated with the monitored resource designating the particular
+      #     database that reported the error.
+      # @!attribute [rw] proto_payload
+      #   @return [Google::Protobuf::Any]
+      #     The log entry payload, represented as a protocol buffer.  Some
+      #     Google Cloud Platform services use this field for their log
+      #     entry payloads.
+      # @!attribute [rw] text_payload
+      #   @return [String]
+      #     The log entry payload, represented as a Unicode string (UTF-8).
+      # @!attribute [rw] json_payload
+      #   @return [Google::Protobuf::Struct]
+      #     The log entry payload, represented as a structure that
+      #     is expressed as a JSON object.
+      # @!attribute [rw] timestamp
+      #   @return [Google::Protobuf::Timestamp]
+      #     Optional. The time the event described by the log entry occurred.  If
+      #     omitted, Stackdriver Logging will use the time the log entry is received.
+      # @!attribute [rw] severity
+      #   @return [Google::Logging::Type::LogSeverity]
+      #     Optional. The severity of the log entry. The default value is
+      #     +LogSeverity.DEFAULT+.
+      # @!attribute [rw] insert_id
+      #   @return [String]
+      #     Optional. A unique ID for the log entry. If you provide this
+      #     field, the logging service considers other log entries in the
+      #     same project with the same ID as duplicates which can be removed.  If
+      #     omitted, Stackdriver Logging will generate a unique ID for this
+      #     log entry.
+      # @!attribute [rw] http_request
+      #   @return [Google::Logging::Type::HttpRequest]
+      #     Optional. Information about the HTTP request associated with this
+      #     log entry, if applicable.
+      # @!attribute [rw] labels
+      #   @return [Hash{String => String}]
+      #     Optional. A set of user-defined (key, value) data that provides additional
+      #     information about the log entry.
+      # @!attribute [rw] operation
+      #   @return [Google::Logging::V2::LogEntryOperation]
+      #     Optional. Information about an operation associated with the log entry, if
+      #     applicable.
+      class LogEntry; end
+
+      # Additional information about a potentially long-running operation with which
+      # a log entry is associated.
+      # @!attribute [rw] id
+      #   @return [String]
+      #     Optional. An arbitrary operation identifier. Log entries with the
+      #     same identifier are assumed to be part of the same operation.
+      # @!attribute [rw] producer
+      #   @return [String]
+      #     Optional. An arbitrary producer identifier. The combination of
+      #     +id+ and +producer+ must be globally unique.  Examples for +producer+:
+      #     +"MyDivision.MyBigCompany.com"+, +"github.com/MyProject/MyApplication"+.
+      # @!attribute [rw] first
+      #   @return [true, false]
+      #     Optional. Set this to True if this is the first log entry in the operation.
+      # @!attribute [rw] last
+      #   @return [true, false]
+      #     Optional. Set this to True if this is the last log entry in the operation.
+      class LogEntryOperation; end
+    end
+  end
+end

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

@@ -0,0 +1,148 @@
+# Copyright 2016 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
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Logging
+    module V2
+      # The parameters to DeleteLog.
+      # @!attribute [rw] log_name
+      #   @return [String]
+      #     Required. The resource name of the log to delete.  Example:
+      #     +"projects/my-project/logs/syslog"+.
+      class DeleteLogRequest; end
+
+      # The parameters to WriteLogEntries.
+      # @!attribute [rw] log_name
+      #   @return [String]
+      #     Optional. A default log resource name that is assigned to all log entries
+      #     in +entries+ that do not specify a value for +log_name+.  Example:
+      #     +"projects/my-project/logs/syslog"+.  See
+      #     LogEntry.
+      # @!attribute [rw] resource
+      #   @return [Google::Api::MonitoredResource]
+      #     Optional. A default monitored resource object that is assigned to all log
+      #     entries in +entries+ that do not specify a value for +resource+. Example:
+      #
+      #         { "type": "gce_instance",
+      #           "labels": {
+      #             "zone": "us-central1-a", "instance_id": "00000000000000000000" }}
+      #
+      #     See LogEntry.
+      # @!attribute [rw] labels
+      #   @return [Hash{String => String}]
+      #     Optional. Default labels that are added to the +labels+ field of all log
+      #     entries in +entries+. If a log entry already has a label with the same key
+      #     as a label in this parameter, then the log entry's label is not changed.
+      #     See LogEntry.
+      # @!attribute [rw] entries
+      #   @return [Array<Google::Logging::V2::LogEntry>]
+      #     Required. The log entries to write. Values supplied for the fields
+      #     +log_name+, +resource+, and +labels+ in this +entries.write+ request are
+      #     added to those log entries that do not provide their own values for the
+      #     fields.
+      #
+      #     To improve throughput and to avoid exceeding the
+      #     {quota limit}[https://cloud.google.com/logging/quota-policy] for calls to +entries.write+,
+      #     you should write multiple log entries at once rather than
+      #     calling this method for each individual log entry.
+      # @!attribute [rw] partial_success
+      #   @return [true, false]
+      #     Optional. Whether valid entries should be written even if some other
+      #     entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
+      #     entry is not written, the response status will be the error associated
+      #     with one of the failed entries and include error details in the form of
+      #     WriteLogEntriesPartialErrors.
+      class WriteLogEntriesRequest; end
+
+      # Result returned from WriteLogEntries.
+      # empty
+      class WriteLogEntriesResponse; end
+
+      # 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.  Examples: +"my-project-1A"+, +"1234567890"+. 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.
+      # @!attribute [rw] resource_names
+      #   @return [Array<String>]
+      #     Optional. One or more cloud resources from which to retrieve log entries.
+      #     Example: +"projects/my-project-1A"+, +"projects/1234567890"+.  Projects
+      #     listed in +projectIds+ are added to this list.
+      # @!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.
+      # @!attribute [rw] order_by
+      #   @return [String]
+      #     Optional. How the results should be sorted.  Presently, the only permitted
+      #     values are +"timestamp asc"+ (default) and +"timestamp desc"+. The first
+      #     option returns entries in order of increasing values of
+      #     +LogEntry.timestamp+ (oldest first), and the second option returns entries
+      #     in order of decreasing timestamps (newest first).  Entries with equal
+      #     timestamps are returned in order of +LogEntry.insertId+.
+      # @!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 ListLogEntriesRequest; end
+
+      # Result returned from +ListLogEntries+.
+      # @!attribute [rw] entries
+      #   @return [Array<Google::Logging::V2::LogEntry>]
+      #     A list of log entries.
+      # @!attribute [rw] next_page_token
+      #   @return [String]
+      #     If there might be more results than appear 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 ListLogEntriesResponse; end
+
+      # The parameters to ListMonitoredResourceDescriptors
+      # @!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 ListMonitoredResourceDescriptorsRequest; end
+
+      # Result returned from ListMonitoredResourceDescriptors.
+      # @!attribute [rw] resource_descriptors
+      #   @return [Array<Google::Api::MonitoredResourceDescriptor>]
+      #     A list of resource descriptors.
+      # @!attribute [rw] next_page_token
+      #   @return [String]
+      #     If there might be more results than appear 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
+    end
+  end
+end