Stackdriver Logging V2 Client - Class LogEntry (1.31.0)

Reference documentation and code samples for the Stackdriver Logging V2 Client class LogEntry.

An individual entry in a log.

Generated from protobuf message google.logging.v2.LogEntry

Namespace

Google \ Cloud \ Logging \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ 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 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.
↳ proto_payload 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"
↳ text_payload string

The log entry payload, represented as a Unicode string (UTF-8).
↳ json_payload Google\Protobuf\Struct

The log entry payload, represented as a structure that is expressed as a JSON object.
↳ timestamp 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.
↳ receive_timestamp Google\Protobuf\Timestamp

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

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 Google\Cloud\Logging\Type\HttpRequest

Optional. Information about the HTTP request associated with this log entry, if applicable.
↳ labels array|Google\Protobuf\Internal\MapField

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 Google\Cloud\Logging\V2\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 Google\Cloud\Logging\V2\LogEntrySourceLocation

Optional. Source code location information associated with the log entry, if any.
↳ split Google\Cloud\Logging\V2\LogSplit

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

getLogName

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
Type Description
string

setLogName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getResource

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
Type Description
Google\Api\MonitoredResource|null

hasResource

clearResource

setResource

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.

Parameter
Name Description
var Google\Api\MonitoredResource
Returns
Type Description
$this

getProtoPayload

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
Type Description
Google\Protobuf\Any|null

hasProtoPayload

setProtoPayload

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"

Parameter
Name Description
var Google\Protobuf\Any
Returns
Type Description
$this

getTextPayload

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

Returns
Type Description
string

hasTextPayload

setTextPayload

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

Parameter
Name Description
var string
Returns
Type Description
$this

getJsonPayload

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

Returns
Type Description
Google\Protobuf\Struct|null

hasJsonPayload

setJsonPayload

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

Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this

getTimestamp

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
Type Description
Google\Protobuf\Timestamp|null

hasTimestamp

clearTimestamp

setTimestamp

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getReceiveTimestamp

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasReceiveTimestamp

clearReceiveTimestamp

setReceiveTimestamp

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getSeverity

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

Returns
Type Description
int

setSeverity

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

Parameter
Name Description
var int
Returns
Type Description
$this

getInsertId

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
Type Description
string

setInsertId

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getHttpRequest

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

Returns
Type Description
Google\Cloud\Logging\Type\HttpRequest|null

hasHttpRequest

clearHttpRequest

setHttpRequest

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

Parameter
Name Description
var Google\Cloud\Logging\Type\HttpRequest
Returns
Type Description
$this

getLabels

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
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getOperation

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

Returns
Type Description
Google\Cloud\Logging\V2\LogEntryOperation|null

hasOperation

clearOperation

setOperation

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

Parameter
Name Description
var Google\Cloud\Logging\V2\LogEntryOperation
Returns
Type Description
$this

getTrace

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
Type Description
string

setTrace

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getSpanId

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
Type Description
string

setSpanId

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
Parameter
Name Description
var string
Returns
Type Description
$this

getTraceSampled

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
Type Description
bool

setTraceSampled

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSourceLocation

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

Returns
Type Description
Google\Cloud\Logging\V2\LogEntrySourceLocation|null

hasSourceLocation

clearSourceLocation

setSourceLocation

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

Parameter
Name Description
var Google\Cloud\Logging\V2\LogEntrySourceLocation
Returns
Type Description
$this

getSplit

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

Returns
Type Description
Google\Cloud\Logging\V2\LogSplit|null

hasSplit

clearSplit

setSplit

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

Parameter
Name Description
var Google\Cloud\Logging\V2\LogSplit
Returns
Type Description
$this

getPayload

Returns
Type Description
string