observations
Creates, updates, deletes, gets or lists an observations resource.
Overview
| Name | observations |
| Type | Resource |
| Id | aws.application_insights.observations |
Fields
The following fields are returned by SELECT queries:
- describe_observation
| Name | Datatype | Description |
|---|---|---|
cloud_watch_event_detail_type | string | The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification. |
cloud_watch_event_id | string | The ID of the CloudWatch Event-based observation related to the detected problem. |
cloud_watch_event_source | string | The source of the CloudWatch Event. (EC2, CODE_DEPLOY, HEALTH, RDS) |
code_deploy_application | string | The CodeDeploy application to which the deployment belongs. |
code_deploy_deployment_group | string | The deployment group to which the CodeDeploy deployment belongs. |
code_deploy_deployment_id | string | The deployment ID of the CodeDeploy-based observation related to the detected problem. |
code_deploy_instance_group_id | string | The instance group to which the CodeDeploy instance belongs. |
code_deploy_state | string | The status of the CodeDeploy deployment, for example SUCCESS or FAILURE. |
ebs_cause | string | The cause of an EBS CloudWatch event. |
ebs_event | string | The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume. |
ebs_request_id | string | The request ID of an EBS CloudWatch event. |
ebs_result | string | The result of an EBS CloudWatch event, such as failed or succeeded. |
ec_2_state | string | The state of the instance, such as STOPPING or TERMINATING. |
end_time | string (date-time) | The time when the observation ended, in epoch seconds. |
health_event_arn | string | The Amazon Resource Name (ARN) of the Health Event-based observation. |
health_event_description | string | The description of the Health event provided by the service, such as Amazon EC2. |
health_event_type_category | string | The category of the Health event, such as issue. |
health_event_type_code | string | The type of the Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE. |
health_service | string | The service to which the Health Event belongs, such as EC2. |
id | string | The ID of the observation type. (pattern: <code>o-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>) |
line_time | string (date-time) | The timestamp in the CloudWatch Logs that specifies when the matched line occurred. |
log_filter | string | The log filter of the observation. (ERROR, WARN, INFO) |
log_group | string | The log group name. |
log_text | string | The log text of the observation. |
metric_name | string | The name of the observation metric. |
metric_namespace | string | The namespace of the observation metric. |
rds_event_categories | string | The category of an RDS event. |
rds_event_message | string | The message of an RDS event. |
s3_event_name | string | The name of the S3 CloudWatch Event-based observation. |
source_arn | string | The source resource ARN of the observation. |
source_type | string | The source type of the observation. |
start_time | string (date-time) | The time when the observation was first detected, in epoch seconds. |
states_arn | string | The Amazon Resource Name (ARN) of the step function-based observation. |
states_execution_arn | string | The Amazon Resource Name (ARN) of the step function execution-based observation. |
states_input | string | The input to the step function-based observation. |
states_status | string | The status of the step function-related observation. |
unit | string | The unit of the source observation metric. |
value | number (double) | The value of the source observation metric. |
x_ray_error_percent | integer | The X-Ray request error percentage for this node. |
x_ray_fault_percent | integer | The X-Ray request fault percentage for this node. |
x_ray_node_name | string | The name of the X-Ray node. |
x_ray_node_type | string | The type of the X-Ray node. |
x_ray_request_average_latency | integer (int64) | The X-Ray node request average latency for this node. |
x_ray_request_count | integer | The X-Ray request count for this node. |
x_ray_throttle_percent | integer | The X-Ray request throttle percentage for this node. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_observation | select | region | Describes an anomaly or error with the application. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_observation
Describes an anomaly or error with the application.
SELECT
cloud_watch_event_detail_type,
cloud_watch_event_id,
cloud_watch_event_source,
code_deploy_application,
code_deploy_deployment_group,
code_deploy_deployment_id,
code_deploy_instance_group_id,
code_deploy_state,
ebs_cause,
ebs_event,
ebs_request_id,
ebs_result,
ec_2_state,
end_time,
health_event_arn,
health_event_description,
health_event_type_category,
health_event_type_code,
health_service,
id,
line_time,
log_filter,
log_group,
log_text,
metric_name,
metric_namespace,
rds_event_categories,
rds_event_message,
s3_event_name,
source_arn,
source_type,
start_time,
states_arn,
states_execution_arn,
states_input,
states_status,
unit,
value,
x_ray_error_percent,
x_ray_fault_percent,
x_ray_node_name,
x_ray_node_type,
x_ray_request_average_latency,
x_ray_request_count,
x_ray_throttle_percent
FROM aws.application_insights.observations
WHERE region = '{{ region }}' -- required
;