Class: Aws::XRay::Types::TraceSummary

Inherits:

Struct

• Object
• Struct
• Aws::XRay::Types::TraceSummary

Includes:

Structure

Defined in:

lib/aws-sdk-xray/types.rb

Overview

Metadata generated from the segment documents in a trace.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #annotations ⇒ Hash<String,Array<Types::ValueWithServiceIds>>

  Annotations from the trace’s segment documents.

• #availability_zones ⇒ Array<Types::AvailabilityZoneDetail>

  A list of Availability Zones for any zone corresponding to the trace segments.

• #duration ⇒ Float

  The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

• #entry_point ⇒ Types::ServiceId

  The root of a trace.

• #error_root_causes ⇒ Array<Types::ErrorRootCause>

  A collection of ErrorRootCause structures corresponding to the trace segments.

• #fault_root_causes ⇒ Array<Types::FaultRootCause>

  A collection of FaultRootCause structures corresponding to the trace segments.

• #has_error ⇒ Boolean

  The root segment document has a 400 series error.

• #has_fault ⇒ Boolean

  The root segment document has a 500 series error.

• #has_throttle ⇒ Boolean

  One or more of the segment documents has a 429 throttling error.

• #http ⇒ Types::Http

  Information about the HTTP request served by the trace.

• #id ⇒ String

  The unique identifier for the request that generated the trace’s segments and subsegments.

• #instance_ids ⇒ Array<Types::InstanceIdDetail>

  A list of EC2 instance IDs for any instance corresponding to the trace segments.

• #is_partial ⇒ Boolean

  One or more of the segment documents is in progress.

• #matched_event_time ⇒ Time

  The matched time stamp of a defined event.

• #resource_arns ⇒ Array<Types::ResourceARNDetail>

  A list of resource ARNs for any resource corresponding to the trace segments.

• #response_time ⇒ Float

  The length of time in seconds between the start and end times of the root segment.

• #response_time_root_causes ⇒ Array<Types::ResponseTimeRootCause>

  A collection of ResponseTimeRootCause structures corresponding to the trace segments.

• #revision ⇒ Integer

  The revision number of a trace.

• #service_ids ⇒ Array<Types::ServiceId>

  Service IDs from the trace’s segment documents.

• #start_time ⇒ Time

  The start time of a trace, based on the earliest trace segment start time.

• #users ⇒ Array<Types::TraceUser>

  Users from the trace’s segment documents.

Instance Attribute Details

#annotations ⇒ Hash<String,Array<Types::ValueWithServiceIds>>

Annotations from the trace’s segment documents.

Returns:

• (Hash<String,Array<Types::ValueWithServiceIds>>)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zones ⇒ Array<Types::AvailabilityZoneDetail>

A list of Availability Zones for any zone corresponding to the trace segments.

Returns:

• (Array<Types::AvailabilityZoneDetail>)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#duration ⇒ Float

The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

Returns:

• (Float)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#entry_point ⇒ Types::ServiceId

The root of a trace.

Returns:

• (Types::ServiceId)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#error_root_causes ⇒ Array<Types::ErrorRootCause>

A collection of ErrorRootCause structures corresponding to the trace segments.

Returns:

• (Array<Types::ErrorRootCause>)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#fault_root_causes ⇒ Array<Types::FaultRootCause>

A collection of FaultRootCause structures corresponding to the trace segments.

Returns:

• (Array<Types::FaultRootCause>)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#has_error ⇒ Boolean

The root segment document has a 400 series error.

Returns:

• (Boolean)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#has_fault ⇒ Boolean

The root segment document has a 500 series error.

Returns:

• (Boolean)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#has_throttle ⇒ Boolean

One or more of the segment documents has a 429 throttling error.

Returns:

• (Boolean)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#http ⇒ Types::Http

Information about the HTTP request served by the trace.

Returns:

• (Types::Http)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier for the request that generated the trace’s segments and subsegments.

Returns:

• (String)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#instance_ids ⇒ Array<Types::InstanceIdDetail>

A list of EC2 instance IDs for any instance corresponding to the trace segments.

Returns:

• (Array<Types::InstanceIdDetail>)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#is_partial ⇒ Boolean

One or more of the segment documents is in progress.

Returns:

• (Boolean)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#matched_event_time ⇒ Time

The matched time stamp of a defined event.

Returns:

• (Time)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arns ⇒ Array<Types::ResourceARNDetail>

A list of resource ARNs for any resource corresponding to the trace segments.

Returns:

• (Array<Types::ResourceARNDetail>)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#response_time ⇒ Float

The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.

Returns:

• (Float)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#response_time_root_causes ⇒ Array<Types::ResponseTimeRootCause>

A collection of ResponseTimeRootCause structures corresponding to the trace segments.

Returns:

• (Array<Types::ResponseTimeRootCause>)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#revision ⇒ Integer

The revision number of a trace.

Returns:

• (Integer)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#service_ids ⇒ Array<Types::ServiceId>

Service IDs from the trace’s segment documents.

Returns:

• (Array<Types::ServiceId>)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time of a trace, based on the earliest trace segment start time.

Returns:

• (Time)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end

#users ⇒ Array<Types::TraceUser>

Users from the trace’s segment documents.

Returns:

• (Array<Types::TraceUser>)

# File 'lib/aws-sdk-xray/types.rb', line 3553

class TraceSummary < Struct.new(
  :id,
  :start_time,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids,
  :resource_arns,
  :instance_ids,
  :availability_zones,
  :entry_point,
  :fault_root_causes,
  :error_root_causes,
  :response_time_root_causes,
  :revision,
  :matched_event_time)
  SENSITIVE = []
  include Aws::Structure
end