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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb

Overview

An individual entry in a log.

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end

#insert_id ⇒ String

Returns Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same +timestamp+, and with the same +insert_id+ to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging assigns its own unique identifier. The +insert_id+ is also used to order log entries that have the same +timestamp+ value.

Returns:

  • (String) —

    Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same +timestamp+, and with the same +insert_id+ to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging assigns its own unique identifier. The +insert_id+ is also used to order log entries that have the same +timestamp+ value.



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end

#json_payload ⇒ Google::Protobuf::Struct

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

Returns:

  • (Google::Protobuf::Struct) —

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



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end

#labels ⇒ Hash{String => String}

Returns Optional. A set of user-defined (key, value) data that provides additional information about the log entry.

Returns:

  • (Hash{String => String}) —

    Optional. A set of user-defined (key, value) data that provides additional information about the log entry.



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; 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 optionally 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 optionally 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.



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end

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

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

Returns:



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; 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.

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.



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end

#receive_timestamp ⇒ Google::Protobuf::Timestamp

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

Returns:



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end

#resource ⇒ Google::Api::MonitoredResource

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

Returns:

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



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end

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

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

Returns:

  • (Google::Logging::Type::LogSeverity) —

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



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end

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

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

Returns:



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end

#span_id ⇒ String

Returns Optional. Id of the span within the trace associated with the log entry. e.g. "0000000000000042" For Stackdriver trace spans, this is the same format that the Stackdriver trace API uses. The ID is a 16-character hexadecimal encoding of an 8-byte array.

Returns:

  • (String) —

    Optional. Id of the span within the trace associated with the log entry. e.g. "0000000000000042" For Stackdriver trace spans, this is the same format that the Stackdriver trace API uses. The ID is a 16-character hexadecimal encoding of an 8-byte array.



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; 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).



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; 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 Stackdriver Logging assigns it the current time.

Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. See the +entries.write+ API method for more information.

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 Stackdriver Logging assigns it the current time.

    Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. See the +entries.write+ API method for more information.



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; 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+



116
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb', line 116

class LogEntry; end