google-cloud-logging-v2 0.8.1 → 0.9.0

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

@@ -73,11 +73,12 @@ module Google
         #     expressed as a JSON object.
         # @!attribute [rw] timestamp
         #   @return [::Google::Protobuf::Timestamp]
-        #     Optional. The time the event described by the log entry occurred. This time is used
-        #     to compute the log entry's age and to enforce the logs retention period.
-        #     If this field is omitted in a new log entry, then Logging assigns it the
-        #     current time. Timestamps have nanosecond accuracy, but trailing zeros in
-        #     the fractional seconds might be omitted when the timestamp is displayed.
+        #     Optional. The time the event described by the log entry occurred. This time
+        #     is used to compute the log entry's age and to enforce the logs retention
+        #     period. If this field is omitted in a new log entry, then Logging assigns
+        #     it the current time. Timestamps have nanosecond accuracy, but trailing
+        #     zeros in the fractional seconds might be omitted when the timestamp is
+        #     displayed.
         #
         #     Incoming log entries must have timestamps that don't exceed the
         #     [logs retention
@@ -89,11 +90,12 @@ module Google
         #     Output only. The time the log entry was received by Logging.
         # @!attribute [rw] severity
         #   @return [::Google::Cloud::Logging::Type::LogSeverity]
-        #     Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
+        #     Optional. The severity of the log entry. The default value is
+        #     `LogSeverity.DEFAULT`.
         # @!attribute [rw] insert_id
         #   @return [::String]
-        #     Optional. A unique identifier for the log entry. If you provide a value, then
-        #     Logging considers other log entries in the same project, with the same
+        #     Optional. A unique identifier for the log entry. If you provide a value,
+        #     then Logging considers other log entries in the same project, with the same
         #     `timestamp`, and with the same `insert_id` to be duplicates which are
         #     removed in a single query result. However, there are no guarantees of
         #     de-duplication in the export of logs.
@@ -105,12 +107,12 @@ module Google
         #     the same `log_name` and `timestamp` values.
         # @!attribute [rw] http_request
         #   @return [::Google::Cloud::Logging::Type::HttpRequest]
-        #     Optional. Information about the HTTP request associated with this log entry, if
-        #     applicable.
+        #     Optional. Information about the HTTP request associated with this log
+        #     entry, if applicable.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
-        #     Optional. A map of key, value pairs that provides additional information about the
-        #     log entry. The labels can be user-defined or system-defined.
+        #     Optional. A map of key, value pairs that provides additional information
+        #     about the log entry. The labels can be user-defined or system-defined.
         #
         #     User-defined labels are arbitrary key, value pairs that you can use to
         #     classify logs.
@@ -129,17 +131,47 @@ module Google
         #     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`
+        #     Optional. The REST resource name of the trace being written to
+        #     [Cloud Trace](https://cloud.google.com/trace) in
+        #     association with this log entry. For example, if your trace data is stored
+        #     in the Cloud project "my-trace-project" and if the service that is creating
+        #     the log entry receives a trace header that includes the trace ID "12345",
+        #     then the service should use "projects/my-tracing-project/traces/12345".
+        #
+        #     The `trace` field provides the link between logs and traces. By using
+        #     this field, you can navigate from a log entry to a trace.
         # @!attribute [rw] span_id
         #   @return [::String]
-        #     Optional. The span ID within the trace associated with the log entry.
+        #     Optional. The ID of the [Cloud Trace](https://cloud.google.com/trace) span
+        #     associated with the current operation in which the log is being written.
+        #     For example, if a span has the REST resource name of
+        #     "projects/some-project/traces/some-trace/spans/some-span-id", then the
+        #     `span_id` field is "some-span-id".
+        #
+        #     A
+        #     [Span](https://cloud.google.com/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#Span)
+        #     represents a single operation within a trace. Whereas a trace may involve
+        #     multiple different microservices running on multiple different machines,
+        #     a span generally corresponds to a single logical operation being performed
+        #     in a single instance of a microservice on one specific machine. Spans
+        #     are the nodes within the tree that is a trace.
+        #
+        #     Applications that are [instrumented for
+        #     tracing](https://cloud.google.com/trace/docs/setup) will generally assign a
+        #     new, unique span ID on each incoming request. It is also common to create
+        #     and record additional spans corresponding to internal processing elements
+        #     as well as issuing requests to dependencies.
+        #
+        #     The span ID is expected to be a 16-character, hexadecimal encoding of an
+        #     8-byte array and should not be zero. It should be unique within the trace
+        #     and should, ideally, be generated in a manner that is uniformly random.
+        #
+        #     Example values:
         #
-        #     For Trace spans, this is the same format that the Trace API v2 uses: a
-        #     16-character hexadecimal encoding of an 8-byte array, such as
-        #     `000000000000004a`.
+        #       - `000000000000004a`
+        #       - `7a2190356c3fc94b`
+        #       - `0000f00300090021`
+        #       - `d39223e101960076`
         # @!attribute [rw] trace_sampled
         #   @return [::Boolean]
         #     Optional. The sampling decision of the trace associated with the log entry.
@@ -151,11 +183,12 @@ module Google
         #     request correlation identifier. The default is False.
         # @!attribute [rw] source_location
         #   @return [::Google::Cloud::Logging::V2::LogEntrySourceLocation]
-        #     Optional. Source code location information associated with the log entry, if any.
+        #     Optional. Source code location information associated with the log entry,
+        #     if any.
         # @!attribute [rw] split
         #   @return [::Google::Cloud::Logging::V2::LogSplit]
-        #     Optional. Information indicating this LogEntry is part of a sequence of multiple log
-        #     entries split from a single LogEntry.
+        #     Optional. Information indicating this LogEntry is part of a sequence of
+        #     multiple log entries split from a single LogEntry.
         class LogEntry
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -106,11 +106,13 @@ module Google
         #     list, rather than calling this method for each individual log entry.
         # @!attribute [rw] partial_success
         #   @return [::Boolean]
-        #     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, then the response status is the error associated
-        #     with one of the failed entries and the response includes error details
-        #     keyed by the entries' zero-based index in the `entries.write` method.
+        #     Optional. Whether a batch's valid entries should be written even if some
+        #     other entry failed due to a permanent error such as INVALID_ARGUMENT or
+        #     PERMISSION_DENIED. If any entry failed, then the response status is the
+        #     response status of one of the failed entries. The response will include
+        #     error details in `WriteLogEntriesPartialErrors.log_entry_errors` keyed by
+        #     the entries' zero-based index in the `entries`. Failed requests for which
+        #     no entries are written will not include per-entry errors.
         # @!attribute [rw] dry_run
         #   @return [::Boolean]
         #     Optional. If true, the request should expect normal response, but the
@@ -178,15 +180,14 @@ module Google
         #      * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
         #
         #     Projects listed in the `project_ids` field are added to this list.
+        #     A maximum of 100 resources may be specified in a single request.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     Optional. A filter that chooses which log entries to return.  See [Advanced
-        #     Logs Queries](https://cloud.google.com/logging/docs/view/advanced-queries).
-        #     Only log entries that match the filter are returned.  An empty filter
-        #     matches all log entries in the resources listed in `resource_names`.
+        #     Optional. 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 listed in `resource_names` will
-        #     cause the filter to return no results. The maximum length of the filter is
-        #     20000 characters.
+        #     cause the filter to return no results. The maximum length of a filter is
+        #     20,000 characters.
         # @!attribute [rw] order_by
         #   @return [::String]
         #     Optional. How the results should be sorted.  Presently, the only permitted
@@ -197,10 +198,10 @@ module Google
         #     timestamps are returned in order of their `insert_id` values.
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     Optional. The maximum number of results to return from this request. Default is 50.
-        #     If the value is negative or exceeds 1000, the request is rejected. The
-        #     presence of `next_page_token` in the response indicates that more results
-        #     might be available.
+        #     Optional. The maximum number of results to return from this request.
+        #     Default is 50. If the value is negative or exceeds 1000, the request is
+        #     rejected. The presence of `next_page_token` 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
@@ -269,26 +270,15 @@ module Google
         # The parameters to ListLogs.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The resource name that owns the logs:
+        #     Required. The resource name to list logs for:
         #
         #     *  `projects/[PROJECT_ID]`
         #     *  `organizations/[ORGANIZATION_ID]`
         #     *  `billingAccounts/[BILLING_ACCOUNT_ID]`
         #     *  `folders/[FOLDER_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.
         # @!attribute [rw] resource_names
         #   @return [::Array<::String>]
-        #     Optional. The resource name that owns the logs:
+        #     Optional. List of resource names to list logs for:
         #
         #      * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
         #      * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
@@ -301,6 +291,19 @@ module Google
         #     *  `organizations/[ORGANIZATION_ID]`
         #     *  `billingAccounts/[BILLING_ACCOUNT_ID]`
         #     *  `folders/[FOLDER_ID]`
+        #
+        #     The resource name in the `parent` field is added to this list.
+        # @!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
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -340,13 +343,11 @@ module Google
         #      * `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.
+        #     Optional. 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 listed in `resource_names` will
+        #     cause the filter to return no results. The maximum length of a filter is
+        #     20,000 characters.
         # @!attribute [rw] buffer_window
         #   @return [::Google::Protobuf::Duration]
         #     Optional. The amount of time to buffer log entries at the server before