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

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

Overview

Metadata generated from the segment documents in a trace.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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

Annotations from the trace’s segment documents.

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_zonesArray<Types::AvailabilityZoneDetail>

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

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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

#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)


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_pointTypes::ServiceId

The root of a trace.

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_causesArray<Types::ErrorRootCause>

A collection of ErrorRootCause structures corresponding to the trace segments.

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_causesArray<Types::FaultRootCause>

A collection of FaultRootCause structures corresponding to the trace segments.

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_errorBoolean

The root segment document has a 400 series error.

Returns:

  • (Boolean)


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_faultBoolean

The root segment document has a 500 series error.

Returns:

  • (Boolean)


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_throttleBoolean

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

Returns:

  • (Boolean)


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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

#httpTypes::Http

Information about the HTTP request served by the trace.

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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

#idString

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

Returns:

  • (String)


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_idsArray<Types::InstanceIdDetail>

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

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_partialBoolean

One or more of the segment documents is in progress.

Returns:

  • (Boolean)


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_timeTime

The matched time stamp of a defined event.

Returns:

  • (Time)


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_arnsArray<Types::ResourceARNDetail>

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

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_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)


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_causesArray<Types::ResponseTimeRootCause>

A collection of ResponseTimeRootCause structures corresponding to the trace segments.

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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

#revisionInteger

The revision number of a trace.

Returns:

  • (Integer)


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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_idsArray<Types::ServiceId>

Service IDs from the trace’s segment documents.

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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

#usersArray<Types::TraceUser>

Users from the trace’s segment documents.

Returns:



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/aws-sdk-xray/types.rb', line 3261

class TraceSummary < Struct.new(
  :id,
  :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