OpenTelemetry PHP

Span extends Message
in package

Application

A Span represents a single operation performed by a single component of the system.

The next available field id is 17.

Generated from protobuf message opentelemetry.proto.trace.v1.Span

Properties

$dropped_attributes_count : mixed: dropped_attributes_count is the number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.
$dropped_events_count : mixed: dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.
$dropped_links_count : mixed: dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
$end_time_unix_nano : mixed: end_time_unix_nano is the end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
$flags : mixed: Flags, a bit field.
$kind : mixed: Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify queueing latency associated with the span.
$name : mixed: A description of the span's operation.
$parent_span_id : mixed: The `span_id` of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.
$span_id : mixed: 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).
$start_time_unix_nano : mixed: start_time_unix_nano is the start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
$status : mixed: An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).
$trace_id : mixed: A unique identifier for a trace. All spans 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).
$trace_state : mixed: trace_state conveys information about request position in multiple distributed tracing graphs.
$attributes : mixed: attributes is a collection of key/value pairs. Note, global attributes like server name can be set using the resource API. Examples of attributes: "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36" "/http/server_latency": 300 "example.com/myattribute": true "example.com/score": 10.239 The OpenTelemetry API specification further restricts the allowed value types: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).
$events : mixed: events is a collection of Event items.
$links : mixed: links is a collection of Links, which are references from this span to a span in the same or different trace.

Methods

__construct() : mixed: Constructor.
clearStatus() : mixed
getAttributes() : RepeatedField: attributes is a collection of key/value pairs. Note, global attributes like server name can be set using the resource API. Examples of attributes: "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36" "/http/server_latency": 300 "example.com/myattribute": true "example.com/score": 10.239 The OpenTelemetry API specification further restricts the allowed value types: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).
getDroppedAttributesCount() : int: dropped_attributes_count is the number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.
getDroppedEventsCount() : int: dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.
getDroppedLinksCount() : int: dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
getEndTimeUnixNano() : int|string: end_time_unix_nano is the end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
getEvents() : RepeatedField: events is a collection of Event items.
getFlags() : int: Flags, a bit field.
getKind() : int: Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify queueing latency associated with the span.
getLinks() : RepeatedField: links is a collection of Links, which are references from this span to a span in the same or different trace.
getName() : string: A description of the span's operation.
getParentSpanId() : string: The `span_id` of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.
getSpanId() : string: 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).
getStartTimeUnixNano() : int|string: start_time_unix_nano is the start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
getStatus() : Status|null: An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).
getTraceId() : string: A unique identifier for a trace. All spans 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).
getTraceState() : string: trace_state conveys information about request position in multiple distributed tracing graphs.
hasStatus() : mixed
setAttributes() : $this: attributes is a collection of key/value pairs. Note, global attributes like server name can be set using the resource API. Examples of attributes: "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36" "/http/server_latency": 300 "example.com/myattribute": true "example.com/score": 10.239 The OpenTelemetry API specification further restricts the allowed value types: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).
setDroppedAttributesCount() : $this: dropped_attributes_count is the number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.
setDroppedEventsCount() : $this: dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.
setDroppedLinksCount() : $this: dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
setEndTimeUnixNano() : $this: end_time_unix_nano is the end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
setEvents() : $this: events is a collection of Event items.
setFlags() : $this: Flags, a bit field.
setKind() : $this: Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify queueing latency associated with the span.
setLinks() : $this: links is a collection of Links, which are references from this span to a span in the same or different trace.
setName() : $this: A description of the span's operation.
setParentSpanId() : $this: The `span_id` of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.
setSpanId() : $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).
setStartTimeUnixNano() : $this: start_time_unix_nano is the start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
setStatus() : $this: An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).
setTraceId() : $this: A unique identifier for a trace. All spans 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).
setTraceState() : $this: trace_state conveys information about request position in multiple distributed tracing graphs.

$dropped_attributes_count

dropped_attributes_count is the number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.


    protected
        mixed
    $dropped_attributes_count
     = 0

Generated from protobuf field uint32 dropped_attributes_count = 10;

$dropped_events_count

dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.


    protected
        mixed
    $dropped_events_count
     = 0

Generated from protobuf field uint32 dropped_events_count = 12;

$dropped_links_count

dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.


    protected
        mixed
    $dropped_links_count
     = 0

Generated from protobuf field uint32 dropped_links_count = 14;

$end_time_unix_nano

end_time_unix_nano is the end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.


    protected
        mixed
    $end_time_unix_nano
     = 0

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970. This field is semantically required and it is expected that end_time >= start_time.

Generated from protobuf field fixed64 end_time_unix_nano = 8;

$flags

Flags, a bit field.


    protected
        mixed
    $flags
     = 0

Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace Context specification. To read the 8-bit W3C trace flag, use flags & SPAN_FLAGS_TRACE_FLAGS_MASK. See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions. Bits 8 and 9 represent the 3 states of whether a span's parent is remote. The states are (unknown, is not remote, is remote). To read whether the value is known, use (flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0. To read whether the span is remote, use (flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0. When creating span messages, if the message is logically forwarded from another source with an equivalent flags fields (i.e., usually another OTLP span message), the field SHOULD be copied as-is. If creating from a source that does not have an equivalent flags field (such as a runtime representation of an OpenTelemetry span), the high 22 bits MUST be set to zero. Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero. [Optional].

Generated from protobuf field fixed32 flags = 16;

$kind

Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify queueing latency associated with the span.


    protected
        mixed
    $kind
     = 0

Generated from protobuf field .opentelemetry.proto.trace.v1.Span.SpanKind kind = 6;

$name

A description of the span's operation.


    protected
        mixed
    $name
     = ''

For example, the name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name at the same call point in an application. This makes it easier to correlate spans in different traces. This field is semantically required to be set to non-empty string. Empty value is equivalent to an unknown span name. This field is required.

Generated from protobuf field string name = 5;

$parent_span_id

The `span_id` of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.


    protected
        mixed
    $parent_span_id
     = ''

Generated from protobuf field bytes parent_span_id = 4;

$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).


    protected
        mixed
    $span_id
     = ''

This field is required.

Generated from protobuf field bytes span_id = 2;

$start_time_unix_nano

start_time_unix_nano is the start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.


    protected
        mixed
    $start_time_unix_nano
     = 0

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970. This field is semantically required and it is expected that end_time >= start_time.

Generated from protobuf field fixed64 start_time_unix_nano = 7;

$status

An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).


    protected
        mixed
    $status
     = null

Generated from protobuf field .opentelemetry.proto.trace.v1.Status status = 15;

$trace_id

A unique identifier for a trace. All spans 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).


    protected
        mixed
    $trace_id
     = ''

This field is required.

Generated from protobuf field bytes trace_id = 1;

$trace_state

trace_state conveys information about request position in multiple distributed tracing graphs.


    protected
        mixed
    $trace_state
     = ''

It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header See also https://github.com/w3c/distributed-tracing for more details about this field.

Generated from protobuf field string trace_state = 3;

$attributes

attributes is a collection of key/value pairs. Note, global attributes like server name can be set using the resource API. Examples of attributes: "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36" "/http/server_latency": 300 "example.com/myattribute": true "example.com/score": 10.239 The OpenTelemetry API specification further restricts the allowed value types: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).


    private
        mixed
    $attributes

Generated from protobuf field repeated .opentelemetry.proto.common.v1.KeyValue attributes = 9;

$events

events is a collection of Event items.


    private
        mixed
    $events

Generated from protobuf field repeated .opentelemetry.proto.trace.v1.Span.Event events = 11;

$links

links is a collection of Links, which are references from this span to a span in the same or different trace.


    private
        mixed
    $links

Generated from protobuf field repeated .opentelemetry.proto.trace.v1.Span.Link links = 13;

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $data = NULL ]) : mixed

Parameters

$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $trace_id
      A unique identifier for a trace. All spans 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 required.
@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 required.
@type string $trace_state
      trace_state conveys information about request position in multiple distributed tracing graphs.
      It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header
      See also https://github.com/w3c/distributed-tracing for more details about this field.
@type string $parent_span_id
      The `span_id` of this span's parent span. If this is a root span, then this
      field must be empty. The ID is an 8-byte array.
@type int $flags
      Flags, a bit field.
      Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace
      Context specification. To read the 8-bit W3C trace flag, use
      `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.
      See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.
      Bits 8 and 9 represent the 3 states of whether a span's parent
      is remote. The states are (unknown, is not remote, is remote).
      To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
      To read whether the span is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.
      When creating span messages, if the message is logically forwarded from another source
      with an equivalent flags fields (i.e., usually another OTLP span message), the field SHOULD
      be copied as-is. If creating from a source that does not have an equivalent flags field
      (such as a runtime representation of an OpenTelemetry span), the high 22 bits MUST
      be set to zero.
      Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
      [Optional].
@type string $name
      A description of the span's operation.
      For example, the name can be a qualified method name or a file name
      and a line number where the operation is called. A best practice is to use
      the same display name at the same call point in an application.
      This makes it easier to correlate spans in different traces.
      This field is semantically required to be set to non-empty string.
      Empty value is equivalent to an unknown span name.
      This field is required.
@type int $kind
      Distinguishes between spans generated in a particular context. For example,
      two spans with the same name may be distinguished using `CLIENT` (caller)
      and `SERVER` (callee) to identify queueing latency associated with the span.
@type int|string $start_time_unix_nano
      start_time_unix_nano is the start time of the span. On the client side, this is the time
      kept by the local machine where the span execution starts. On the server side, this
      is the time when the server's application handler starts running.
      Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
      This field is semantically required and it is expected that end_time >= start_time.
@type int|string $end_time_unix_nano
      end_time_unix_nano is the end time of the span. On the client side, this is the time
      kept by the local machine where the span execution ends. On the server side, this
      is the time when the server application handler stops running.
      Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
      This field is semantically required and it is expected that end_time >= start_time.
@type \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $attributes
      attributes is a collection of key/value pairs. Note, global attributes
      like server name can be set using the resource API. Examples of attributes:
          "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
          "/http/server_latency": 300
          "example.com/myattribute": true
          "example.com/score": 10.239
      The OpenTelemetry API specification further restricts the allowed value types:
      https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute
      Attribute keys MUST be unique (it is not allowed to have more than one
      attribute with the same key).
@type int $dropped_attributes_count
      dropped_attributes_count is the number of attributes that were discarded. Attributes
      can be discarded because their keys are too long or because there are too many
      attributes. If this value is 0, then no attributes were dropped.
@type \Opentelemetry\Proto\Trace\V1\Span\Event[]|\Google\Protobuf\Internal\RepeatedField $events
      events is a collection of Event items.
@type int $dropped_events_count
      dropped_events_count is the number of dropped events. If the value is 0, then no
      events were dropped.
@type \Opentelemetry\Proto\Trace\V1\Span\Link[]|\Google\Protobuf\Internal\RepeatedField $links
      links is a collection of Links, which are references from this span to a span
      in the same or different trace.
@type int $dropped_links_count
      dropped_links_count is the number of dropped links after the maximum size was
      enforced. If this value is 0, then no links were dropped.
@type \Opentelemetry\Proto\Trace\V1\Status $status
      An optional final status for this span. Semantically when Status isn't set, it means
      span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).

}

clearStatus()


    public
                    clearStatus() : mixed

getAttributes()


    public
                    getAttributes() : RepeatedField

Generated from protobuf field repeated .opentelemetry.proto.common.v1.KeyValue attributes = 9;

Return values

RepeatedField

getDroppedAttributesCount()


    public
                    getDroppedAttributesCount() : int

Generated from protobuf field uint32 dropped_attributes_count = 10;

Return values

int

getDroppedEventsCount()

dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.


    public
                    getDroppedEventsCount() : int

Generated from protobuf field uint32 dropped_events_count = 12;

Return values

int

getDroppedLinksCount()

dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.


    public
                    getDroppedLinksCount() : int

Generated from protobuf field uint32 dropped_links_count = 14;

Return values

int

getEndTimeUnixNano()


    public
                    getEndTimeUnixNano() : int|string

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970. This field is semantically required and it is expected that end_time >= start_time.

Generated from protobuf field fixed64 end_time_unix_nano = 8;

Return values

int|string

getEvents()

events is a collection of Event items.


    public
                    getEvents() : RepeatedField

Generated from protobuf field repeated .opentelemetry.proto.trace.v1.Span.Event events = 11;

Return values

RepeatedField

getFlags()

Flags, a bit field.


    public
                    getFlags() : int

Generated from protobuf field fixed32 flags = 16;

Return values

int

getKind()


    public
                    getKind() : int

Generated from protobuf field .opentelemetry.proto.trace.v1.Span.SpanKind kind = 6;

Return values

int

getLinks()

links is a collection of Links, which are references from this span to a span in the same or different trace.


    public
                    getLinks() : RepeatedField

Generated from protobuf field repeated .opentelemetry.proto.trace.v1.Span.Link links = 13;

Return values

RepeatedField

getName()

A description of the span's operation.


    public
                    getName() : string

Generated from protobuf field string name = 5;

Return values

string

getParentSpanId()

The `span_id` of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.


    public
                    getParentSpanId() : string

Generated from protobuf field bytes parent_span_id = 4;

Return values

string

getSpanId()


    public
                    getSpanId() : string

This field is required.

Generated from protobuf field bytes span_id = 2;

Return values

string

getStartTimeUnixNano()


    public
                    getStartTimeUnixNano() : int|string

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970. This field is semantically required and it is expected that end_time >= start_time.

Generated from protobuf field fixed64 start_time_unix_nano = 7;

Return values

int|string

getStatus()

An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).


    public
                    getStatus() : Status|null

Generated from protobuf field .opentelemetry.proto.trace.v1.Status status = 15;

Return values

Status|null

getTraceId()


    public
                    getTraceId() : string

This field is required.

Generated from protobuf field bytes trace_id = 1;

Return values

string

getTraceState()

trace_state conveys information about request position in multiple distributed tracing graphs.


    public
                    getTraceState() : string

It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header See also https://github.com/w3c/distributed-tracing for more details about this field.

Generated from protobuf field string trace_state = 3;

Return values

string

hasStatus()


    public
                    hasStatus() : mixed

setAttributes()


    public
                    setAttributes(array<string|int, KeyValue>|RepeatedField $var) : $this

Generated from protobuf field repeated .opentelemetry.proto.common.v1.KeyValue attributes = 9;

Parameters

$var : array<string|int, KeyValue>|RepeatedField

Return values

$this

setDroppedAttributesCount()


    public
                    setDroppedAttributesCount(int $var) : $this

Generated from protobuf field uint32 dropped_attributes_count = 10;

Parameters

$var : int

Return values

$this

setDroppedEventsCount()

dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.


    public
                    setDroppedEventsCount(int $var) : $this

Generated from protobuf field uint32 dropped_events_count = 12;

Parameters

$var : int

Return values

$this

setDroppedLinksCount()

dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.


    public
                    setDroppedLinksCount(int $var) : $this

Generated from protobuf field uint32 dropped_links_count = 14;

Parameters

$var : int

Return values

$this

setEndTimeUnixNano()


    public
                    setEndTimeUnixNano(int|string $var) : $this

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970. This field is semantically required and it is expected that end_time >= start_time.

Generated from protobuf field fixed64 end_time_unix_nano = 8;

Parameters

$var : int|string

Return values

$this

setEvents()

events is a collection of Event items.


    public
                    setEvents(array<string|int, Event>|RepeatedField $var) : $this

Generated from protobuf field repeated .opentelemetry.proto.trace.v1.Span.Event events = 11;

Parameters

$var : array<string|int, Event>|RepeatedField

Return values

$this

setFlags()

Flags, a bit field.


    public
                    setFlags(int $var) : $this

Generated from protobuf field fixed32 flags = 16;

Parameters

$var : int

Return values

$this

setKind()


    public
                    setKind(int $var) : $this

Generated from protobuf field .opentelemetry.proto.trace.v1.Span.SpanKind kind = 6;

Parameters

$var : int

Return values

$this

setLinks()

links is a collection of Links, which are references from this span to a span in the same or different trace.


    public
                    setLinks(array<string|int, Link>|RepeatedField $var) : $this

Generated from protobuf field repeated .opentelemetry.proto.trace.v1.Span.Link links = 13;

Parameters

$var : array<string|int, Link>|RepeatedField

Return values

$this

setName()

A description of the span's operation.


    public
                    setName(string $var) : $this

Generated from protobuf field string name = 5;

Parameters

$var : string

Return values

$this

setParentSpanId()

The `span_id` of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.


    public
                    setParentSpanId(string $var) : $this

Generated from protobuf field bytes parent_span_id = 4;

Parameters

$var : string

Return values

$this

setSpanId()


    public
                    setSpanId(string $var) : $this

This field is required.

Generated from protobuf field bytes span_id = 2;

Parameters

$var : string

Return values

$this

setStartTimeUnixNano()


    public
                    setStartTimeUnixNano(int|string $var) : $this

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970. This field is semantically required and it is expected that end_time >= start_time.

Generated from protobuf field fixed64 start_time_unix_nano = 7;

Parameters

$var : int|string

Return values

$this

setStatus()

An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).


    public
                    setStatus(Status $var) : $this

Generated from protobuf field .opentelemetry.proto.trace.v1.Status status = 15;

Parameters

$var : Status

Return values

$this

setTraceId()


    public
                    setTraceId(string $var) : $this

This field is required.

Generated from protobuf field bytes trace_id = 1;

Parameters

$var : string

Return values

$this

setTraceState()

trace_state conveys information about request position in multiple distributed tracing graphs.


    public
                    setTraceState(string $var) : $this

It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header See also https://github.com/w3c/distributed-tracing for more details about this field.

Generated from protobuf field string trace_state = 3;

Parameters

$var : string

Return values

$this

Span extends Message in package Application

Table of Contents

Properties

Methods

Properties

$dropped_attributes_count

$dropped_events_count

$dropped_links_count

$end_time_unix_nano

$flags

$kind

$name

$parent_span_id

$span_id

$start_time_unix_nano

$status

$trace_id

$trace_state

$attributes

$events

$links

Methods

__construct()

Parameters

clearStatus()

getAttributes()

Return values

getDroppedAttributesCount()

Return values

getDroppedEventsCount()

Return values

getDroppedLinksCount()

Return values

getEndTimeUnixNano()

Return values

getEvents()

Return values

getFlags()

Return values

getKind()

Return values

getLinks()

Return values

getName()

Return values

getParentSpanId()

Return values

getSpanId()

Return values

getStartTimeUnixNano()

Return values

getStatus()

Return values

getTraceId()

Return values

getTraceState()

Return values

hasStatus()

setAttributes()

Parameters

Return values

setDroppedAttributesCount()

Parameters

Return values

setDroppedEventsCount()

Parameters

Return values

setDroppedLinksCount()

Parameters

Return values

setEndTimeUnixNano()

Parameters

Return values

setEvents()

Parameters

Return values

setFlags()

Parameters

Return values

setKind()

Span extends Message
in package

Application