opentelemetry.proto.logs.v1.LogRecord
*/
class LogRecord extends \Google\Protobuf\Internal\Message
{
/**
* time_unix_nano is the time when the event occurred.
* Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
* Value of 0 indicates unknown or missing timestamp.
*
* Generated from protobuf field fixed64 time_unix_nano = 1;
*/
protected $time_unix_nano = 0;
/**
* Time when the event was observed by the collection system.
* For events that originate in OpenTelemetry (e.g. using OpenTelemetry Logging SDK)
* this timestamp is typically set at the generation time and is equal to Timestamp.
* For events originating externally and collected by OpenTelemetry (e.g. using
* Collector) this is the time when OpenTelemetry's code observed the event measured
* by the clock of the OpenTelemetry code. This field MUST be set once the event is
* observed by OpenTelemetry.
* For converting OpenTelemetry log data to formats that support only one timestamp or
* when receiving OpenTelemetry log data by recipients that support only one timestamp
* internally the following logic is recommended:
* - Use time_unix_nano if it is present, otherwise use observed_time_unix_nano.
* Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
* Value of 0 indicates unknown or missing timestamp.
*
* Generated from protobuf field fixed64 observed_time_unix_nano = 11;
*/
protected $observed_time_unix_nano = 0;
/**
* Numerical value of the severity, normalized to values described in Log Data Model.
* [Optional].
*
* Generated from protobuf field .opentelemetry.proto.logs.v1.SeverityNumber severity_number = 2;
*/
protected $severity_number = 0;
/**
* The severity text (also known as log level). The original string representation as
* it is known at the source. [Optional].
*
* Generated from protobuf field string severity_text = 3;
*/
protected $severity_text = '';
/**
* A value containing the body of the log record. Can be for example a human-readable
* string message (including multi-line) describing the event in a free form or it can
* be a structured data composed of arrays and maps of other values. [Optional].
*
* Generated from protobuf field .opentelemetry.proto.common.v1.AnyValue body = 5;
*/
protected $body = null;
/**
* Additional attributes that describe the specific event occurrence. [Optional].
* Attribute keys MUST be unique (it is not allowed to have more than one
* attribute with the same key).
*
* Generated from protobuf field repeated .opentelemetry.proto.common.v1.KeyValue attributes = 6;
*/
private $attributes;
/**
* Generated from protobuf field uint32 dropped_attributes_count = 7;
*/
protected $dropped_attributes_count = 0;
/**
* Flags, a bit field. 8 least significant bits are the trace flags as
* defined in W3C Trace Context specification. 24 most significant bits are reserved
* and must be set to 0. Readers must not assume that 24 most significant bits
* will be zero and must correctly mask the bits when reading 8-bit trace flag (use
* flags & LOG_RECORD_FLAGS_TRACE_FLAGS_MASK). [Optional].
*
* Generated from protobuf field fixed32 flags = 8;
*/
protected $flags = 0;
/**
* A unique identifier for a trace. All logs from the same trace share
* the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes OR
* of length other than 16 bytes is considered invalid (empty string in OTLP/JSON
* is zero-length and thus is also invalid).
* This field is optional.
* The receivers SHOULD assume that the log record is not associated with a
* trace if any of the following is true:
* - the field is not present,
* - the field contains an invalid value.
*
* Generated from protobuf field bytes trace_id = 9;
*/
protected $trace_id = '';
/**
* A unique identifier for a span within a trace, assigned when the span
* is created. The ID is an 8-byte array. An ID with all zeroes OR of length
* other than 8 bytes is considered invalid (empty string in OTLP/JSON
* is zero-length and thus is also invalid).
* This field is optional. If the sender specifies a valid span_id then it SHOULD also
* specify a valid trace_id.
* The receivers SHOULD assume that the log record is not associated with a
* span if any of the following is true:
* - the field is not present,
* - the field contains an invalid value.
*
* Generated from protobuf field bytes span_id = 10;
*/
protected $span_id = '';
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type int|string $time_unix_nano
* time_unix_nano is the time when the event occurred.
* Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
* Value of 0 indicates unknown or missing timestamp.
* @type int|string $observed_time_unix_nano
* Time when the event was observed by the collection system.
* For events that originate in OpenTelemetry (e.g. using OpenTelemetry Logging SDK)
* this timestamp is typically set at the generation time and is equal to Timestamp.
* For events originating externally and collected by OpenTelemetry (e.g. using
* Collector) this is the time when OpenTelemetry's code observed the event measured
* by the clock of the OpenTelemetry code. This field MUST be set once the event is
* observed by OpenTelemetry.
* For converting OpenTelemetry log data to formats that support only one timestamp or
* when receiving OpenTelemetry log data by recipients that support only one timestamp
* internally the following logic is recommended:
* - Use time_unix_nano if it is present, otherwise use observed_time_unix_nano.
* Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
* Value of 0 indicates unknown or missing timestamp.
* @type int $severity_number
* Numerical value of the severity, normalized to values described in Log Data Model.
* [Optional].
* @type string $severity_text
* The severity text (also known as log level). The original string representation as
* it is known at the source. [Optional].
* @type \Opentelemetry\Proto\Common\V1\AnyValue $body
* A value containing the body of the log record. Can be for example a human-readable
* string message (including multi-line) describing the event in a free form or it can
* be a structured data composed of arrays and maps of other values. [Optional].
* @type \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $attributes
* Additional attributes that describe the specific event occurrence. [Optional].
* Attribute keys MUST be unique (it is not allowed to have more than one
* attribute with the same key).
* @type int $dropped_attributes_count
* @type int $flags
* Flags, a bit field. 8 least significant bits are the trace flags as
* defined in W3C Trace Context specification. 24 most significant bits are reserved
* and must be set to 0. Readers must not assume that 24 most significant bits
* will be zero and must correctly mask the bits when reading 8-bit trace flag (use
* flags & LOG_RECORD_FLAGS_TRACE_FLAGS_MASK). [Optional].
* @type string $trace_id
* A unique identifier for a trace. All logs from the same trace share
* the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes OR
* of length other than 16 bytes is considered invalid (empty string in OTLP/JSON
* is zero-length and thus is also invalid).
* This field is optional.
* The receivers SHOULD assume that the log record is not associated with a
* trace if any of the following is true:
* - the field is not present,
* - the field contains an invalid value.
* @type string $span_id
* A unique identifier for a span within a trace, assigned when the span
* is created. The ID is an 8-byte array. An ID with all zeroes OR of length
* other than 8 bytes is considered invalid (empty string in OTLP/JSON
* is zero-length and thus is also invalid).
* This field is optional. If the sender specifies a valid span_id then it SHOULD also
* specify a valid trace_id.
* The receivers SHOULD assume that the log record is not associated with a
* span if any of the following is true:
* - the field is not present,
* - the field contains an invalid value.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Opentelemetry\Proto\Logs\V1\Logs::initOnce();
parent::__construct($data);
}
/**
* time_unix_nano is the time when the event occurred.
* Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
* Value of 0 indicates unknown or missing timestamp.
*
* Generated from protobuf field fixed64 time_unix_nano = 1;
* @return int|string
*/
public function getTimeUnixNano()
{
return $this->time_unix_nano;
}
/**
* time_unix_nano is the time when the event occurred.
* Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
* Value of 0 indicates unknown or missing timestamp.
*
* Generated from protobuf field fixed64 time_unix_nano = 1;
* @param int|string $var
* @return $this
*/
public function setTimeUnixNano($var)
{
GPBUtil::checkUint64($var);
$this->time_unix_nano = $var;
return $this;
}
/**
* Time when the event was observed by the collection system.
* For events that originate in OpenTelemetry (e.g. using OpenTelemetry Logging SDK)
* this timestamp is typically set at the generation time and is equal to Timestamp.
* For events originating externally and collected by OpenTelemetry (e.g. using
* Collector) this is the time when OpenTelemetry's code observed the event measured
* by the clock of the OpenTelemetry code. This field MUST be set once the event is
* observed by OpenTelemetry.
* For converting OpenTelemetry log data to formats that support only one timestamp or
* when receiving OpenTelemetry log data by recipients that support only one timestamp
* internally the following logic is recommended:
* - Use time_unix_nano if it is present, otherwise use observed_time_unix_nano.
* Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
* Value of 0 indicates unknown or missing timestamp.
*
* Generated from protobuf field fixed64 observed_time_unix_nano = 11;
* @return int|string
*/
public function getObservedTimeUnixNano()
{
return $this->observed_time_unix_nano;
}
/**
* Time when the event was observed by the collection system.
* For events that originate in OpenTelemetry (e.g. using OpenTelemetry Logging SDK)
* this timestamp is typically set at the generation time and is equal to Timestamp.
* For events originating externally and collected by OpenTelemetry (e.g. using
* Collector) this is the time when OpenTelemetry's code observed the event measured
* by the clock of the OpenTelemetry code. This field MUST be set once the event is
* observed by OpenTelemetry.
* For converting OpenTelemetry log data to formats that support only one timestamp or
* when receiving OpenTelemetry log data by recipients that support only one timestamp
* internally the following logic is recommended:
* - Use time_unix_nano if it is present, otherwise use observed_time_unix_nano.
* Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
* Value of 0 indicates unknown or missing timestamp.
*
* Generated from protobuf field fixed64 observed_time_unix_nano = 11;
* @param int|string $var
* @return $this
*/
public function setObservedTimeUnixNano($var)
{
GPBUtil::checkUint64($var);
$this->observed_time_unix_nano = $var;
return $this;
}
/**
* Numerical value of the severity, normalized to values described in Log Data Model.
* [Optional].
*
* Generated from protobuf field .opentelemetry.proto.logs.v1.SeverityNumber severity_number = 2;
* @return int
*/
public function getSeverityNumber()
{
return $this->severity_number;
}
/**
* Numerical value of the severity, normalized to values described in Log Data Model.
* [Optional].
*
* Generated from protobuf field .opentelemetry.proto.logs.v1.SeverityNumber severity_number = 2;
* @param int $var
* @return $this
*/
public function setSeverityNumber($var)
{
GPBUtil::checkEnum($var, \Opentelemetry\Proto\Logs\V1\SeverityNumber::class);
$this->severity_number = $var;
return $this;
}
/**
* The severity text (also known as log level). The original string representation as
* it is known at the source. [Optional].
*
* Generated from protobuf field string severity_text = 3;
* @return string
*/
public function getSeverityText()
{
return $this->severity_text;
}
/**
* The severity text (also known as log level). The original string representation as
* it is known at the source. [Optional].
*
* Generated from protobuf field string severity_text = 3;
* @param string $var
* @return $this
*/
public function setSeverityText($var)
{
GPBUtil::checkString($var, True);
$this->severity_text = $var;
return $this;
}
/**
* A value containing the body of the log record. Can be for example a human-readable
* string message (including multi-line) describing the event in a free form or it can
* be a structured data composed of arrays and maps of other values. [Optional].
*
* Generated from protobuf field .opentelemetry.proto.common.v1.AnyValue body = 5;
* @return \Opentelemetry\Proto\Common\V1\AnyValue|null
*/
public function getBody()
{
return $this->body;
}
public function hasBody()
{
return isset($this->body);
}
public function clearBody()
{
unset($this->body);
}
/**
* A value containing the body of the log record. Can be for example a human-readable
* string message (including multi-line) describing the event in a free form or it can
* be a structured data composed of arrays and maps of other values. [Optional].
*
* Generated from protobuf field .opentelemetry.proto.common.v1.AnyValue body = 5;
* @param \Opentelemetry\Proto\Common\V1\AnyValue $var
* @return $this
*/
public function setBody($var)
{
GPBUtil::checkMessage($var, \Opentelemetry\Proto\Common\V1\AnyValue::class);
$this->body = $var;
return $this;
}
/**
* Additional attributes that describe the specific event occurrence. [Optional].
* Attribute keys MUST be unique (it is not allowed to have more than one
* attribute with the same key).
*
* Generated from protobuf field repeated .opentelemetry.proto.common.v1.KeyValue attributes = 6;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getAttributes()
{
return $this->attributes;
}
/**
* Additional attributes that describe the specific event occurrence. [Optional].
* Attribute keys MUST be unique (it is not allowed to have more than one
* attribute with the same key).
*
* Generated from protobuf field repeated .opentelemetry.proto.common.v1.KeyValue attributes = 6;
* @param \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setAttributes($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Opentelemetry\Proto\Common\V1\KeyValue::class);
$this->attributes = $arr;
return $this;
}
/**
* Generated from protobuf field uint32 dropped_attributes_count = 7;
* @return int
*/
public function getDroppedAttributesCount()
{
return $this->dropped_attributes_count;
}
/**
* Generated from protobuf field uint32 dropped_attributes_count = 7;
* @param int $var
* @return $this
*/
public function setDroppedAttributesCount($var)
{
GPBUtil::checkUint32($var);
$this->dropped_attributes_count = $var;
return $this;
}
/**
* Flags, a bit field. 8 least significant bits are the trace flags as
* defined in W3C Trace Context specification. 24 most significant bits are reserved
* and must be set to 0. Readers must not assume that 24 most significant bits
* will be zero and must correctly mask the bits when reading 8-bit trace flag (use
* flags & LOG_RECORD_FLAGS_TRACE_FLAGS_MASK). [Optional].
*
* Generated from protobuf field fixed32 flags = 8;
* @return int
*/
public function getFlags()
{
return $this->flags;
}
/**
* Flags, a bit field. 8 least significant bits are the trace flags as
* defined in W3C Trace Context specification. 24 most significant bits are reserved
* and must be set to 0. Readers must not assume that 24 most significant bits
* will be zero and must correctly mask the bits when reading 8-bit trace flag (use
* flags & LOG_RECORD_FLAGS_TRACE_FLAGS_MASK). [Optional].
*
* Generated from protobuf field fixed32 flags = 8;
* @param int $var
* @return $this
*/
public function setFlags($var)
{
GPBUtil::checkUint32($var);
$this->flags = $var;
return $this;
}
/**
* A unique identifier for a trace. All logs from the same trace share
* the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes OR
* of length other than 16 bytes is considered invalid (empty string in OTLP/JSON
* is zero-length and thus is also invalid).
* This field is optional.
* The receivers SHOULD assume that the log record is not associated with a
* trace if any of the following is true:
* - the field is not present,
* - the field contains an invalid value.
*
* Generated from protobuf field bytes trace_id = 9;
* @return string
*/
public function getTraceId()
{
return $this->trace_id;
}
/**
* A unique identifier for a trace. All logs from the same trace share
* the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes OR
* of length other than 16 bytes is considered invalid (empty string in OTLP/JSON
* is zero-length and thus is also invalid).
* This field is optional.
* The receivers SHOULD assume that the log record is not associated with a
* trace if any of the following is true:
* - the field is not present,
* - the field contains an invalid value.
*
* Generated from protobuf field bytes trace_id = 9;
* @param string $var
* @return $this
*/
public function setTraceId($var)
{
GPBUtil::checkString($var, False);
$this->trace_id = $var;
return $this;
}
/**
* A unique identifier for a span within a trace, assigned when the span
* is created. The ID is an 8-byte array. An ID with all zeroes OR of length
* other than 8 bytes is considered invalid (empty string in OTLP/JSON
* is zero-length and thus is also invalid).
* This field is optional. If the sender specifies a valid span_id then it SHOULD also
* specify a valid trace_id.
* The receivers SHOULD assume that the log record is not associated with a
* span if any of the following is true:
* - the field is not present,
* - the field contains an invalid value.
*
* Generated from protobuf field bytes span_id = 10;
* @return string
*/
public function getSpanId()
{
return $this->span_id;
}
/**
* A unique identifier for a span within a trace, assigned when the span
* is created. The ID is an 8-byte array. An ID with all zeroes OR of length
* other than 8 bytes is considered invalid (empty string in OTLP/JSON
* is zero-length and thus is also invalid).
* This field is optional. If the sender specifies a valid span_id then it SHOULD also
* specify a valid trace_id.
* The receivers SHOULD assume that the log record is not associated with a
* span if any of the following is true:
* - the field is not present,
* - the field contains an invalid value.
*
* Generated from protobuf field bytes span_id = 10;
* @param string $var
* @return $this
*/
public function setSpanId($var)
{
GPBUtil::checkString($var, False);
$this->span_id = $var;
return $this;
}
}