EC2 instance monitoring

Adds alarms to monitor a particular EC2 instance's CPU, network, and EBS, and forwards them to Slack or Microsoft Teams managed by marbot.

Usage

1. Create a new directory
2. Within the new directory, create a file main.tf with the following content:

provider "aws" {}

module "marbot-monitoring-ec2-instance" {
  source   = "marbot-io/marbot-monitoring-ec2-instance/aws"
  #version = "x.y.z"         # we recommend to pin the version

  endpoint_id   = "" # to get this value, select a channel where marbot belongs to and send a message like this: "@marbot show me my endpoint id"
  instance_id   = "" # the EC2 instance id (e.g, i-123456)
}

3. Run the following commands:

terraform init
terraform apply

Config via tags

You can also configure this module by tagging the EC2 instance (required v0.8.0 or higher). Tags take precedence over variables (tags override variables).

tag key	default value	allowed values
marbot	on	on,off
marbot:cpu-utilization	variable cpu_utilization	static,anomaly_detection,static_anomaly_detection,off
marbot:cpu-utilization:threshold	variable cpu_utilization_threshold	0-100
marbot:cpu-utilization:period	variable cpu_utilization_period	<= 86400 and multiple of 60
marbot:cpu-utilization:evaluation-periods	variable cpu_utilization_evaluation_periods	>= 1 and $period*$evaluation-periods <= 86400
marbot:cpu-credit-balance	variable cpu_credit_balance	static,anomaly_detection,off
marbot:cpu-credit-balance:threshold	variable cpu_credit_balance_threshold	>= 0
marbot:cpu-credit-balance:period	variable cpu_credit_balance_period	<= 86400 and multiple of 60
marbot:cpu-credit-balance:evaluation-periods	variable cpu_credit_balance_evaluation_periods	>= 1 and $period*$evaluation-periods <= 86400
marbot:ebs-io-credit-balance	variable ebs_io_credit_balance	static,anomaly_detection,off
marbot:ebs-io-credit-balance:threshold	variable ebs_io_credit_balance_threshold	0-100
marbot:ebs-io-credit-balance:period	variable ebs_io_credit_balance_period	<= 86400 and multiple of 60
marbot:ebs-io-credit-balance:evaluation-periods	variable ebs_io_credit_balance_evaluation_periods	>= 1 and $period*$evaluation-periods <= 86400
marbot:ebs-throughput-credit-balance	variable ebs_throughput_credit_balance	static,anomaly_detection,off
marbot:ebs-throughput-credit-balance:threshold	variable ebs_throughput_credit_balance_threshold	0-100
marbot:ebs-throughput-credit-balance:period	variable ebs_throughput_credit_balance_period	<= 86400 and multiple of 60
marbot:ebs-throughput-credit-balance:evaluation-periods	variable ebs_throughput_credit_balance_evaluation_periods	>= 1 and $period*$evaluation-periods <= 86400
marbot:network-utilization	variable network_utilization	static,anomaly_detection,static_anomaly_detection,off
marbot:network-utilization:threshold	variable network_utilization_threshold	0-100
marbot:network-utilization:period	variable network_utilization_period	<= 86400 and multiple of 60
marbot:network-utilization:evaluation-periods	variable network_utilization_evaluation_periods	>= 1 and $period*$evaluation-periods <= 86400

Deprecated config via tags

tag key	default value	allowed values
marbot:enabled	true	true,false
marbot:cpu-utilization:threshold	variable cpu_utilization_threshold	0-100; set to -1 to disable or -2 for anomaly detection
marbot:cpu-credit-balance:threshold	variable cpu_credit_balance_threshold	>= 0; set to -1 to disable or -2 for anomaly detection
marbot:ebs-io-credit-balance:threshold	variable ebs_io_credit_balance_threshold	0-100; set to -1 to disable or -2 for anomaly detection
marbot:ebs-throughput-credit-balance:threshold	variable ebs_throughput_credit_balance_threshold	0-100; set to -1 to disable or -2 for anomaly detection
marbot:network-utilization:threshold	variable network_utilization_threshold	0-100; set to -1 to disable or -2 for anomaly detection

Update procedure

1. Update the version
2. Run the following commands:

terraform get
terraform apply

License

All modules are published under Apache License Version 2.0.

About

A marbot.io project. Engineered by widdix.