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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#categories ⇒ Array<String>

The categories that label and describe the type of insight.

Returns:

  • (Array<String>) 


1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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_statistics ⇒ Types::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.

Returns:



1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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_time ⇒ Time

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

Returns:

  • (Time) 


1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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_arn ⇒ String

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

Returns:

  • (String) 


1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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_name ⇒ String

The name of the group that the insight belongs to.

Returns:

  • (String) 


1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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_id ⇒ String

The insights unique identifier.

Returns:

  • (String) 


1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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_id ⇒ Types::ServiceId

Returns:



1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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_statistics ⇒ Types::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.

Returns:



1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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_time ⇒ Time

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

Returns:

  • (Time) 


1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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

#state ⇒ String

The current state of the insight.

Returns:

  • (String) 


1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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

#summary ⇒ String

A brief description of the insight.

Returns:

  • (String) 


1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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_services ⇒ Array<Types::AnomalousService>

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

Returns:



1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1557

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