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

Inherits:

Struct

• Object
• Struct
• Aws::XRay::Types::Insight

Includes:

Structure

Defined in:

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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #categories ⇒ Array<String>

  The categories that label and describe the type of insight.

• #client_request_impact_statistics ⇒ Types::RequestImpactStatistics

  The impact statistics of the client side service.

• #end_time ⇒ Time

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

• #group_arn ⇒ String

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

• #group_name ⇒ String

  The name of the group that the insight belongs to.

• #insight_id ⇒ String

  The insights unique identifier.

• #root_cause_service_id ⇒ Types::ServiceId
• #root_cause_service_request_impact_statistics ⇒ Types::RequestImpactStatistics

  The impact statistics of the root cause service.

• #start_time ⇒ Time

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

• #state ⇒ String

  The current state of the insight.

• #summary ⇒ String

  A brief description of the insight.

• #top_anomalous_services ⇒ Array<Types::AnomalousService>

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

Instance Attribute Details

#categories ⇒ Array<String>

The categories that label and describe the type of insight.

Returns:

• (Array<String>)

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

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:

• (Types::RequestImpactStatistics)

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

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)

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

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)

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

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)

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

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)

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

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:

• (Types::ServiceId)

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

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:

• (Types::RequestImpactStatistics)

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

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)

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

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)

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

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)

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

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:

• (Array<Types::AnomalousService>)

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

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