Struct LogEntry 

#[non_exhaustive]
pub struct LogEntry {

    pub log_name: String,
    pub resource: Option<MonitoredResource>,
    pub timestamp: Option<Timestamp>,
    pub receive_timestamp: Option<Timestamp>,
    pub severity: LogSeverity,
    pub insert_id: String,
    pub http_request: Option<HttpRequest>,
    pub labels: HashMap<String, String>,
    pub operation: Option<LogEntryOperation>,
    pub trace: String,
    pub span_id: String,
    pub trace_sampled: bool,
    pub source_location: Option<LogEntrySourceLocation>,
    pub split: Option<LogSplit>,
    pub payload: Option<Payload>,
    /* private fields */
}

An individual entry in a log.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

log_name: 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.

resource: Option<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.

timestamp: Option<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.

receive_timestamp: Option<Timestamp>

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

severity: LogSeverity

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

insert_id: 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.

http_request: Option<HttpRequest>

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

labels: HashMap<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.

operation: Option<LogEntryOperation>

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

trace: 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.

span_id: 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

trace_sampled: bool

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.

source_location: Option<LogEntrySourceLocation>

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

split: Option<LogSplit>

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

payload: Option<Payload>

The log entry payload, which can be one of multiple types.

Implementations

impl LogEntry

pub fn new() -> Self

pub fn set_log_name<T: Into<String>>(self, v: T) -> Self

Sets the value of log_name.

pub fn set_resource<T>(self, v: T) -> Self

where T: Into<MonitoredResource>,

Sets the value of resource.

pub fn set_or_clear_resource<T>(self, v: Option<T>) -> Self

where T: Into<MonitoredResource>,

Sets or clears the value of resource.

pub fn set_timestamp<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of timestamp.

pub fn set_or_clear_timestamp<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of timestamp.

pub fn set_receive_timestamp<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of receive_timestamp.

pub fn set_or_clear_receive_timestamp<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of receive_timestamp.

pub fn set_severity<T: Into<LogSeverity>>(self, v: T) -> Self

Sets the value of severity.

pub fn set_insert_id<T: Into<String>>(self, v: T) -> Self

Sets the value of insert_id.

pub fn set_http_request<T>(self, v: T) -> Self

where T: Into<HttpRequest>,

Sets the value of http_request.

pub fn set_or_clear_http_request<T>(self, v: Option<T>) -> Self

where T: Into<HttpRequest>,

Sets or clears the value of http_request.

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

pub fn set_operation<T>(self, v: T) -> Self

where T: Into<LogEntryOperation>,

Sets the value of operation.

pub fn set_or_clear_operation<T>(self, v: Option<T>) -> Self

where T: Into<LogEntryOperation>,

Sets or clears the value of operation.

pub fn set_trace<T: Into<String>>(self, v: T) -> Self

Sets the value of trace.

pub fn set_span_id<T: Into<String>>(self, v: T) -> Self

Sets the value of span_id.

pub fn set_trace_sampled<T: Into<bool>>(self, v: T) -> Self

Sets the value of trace_sampled.

pub fn set_source_location<T>(self, v: T) -> Self

where T: Into<LogEntrySourceLocation>,

Sets the value of source_location.

pub fn set_or_clear_source_location<T>(self, v: Option<T>) -> Self

where T: Into<LogEntrySourceLocation>,

Sets or clears the value of source_location.

pub fn set_split<T>(self, v: T) -> Self

where T: Into<LogSplit>,

Sets the value of split.

pub fn set_or_clear_split<T>(self, v: Option<T>) -> Self

where T: Into<LogSplit>,

Sets or clears the value of split.

pub fn set_payload<T: Into<Option<Payload>>>(self, v: T) -> Self

Sets the value of payload.

Note that all the setters affecting payload are mutually exclusive.

pub fn proto_payload(&self) -> Option<&Box<Any>>

The value of payload if it holds a ProtoPayload, None if the field is not set or holds a different branch.

pub fn set_proto_payload<T: Into<Box<Any>>>(self, v: T) -> Self

Sets the value of payload to hold a ProtoPayload.

Note that all the setters affecting payload are mutually exclusive.

pub fn text_payload(&self) -> Option<&String>

The value of payload if it holds a TextPayload, None if the field is not set or holds a different branch.

pub fn set_text_payload<T: Into<String>>(self, v: T) -> Self

Sets the value of payload to hold a TextPayload.

Note that all the setters affecting payload are mutually exclusive.

pub fn json_payload(&self) -> Option<&Box<Struct>>

The value of payload if it holds a JsonPayload, None if the field is not set or holds a different branch.

pub fn set_json_payload<T: Into<Box<Struct>>>(self, v: T) -> Self

Sets the value of payload to hold a JsonPayload.

Note that all the setters affecting payload are mutually exclusive.

Trait Implementations

impl Clone for LogEntry

fn clone(&self) -> LogEntry

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LogEntry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LogEntry

fn default() -> LogEntry

Returns the “default value” for a type.

impl Message for LogEntry

fn typename() -> &'static str

The typename of this message.

impl PartialEq for LogEntry

fn eq(&self, other: &LogEntry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LogEntry