TimeEvents

A collection of TimeEvents. A TimeEvent is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans.

JSON representation
{
  "timeEvent": [
    {
      object (TimeEvent)
    }
  ],
  "droppedAnnotationsCount": integer,
  "droppedMessageEventsCount": integer
}
Fields
timeEvent[]

object (TimeEvent)

A collection of TimeEvents.

droppedAnnotationsCount

integer

The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped.

droppedMessageEventsCount

integer

The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped.

TimeEvent

A time-stamped annotation or message event in the Span.

JSON representation
{
  "time": string,

  // Union field value can be only one of the following:
  "annotation": {
    object (Annotation)
  },
  "messageEvent": {
    object (MessageEvent)
  }
  // End of list of possible types for union field value.
}
Fields
time

string (Timestamp format)

The timestamp indicating the time the event occurred.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Union field value. A TimeEvent can contain either an Annotation object or a MessageEvent object, but not both. value can be only one of the following:
annotation

object (Annotation)

Text annotation with a set of attributes.

messageEvent

object (MessageEvent)

An event describing a message sent/received between Spans.

Annotation

Text annotation with a set of attributes.

JSON representation
{
  "description": {
    object (TruncatableString)
  },
  "attributes": {
    object (Attributes)
  }
}
Fields
description

object (TruncatableString)

A user-supplied message describing the event. The maximum length for the description is 256 bytes.

attributes

object (Attributes)

A set of attributes on the annotation. You can have up to 4 attributes per Annotation.

MessageEvent

An event describing a message sent/received between Spans.

JSON representation
{
  "type": enum (Type),
  "id": string,
  "uncompressedSizeBytes": string,
  "compressedSizeBytes": string
}
Fields
type

enum (Type)

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

id

string (int64 format)

An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents.

uncompressedSizeBytes

string (int64 format)

The number of uncompressed bytes sent or received.

compressedSizeBytes

string (int64 format)

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

Type

Indicates whether the message was sent or received.

Enums
TYPE_UNSPECIFIED Unknown event type.
SENT Indicates a sent message.
RECEIVED Indicates a received message.