Options
All
  • Public
  • Public/Protected
  • All
Menu

Segment Document.

Object follows AWS Documention

Hierarchy

  • Segment

Index

Properties

annotations?: TagValue

Object with key-value pairs that you want X-Ray to index for search.

end_time?: number

That is the time the segment was closed, in floating point seconds in epoch time.

error?: boolean

Indicating that a client error occurred.

fault?: boolean

Indicating that a server error occurred.

http?: Http

Object with information about an outgoing HTTP call.

id: string

A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.

in_progress: boolean

That is set to true instead of specifying an end_time to record that a subsegment is started, but is not complete.

metadata?: Metadata

Object with any additional data that you want to store in the segment.

name: string

The logical name of the service that handled the request, up to 200 characters. For example, your application's name or domain name. Names can contain Unicode letters, numbers, and whitespace, and the following symbols: _, ., :, /, %, &, #, =, +, , -, @

parent_id?: string

Segment ID of the subsegment's parent segment. Required only if sending a subsegment separately.

sql?: SQL

Object with information about SQL call.

start_time: number

That is the time the segment was created, in floating point seconds in epoch time.

throttle?: boolean

Indicating that a request was throttled.

trace_id: string

A unique identifier that connects all segments and subsegments originating from a single client request. Trace ID Format

type?: string

Required only if sending a subsegment separately.

user?: string

A string that identifies the user who sent the request.