Skip to content
Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic
HCL Makefile
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Update README (#1) Jul 13, 2018
examples Updated Marbot integration example May 30, 2018
.gitignore Update README (#1) Jul 13, 2018
.travis.yml Update README (#1) Jul 13, 2018
Makefile Update README (#1) Jul 13, 2018
README.md Updated readme.md/readme.yml with working url (#9) Feb 10, 2019
README.yaml Updated readme.md/readme.yml with working url (#9) Feb 10, 2019
alarms.tf Correct cpu credit balance metric name (#6) Dec 12, 2018
main.tf Fix policy for CloudWatch Alarms (#4) Aug 14, 2018
outputs.tf
variables.tf Initial Commit May 30, 2018

README.md

Cloud Posse

terraform-aws-rds-cloudwatch-sns-alarms

Build Status Latest Release Slack Community

Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic.

Create a set of sane RDS CloudWatch alerts for monitoring the health of an RDS instance.


This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Usage

area metric comparison operator threshold rationale
Storage BurstBalance < 20 % 20 % of credits allow you to burst for a few minutes which gives you enough time to a) fix the inefficiency, b) add capacity or c) switch to io1 storage type.
Storage DiskQueueDepth > 64 This number is calculated from our experience with RDS workloads.
Storage FreeStorageSpace < 2 GB 2 GB usually provides enough time to a) fix why so much space is consumed or b) add capacity. You can also modify this value to 10% of your database capacity.
CPU CPUUtilization > 80 % Queuing theory tells us the latency increases exponentially with utilization. In practice, we see higher latency when utilization exceeds 80% and unacceptable high latency with utilization above 90%
CPU CPUCreditBalance < 20 One credit equals 1 minute of 100% usage of a vCPU. 20 credits should give you enough time to a) fix the inefficiency, b) add capacity or c) don't use t2 type.
Memory FreeableMemory < 64 MB This number is calculated from our experience with RDS workloads.
Memory SwapUsage > 256 MB Sometimes you can not entirely avoid swapping. But once the database accesses paged memory, it will slow down.

Examples

See the examples/ directory for working examples.

resource "aws_db_instance" "default" {
  allocated_storage    = 10
  storage_type         = "gp2"
  engine               = "mysql"
  engine_version       = "5.7"
  instance_class       = "db.t2.micro"
  identifier_prefix    = "rds-server-example"
  name                 = "mydb"
  username             = "foo"
  password             = "foobarbaz"
  parameter_group_name = "default.mysql5.7"
  apply_immediately    = "true"
  skip_final_snapshot  = "true"
}

module "rds_alarms" {
  source         = "git::https://github.com/cloudposse/terraform-aws-rds-cloudwatch-sns-alarms.git?ref=tags/0.1.5"
  db_instance_id = "${aws_db_instance.default.id}"
}

Inputs

Name Description Type Default Required
burst_balance_threshold The minimum percent of General Purpose SSD (gp2) burst-bucket I/O credits available. string 20 no
cpu_credit_balance_threshold The minimum number of CPU credits (t2 instances only) available. string 20 no
cpu_utilization_threshold The maximum percentage of CPU utilization. string 80 no
db_instance_id The instance ID of the RDS database instance that you want to monitor. string - yes
disk_queue_depth_threshold The maximum number of outstanding IOs (read/write requests) waiting to access the disk. string 64 no
free_storage_space_threshold The minimum amount of available storage space in Byte. string 2000000000 no
freeable_memory_threshold The minimum amount of available random access memory in Byte. string 64000000 no
swap_usage_threshold The maximum amount of swap space used on the DB instance in Byte. string 256000000 no

Outputs

Name Description
sns_topic_arn The ARN of the SNS topic

Makefile Targets

Available targets:

  help                                This help screen
  help/all                            Display help for all targets
  lint                                Lint terraform code

Related Projects

Check out these related projects.

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

E-Mail

  • Questions. We'll use a Shared Slack channel between your team and ours.
  • Troubleshooting. We'll help you triage why things aren't working.
  • Code Reviews. We'll review your Pull Requests and provide constructive feedback.
  • Bug Fixes. We'll rapidly work to fix any bugs in our projects.
  • Build New Terraform Modules. We'll develop original modules to provision infrastructure.
  • Cloud Architecture. We'll assist with your cloud strategy and design.
  • Implementation. We'll provide hands-on support to implement our reference architectures.

Community Forum

Get access to our Open Source Community Forum on Slack. It's FREE to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build sweet infrastructure.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2018 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know at hello@cloudposse.com

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We love Open Source Software!

We offer paid support on all of our projects.

Check out our other projects, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Jamie Nelson
Jamie Nelson
Erik Osterman
Erik Osterman
You can’t perform that action at this time.