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

Instance Attribute Summary

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

  Annotations from the trace’s segment documents.

• #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.

• #has_error ⇒ Boolean

  One or more of the segment documents has a 400 series error.

• #has_fault ⇒ Boolean

  One or more of the segment documents 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.

• #is_partial ⇒ Boolean

  One or more of the segment documents is in progress.

• #response_time ⇒ Float

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

• #service_ids ⇒ Array<Types::ServiceId>

  Service IDs from the trace’s segment documents.

• #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 874

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  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 874

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  include Aws::Structure
end

#has_error ⇒ Boolean

One or more of the segment documents has a 400 series error.

Returns:

• (Boolean)

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

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  include Aws::Structure
end

#has_fault ⇒ Boolean

One or more of the segment documents has a 500 series error.

Returns:

• (Boolean)

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

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  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 874

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  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 874

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  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 874

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  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 874

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  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 874

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  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 874

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  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 874

class TraceSummary < Struct.new(
  :id,
  :duration,
  :response_time,
  :has_fault,
  :has_error,
  :has_throttle,
  :is_partial,
  :http,
  :annotations,
  :users,
  :service_ids)
  include Aws::Structure
end