Class: Google::Cloud::Logging::V2::LogEntry

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/logging/v2/log_entry.rb

Overview

An individual entry in a log.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#http_request ⇒ ::Google::Cloud::Logging::Type::HttpRequest

Returns Optional. Information about the HTTP request associated with this log entry, if applicable.

Returns:



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#insert_id ⇒ ::String

Returns 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.

If the insert_id is omitted when writing a log entry, the Logging API assigns its own unique identifier in this field.

In queries, the insert_id is also used to order log entries that have the same log_name and timestamp values.

Returns:

  • (::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 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.

    If the insert_id is omitted when writing a log entry, the Logging API assigns its own unique identifier in this field.

    In queries, the insert_id is also used to order log entries that have the same log_name and timestamp values.



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#json_payload ⇒ ::Google::Protobuf::Struct

Returns The log entry payload, represented as a structure that is expressed as a JSON object.

Returns:



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.

System-defined labels are defined by GCP services for platform logs. They have two components - a service namespace component and the attribute name. For example: compute.googleapis.com/resource_name.

Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.

Returns:

  • (::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.

    User-defined labels are arbitrary key, value pairs that you can use to classify logs.

    System-defined labels are defined by GCP services for platform logs. They have two components - a service namespace component and the attribute name. For example: compute.googleapis.com/resource_name.

    Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#log_name ⇒ ::String

Returns Required. The resource name of the log to which this log entry belongs:

"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"

A project number may be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.

[LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity".

[LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.

For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual, but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.

Returns:

  • (::String) —

    Required. The resource name of the log to which this log entry belongs:

    "projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"

    A project number may be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.

    [LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity".

    [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.

    For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual, but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#operation ⇒ ::Google::Cloud::Logging::V2::LogEntryOperation

Returns Optional. Information about an operation associated with the log entry, if applicable.

Returns:



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#proto_payload ⇒ ::Google::Protobuf::Any

Returns The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.

The following protocol buffer types are supported; user-defined types are not supported:

"type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog".

Returns:

  • (::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.

    The following protocol buffer types are supported; user-defined types are not supported:

    "type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog"



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#receive_timestamp ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the log entry was received by Logging.

Returns:



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#resource ⇒ ::Google::Api::MonitoredResource

Returns Required. The monitored resource that produced 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.

Returns:

  • (::Google::Api::MonitoredResource) —

    Required. The monitored resource that produced 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.



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#severity ⇒ ::Google::Cloud::Logging::Type::LogSeverity

Returns Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.

Returns:



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#source_location ⇒ ::Google::Cloud::Logging::V2::LogEntrySourceLocation

Returns Optional. Source code location information associated with the log entry, if any.

Returns:



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#span_id ⇒ ::String

Returns Optional. The span ID within the trace associated with the log entry.

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.

Returns:

  • (::String) —

    Optional. The span ID within the trace associated with the log entry.

    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.



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#split ⇒ ::Google::Cloud::Logging::V2::LogSplit

Returns Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.

Returns:



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#text_payload ⇒ ::String

Returns The log entry payload, represented as a Unicode string (UTF-8).

Returns:

  • (::String) —

    The log entry payload, represented as a Unicode string (UTF-8).



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#timestamp ⇒ ::Google::Protobuf::Timestamp

Returns 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 period in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging.

Returns:

  • (::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.

    Incoming log entries must have timestamps that don't exceed the logs retention period in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging.



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#trace ⇒ ::String

Returns 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.

Returns:

  • (::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



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#trace_sampled ⇒ ::Boolean

Returns Optional. The sampling decision of the trace associated with the log entry.

True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False.

Returns:

  • (::Boolean) —

    Optional. The sampling decision of the trace associated with the log entry.

    True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False.



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'proto_docs/google/logging/v2/log_entry.rb', line 159

class LogEntry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end