Stackdriver Trace Client - Class MessageEvent (1.7.0)

Reference documentation and code samples for the Stackdriver Trace Client class MessageEvent.

This plain PHP class represents an MessageEvent resource. An event describing a message sent/received between Spans.

Example:

use Google\Cloud\Trace\MessageEvent;

$messageEvent = new MessageEvent('some-event-id');
$span->addTimeEvent($messageEvent);

Namespace

Google \ Cloud \ Trace

Methods

__construct

Create a new MessageEvent.

Parameters
NameDescription
id

An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span.

options array

Configuration options.

↳ type string

Type of MessageEvent. Indicates whether the message was sent or received. Defaults to TYPE_UNSPECIFIED.

↳ uncompressedSizeBytes int

The number of uncompressed bytes sent or received.

↳ compressedSizeBytes int

The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed.

info

Returns a serializable array representing this MessageEvent.

Returns
TypeDescription
array

Constants

TYPE_UNSPECIFIED

Value: \Google\Cloud\Trace\V2\Span\TimeEvent\MessageEvent\Type::TYPE_UNSPECIFIED

TYPE_SENT

Value: \Google\Cloud\Trace\V2\Span\TimeEvent\MessageEvent\Type::SENT

TYPE_RECEIVED

Value: \Google\Cloud\Trace\V2\Span\TimeEvent\MessageEvent\Type::RECEIVED