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);
Methods
__construct
Create a new MessageEvent.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 | |
|---|---|
| Type | Description |
array | |
Constants
TYPE_UNSPECIFIED
Value: \Google\Cloud\Trace\V2\Span\TimeEvent\MessageEvent\Type::TYPE_UNSPECIFIEDTYPE_SENT
Value: \Google\Cloud\Trace\V2\Span\TimeEvent\MessageEvent\Type::SENTTYPE_RECEIVED
Value: \Google\Cloud\Trace\V2\Span\TimeEvent\MessageEvent\Type::RECEIVED