Class LogEntry

An individual entry in a log.

Inheritance
object
LogEntry
Implements
Inherited Members
Namespace: Google.Apis.Logging.v2.Data
Assembly: Google.Apis.Logging.v2.dll
Syntax
public class LogEntry : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ErrorGroups

Output only. The Error Reporting (https://cloud.google.com/error-reporting) error groups associated with this LogEntry. Error Reporting sets the values for this field during error group creation.For more information, see View error details( https://cloud.google.com/error-reporting/docs/viewing-errors#view_error_details)This field isn't available during log routing (https://cloud.google.com/logging/docs/routing/overview)

Declaration
[JsonProperty("errorGroups")]
public virtual IList<LogErrorGroup> ErrorGroups { get; set; }
Property Value
Type Description
IList<LogErrorGroup>

HttpRequest

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

Declaration
[JsonProperty("httpRequest")]
public virtual HttpRequest HttpRequest { get; set; }
Property Value
Type Description
HttpRequest

InsertId

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.

Declaration
[JsonProperty("insertId")]
public virtual string InsertId { get; set; }
Property Value
Type Description
string

JsonPayload

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

Declaration
[JsonProperty("jsonPayload")]
public virtual IDictionary<string, object> JsonPayload { get; set; }
Property Value
Type Description
IDictionary<string, object>

Labels

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.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

LogName

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

Declaration
[JsonProperty("logName")]
public virtual string LogName { get; set; }
Property Value
Type Description
string

Metadata

Output only. Deprecated. This field is not used by Logging. Any value written to it is cleared.

Declaration
[JsonProperty("metadata")]
public virtual MonitoredResourceMetadata Metadata { get; set; }
Property Value
Type Description
MonitoredResourceMetadata

Operation

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

Declaration
[JsonProperty("operation")]
public virtual LogEntryOperation Operation { get; set; }
Property Value
Type Description
LogEntryOperation

ProtoPayload

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"

Declaration
[JsonProperty("protoPayload")]
public virtual IDictionary<string, object> ProtoPayload { get; set; }
Property Value
Type Description
IDictionary<string, object>

ReceiveTimestamp

object representation of ReceiveTimestampRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ReceiveTimestampDateTimeOffset instead.")]
public virtual object ReceiveTimestamp { get; set; }
Property Value
Type Description
object

ReceiveTimestampDateTimeOffset

DateTimeOffset representation of ReceiveTimestampRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ReceiveTimestampDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ReceiveTimestampRaw

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

Declaration
[JsonProperty("receiveTimestamp")]
public virtual string ReceiveTimestampRaw { get; set; }
Property Value
Type Description
string

Resource

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.

Declaration
[JsonProperty("resource")]
public virtual MonitoredResource Resource { get; set; }
Property Value
Type Description
MonitoredResource

Severity

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

Declaration
[JsonProperty("severity")]
public virtual string Severity { get; set; }
Property Value
Type Description
string

SourceLocation

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

Declaration
[JsonProperty("sourceLocation")]
public virtual LogEntrySourceLocation SourceLocation { get; set; }
Property Value
Type Description
LogEntrySourceLocation

SpanId

Optional. The ID of the Cloud Trace (https://cloud.google.com/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 (https://cloud.google.com/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#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 (https://cloud.google.com/trace/docs/setup) 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

Declaration
[JsonProperty("spanId")]
public virtual string SpanId { get; set; }
Property Value
Type Description
string

Split

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

Declaration
[JsonProperty("split")]
public virtual LogSplit Split { get; set; }
Property Value
Type Description
LogSplit

TextPayload

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

Declaration
[JsonProperty("textPayload")]
public virtual string TextPayload { get; set; }
Property Value
Type Description
string

Timestamp

object representation of TimestampRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use TimestampDateTimeOffset instead.")]
public virtual object Timestamp { get; set; }
Property Value
Type Description
object

TimestampDateTimeOffset

DateTimeOffset representation of TimestampRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? TimestampDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

TimestampRaw

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 (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries are rejected by Logging.

Declaration
[JsonProperty("timestamp")]
public virtual string TimestampRaw { get; set; }
Property Value
Type Description
string

Trace

Optional. The REST resource name of the trace being written to Cloud Trace (https://cloud.google.com/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-trace-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.

Declaration
[JsonProperty("trace")]
public virtual string Trace { get; set; }
Property Value
Type Description
string

TraceSampled

Optional. The sampling decision of the span associated with the log entry at the time the log entry was created. This field corresponds to the sampled flag in the W3C trace-context specification (https://www.w3.org/TR/trace-context/#sampled-flag). A non-sampled trace value is still useful as a request correlation identifier. The default is False.

Declaration
[JsonProperty("traceSampled")]
public virtual bool? TraceSampled { get; set; }
Property Value
Type Description
bool?

Implements