You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb

Overview

Metadata generated from the segment documents in a trace.

Instance Attribute Summary collapse

Instance Attribute Details

#annotationsHash<String,Array<Types::ValueWithServiceIds>>

Annotations from the trace's segment documents.

Returns:



874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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

#durationFloat

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)


874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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_errorBoolean

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

Returns:

  • (Boolean)


874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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_faultBoolean

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

Returns:

  • (Boolean)


874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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_throttleBoolean

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

Returns:

  • (Boolean)


874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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

#httpTypes::Http

Information about the HTTP request served by the trace.

Returns:



874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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

#idString

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

Returns:

  • (String)


874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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_partialBoolean

One or more of the segment documents is in progress.

Returns:

  • (Boolean)


874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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_timeFloat

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)


874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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_idsArray<Types::ServiceId>

Service IDs from the trace's segment documents.

Returns:



874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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

#usersArray<Types::TraceUser>

Users from the trace's segment documents.

Returns:



874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-xray/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