Cloud Logging V2 API - Class Google::Cloud::Logging::V2::LogEntry (v0.13.0)

Reference documentation and code samples for the Cloud Logging V2 API class Google::Cloud::Logging::V2::LogEntry.

An individual entry in a log.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#http_request

def http_request() -> ::Google::Cloud::Logging::Type::HttpRequest
Returns

#http_request=

def http_request=(value) -> ::Google::Cloud::Logging::Type::HttpRequest
Parameter
Returns

#insert_id

def insert_id() -> ::String
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.

#insert_id=

def insert_id=(value) -> ::String
Parameter
  • value (::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.

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.

#json_payload

def json_payload() -> ::Google::Protobuf::Struct
Returns

#json_payload=

def json_payload=(value) -> ::Google::Protobuf::Struct
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::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.

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.

#log_name

def log_name() -> ::String
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.

#log_name=

def log_name=(value) -> ::String
Parameter
  • value (::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.

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.

#operation

def operation() -> ::Google::Cloud::Logging::V2::LogEntryOperation
Returns

#operation=

def operation=(value) -> ::Google::Cloud::Logging::V2::LogEntryOperation
Parameter
Returns

#proto_payload

def proto_payload() -> ::Google::Protobuf::Any
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"

#proto_payload=

def proto_payload=(value) -> ::Google::Protobuf::Any
Parameter
  • value (::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"

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"

#receive_timestamp

def receive_timestamp() -> ::Google::Protobuf::Timestamp
Returns

#resource

def resource() -> ::Google::Api::MonitoredResource
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.

#resource=

def resource=(value) -> ::Google::Api::MonitoredResource
Parameter
  • value (::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.

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.

#severity

def severity() -> ::Google::Cloud::Logging::Type::LogSeverity
Returns

#severity=

def severity=(value) -> ::Google::Cloud::Logging::Type::LogSeverity
Parameter
Returns

#source_location

def source_location() -> ::Google::Cloud::Logging::V2::LogEntrySourceLocation
Returns

#source_location=

def source_location=(value) -> ::Google::Cloud::Logging::V2::LogEntrySourceLocation
Parameter
Returns

#span_id

def span_id() -> ::String
Returns
  • (::String) —

    Optional. The ID of the Cloud 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 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 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:

    • 000000000000004a
    • 7a2190356c3fc94b
    • 0000f00300090021
    • d39223e101960076

#span_id=

def span_id=(value) -> ::String
Parameter
  • value (::String) —

    Optional. The ID of the Cloud 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 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 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:

    • 000000000000004a
    • 7a2190356c3fc94b
    • 0000f00300090021
    • d39223e101960076
Returns
  • (::String) —

    Optional. The ID of the Cloud 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 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 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:

    • 000000000000004a
    • 7a2190356c3fc94b
    • 0000f00300090021
    • d39223e101960076

#split

def split() -> ::Google::Cloud::Logging::V2::LogSplit
Returns

#split=

def split=(value) -> ::Google::Cloud::Logging::V2::LogSplit
Parameter
Returns

#text_payload

def text_payload() -> ::String
Returns
  • (::String) — The log entry payload, represented as a Unicode string (UTF-8).

#text_payload=

def text_payload=(value) -> ::String
Parameter
  • value (::String) — The log entry payload, represented as a Unicode string (UTF-8).
Returns
  • (::String) — The log entry payload, represented as a Unicode string (UTF-8).

#timestamp

def timestamp() -> ::Google::Protobuf::Timestamp
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.

#timestamp=

def timestamp=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::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.

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.

#trace

def trace() -> ::String
Returns
  • (::String) — Optional. The REST resource name of the trace being written to Cloud 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.

#trace=

def trace=(value) -> ::String
Parameter
  • value (::String) — Optional. The REST resource name of the trace being written to Cloud 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.

Returns
  • (::String) — Optional. The REST resource name of the trace being written to Cloud 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.

#trace_sampled

def trace_sampled() -> ::Boolean
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.

#trace_sampled=

def trace_sampled=(value) -> ::Boolean
Parameter
  • value (::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.

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.