Class LogEntry (3.3.0)

public sealed class LogEntry : IMessage<LogEntry>, IEquatable<LogEntry>, IDeepCloneable<LogEntry>, IBufferMessage, IMessage

An individual entry in a log.

Inheritance

Object > LogEntry

Implements

IMessage<LogEntry>, IEquatable<LogEntry>, IDeepCloneable<LogEntry>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LogEntry()

public LogEntry()

LogEntry(LogEntry)

public LogEntry(LogEntry other)

Parameter
Name	Description
`other`	`LogEntry`

Properties

HttpRequest

public HttpRequest HttpRequest { get; set; }

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

Property Value
Type	Description
`Google.Cloud.Logging.Type.HttpRequest`

InsertId

public string InsertId { get; set; }

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.

Property Value
Type	Description
`String`

JsonPayload

public Struct JsonPayload { get; set; }

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

Property Value
Type	Description
`Struct`

Labels

public MapField<string, string> Labels { get; }

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

Property Value
Type	Description
`MapField<String, String>`

LogName

public string LogName { get; set; }

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.

Property Value
Type	Description
`String`

LogNameAsLogName

public LogName LogNameAsLogName { get; set; }

LogName-typed view over the LogName resource name property.

Property Value
Type	Description
`LogName`

Operation

public LogEntryOperation Operation { get; set; }

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

Property Value
Type	Description
`LogEntryOperation`

PayloadCase

public LogEntry.PayloadOneofCase PayloadCase { get; }

Property Value
Type	Description
`LogEntry.PayloadOneofCase`

ProtoPayload

public Any ProtoPayload { get; set; }

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"

Property Value
Type	Description
`Any`

ReceiveTimestamp

public Timestamp ReceiveTimestamp { get; set; }

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

Property Value
Type	Description
`Timestamp`

Resource

public MonitoredResource Resource { get; set; }

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.

Property Value
Type	Description
`MonitoredResource`

Severity

public LogSeverity Severity { get; set; }

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

Property Value
Type	Description
`Google.Cloud.Logging.Type.LogSeverity`

SourceLocation

public LogEntrySourceLocation SourceLocation { get; set; }

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

Property Value
Type	Description
`LogEntrySourceLocation`

SpanId

public string SpanId { get; set; }

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.

Property Value
Type	Description
`String`

TextPayload

public string TextPayload { get; set; }

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

Property Value
Type	Description
`String`

Timestamp

public Timestamp Timestamp { get; set; }

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.

Property Value
Type	Description
`Timestamp`

Trace

public string Trace { get; set; }

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

Property Value
Type	Description
`String`

TraceSampled

public bool TraceSampled { get; set; }

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.

Property Value
Type	Description
`Boolean`