Class: Aws::XRay::Types::Insight

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

Overview

When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#categoriesArray<String>

The categories that label and describe the type of insight.

Returns:

  • (Array<String>)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_impact_statisticsTypes::RequestImpactStatistics

The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.



1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTime

The time, in Unix seconds, at which the insight ended.

Returns:

  • (Time)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#group_arnString

The Amazon Resource Name (ARN) of the group that the insight belongs to.

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#group_nameString

The name of the group that the insight belongs to.

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#insight_idString

The insights unique identifier.

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#root_cause_service_idTypes::ServiceId

Returns:



1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#root_cause_service_request_impact_statisticsTypes::RequestImpactStatistics

The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.



1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The time, in Unix seconds, at which the insight began.

Returns:

  • (Time)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The current state of the insight.

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#summaryString

A brief description of the insight.

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end

#top_anomalous_servicesArray<Types::AnomalousService>

The service within the insight that is most impacted by the incident.

Returns:



1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1724

class Insight < Struct.new(
  :insight_id,
  :group_arn,
  :group_name,
  :root_cause_service_id,
  :categories,
  :state,
  :start_time,
  :end_time,
  :summary,
  :client_request_impact_statistics,
  :root_cause_service_request_impact_statistics,
  :top_anomalous_services)
  SENSITIVE = []
  include Aws::Structure
end