EC2

ENTERPRISE: Built-in integrations are available for Sensu Enterprise users only.

Overview

Deregister Sensu clients from the client registry, if they no longer have an associated Amazon Web Services (AWS) EC2 instance in the allowed state(s). This enterprise handler (integration) will only work if Sensu clients are named using the EC2 instance ID, for the instance on which they reside. The ec2 enterprise handler requires valid AWS IAM user credentials with the EC2 describe instances action in a policy, e.g. ec2:DescribeInstances.

Configuration

Example(s)

The following is an example global configuration for the ec2 enterprise handler (integration).

{
  "ec2": {
    "region": "us-west-2",
    "access_key_id": "xxxxxxxxxxxxx",
    "secret_access_key": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "allowed_instance_states": ["running"],
    "timeout": 10
  }
}

Integration Specification

NOTE: the following integration definition attributes may be overwritten by the corresponding Sensu client definition ec2 attributes, which are included in event data.

ec2 attributes

The following attributes are configured within the {"ec2": {} } configuration scope.

region
description The AWS EC2 region to query for EC2 instance state(s).
required false
type String
default us-east-1
example
"region": "us-west-1"
access_key_id
description The AWS IAM user access key ID to use when querying the EC2 API.
required true
type String
example
"access_key_id": "xxxxxxxxxxxxx"
secret_access_key
description The AWS IAM user secret access key to use when querying the EC2 API.
required true
type String
example
"secret_access_key": "xxxxxxxxxxxxxxxxxxxxxxxxx"
allowed_instance_states
description An array of allowed EC2 instance states. Each array item must each be a string. Any other state(s) will cause the Sensu client to be deregistered.
required false
type Array
allowed values running, stopping, stopped, shutting-down, terminated, rebooting, pending
default ["running"]
example
"allowed_instance_states": ["running", "rebooting"]
filters
description An array of Sensu event filters (names) to use when filtering events for the handler. Each array item must be a string. Specified filters are merged with default values.
required false
type Array
default
["handle_when", "check_dependencies"]
example
"filters": ["recurrence", "production"]
severities
description An array of check result severities the handler will handle. NOTE: event resolution bypasses this filtering.
required false
type Array
allowed values ok, warning, critical, unknown
default
["warning", "critical", "unknown"]
example
 "severities": ["critical", "unknown"]
timeout
description The handler execution duration timeout in seconds (hard stop).
required false
type Integer
default 10
example
"timeout": 30

Cross-Account Access

Cross-account access lets you use IAM-defined trust relationships to access a Sensu Enterprise instance from EC2 clients across multiple AWS accounts.

Client Configuration

The EC2 integration supports account access configuration at the client level. To configure account access, add the account attribute to the Sensu client configuration within the ec2 scope.

Client Configuration Example

{
    "client": {
      "name": "i-424242",
      "subscriptions": ["production"],
      "ec2": {
          "account": "sensuapp"
      }
    }
}

ec2 attributes

account
description The name of the account Sensu Enterprise should use to access EC2, used internally to Sensu only
required false
type String
example
"account": "sensuapp"

Integration Configuration

To enable cross-account support in the EC2 integration, add the accounts attributes, name and role_arn, to the EC2 integration configuration in Sensu. When processing events from clients with an ec2.account attribute, Sensu Enterprise applies the matching Amazon resource name (role_arn) stored in the integration configuration to access EC2.

Integration Configuration Example

{
  "ec2": {
    "region": "us-west-2",
    "access_key_id": "xxxxxxxxxxxxx",
    "secret_access_key": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "allowed_instance_states": ["running"],
    "timeout": 10,
    "accounts": [
      {
        "name": "sensuapp",
        "role_arn": "arn:aws:iam::xxxxxxxxxx:role/CrossAccountSignin"
      }
    ]
  }
}

accounts attributes

accounts
description Amazon resource names to use to access EC2
required false
type Array of hashes
example
"accounts": [
  {
    "name": "sensuapp",
    "role_arn": "arn:aws:iam::xxxxxxxxxx:role/CrossAccountSignin"
  }
]
name
description Account name configured in the Sensu client
required false
type String
example
"name": "sensuapp"
role_arn
description Amazon resource name for the account
required false
type String
example
"role_arn": "arn:aws:iam::xxxxxxxxxx:role/CrossAccountSignin"