public sealed class LogEntry : IMessage<LogEntry>, IEquatable<LogEntry>, IDeepCloneable<LogEntry>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Logging v2 API class LogEntry.
An individual entry in a log.
Namespace
Google.Cloud.Logging.V2Assembly
Google.Cloud.Logging.V2.dll
Constructors
LogEntry()
public LogEntry()LogEntry(LogEntry)
public LogEntry(LogEntry other)| Parameter | |
|---|---|
| Name | Description |
other |
LogEntry |
Properties
HasTextPayload
public bool HasTextPayload { get; }Gets whether the "text_payload" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HttpRequest
public HttpRequest HttpRequest { get; set; }Optional. Information about the HTTP request associated with this log entry, if applicable.
| Property Value | |
|---|---|
| Type | Description |
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 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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
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; }| 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 |
LogEntryPayloadOneofCase |
|
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 |
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 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:
000000000000004a7a2190356c3fc94b0000f00300090021d39223e101960076
| Property Value | |
|---|---|
| Type | Description |
string |
|
Split
public LogSplit Split { get; set; }Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
| Property Value | |
|---|---|
| Type | Description |
LogSplit |
|
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. 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.
| 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 |
bool |
|