Skip to content
Terraform module to create CloudWatch Alarms on ECS Service level metrics.
HCL Go Makefile
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
codefresh
docs
examples/complete
test
.gitignore
LICENSE
Makefile
README.md
README.yaml
main.tf
outputs.tf
variables.tf
versions.tf

README.md

README Header

Cloud Posse

terraform-aws-ecs-cloudwatch-sns-alarms

Codefresh Build Status Latest Release Slack Community

Terraform module for creating alarms for tracking important changes and occurrences from ECS Services.


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

Terraform Open Source Modules

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

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest, see test.

module "ecs_service_alarms" {
  source         = "git::https://github.com/cloudposse/terraform-aws-ecs-cloudwatch-sns-alarms.git?ref=master"
  namespace      = "eg"
  stage          = "staging"
  name           = "app"
  cluster_name   = "example"
  service_name   = "app"
}

Inputs

Name Description Type Default Required
alarm_description The string to format and use as the alarm description. string Average service %v utilization %v last %d minute(s) over %v period(s) no
attributes Additional attributes (e.g. "1") list(string) <list> no
cluster_name The name of the ECS cluster to monitor string - yes
cpu_utilization_high_alarm_actions A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization High Alarm action list(string) <list> no
cpu_utilization_high_evaluation_periods Number of periods to evaluate for the alarm number 1 no
cpu_utilization_high_ok_actions A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization High OK action list(string) <list> no
cpu_utilization_high_period Duration in seconds to evaluate for the alarm number 300 no
cpu_utilization_high_threshold The maximum percentage of CPU utilization average number 80 no
cpu_utilization_low_alarm_actions A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization Low Alarm action list(string) <list> no
cpu_utilization_low_evaluation_periods Number of periods to evaluate for the alarm number 1 no
cpu_utilization_low_ok_actions A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization Low OK action list(string) <list> no
cpu_utilization_low_period Duration in seconds to evaluate for the alarm number 300 no
cpu_utilization_low_threshold The minimum percentage of CPU utilization average number 20 no
delimiter Delimiter between namespace, stage, name and attributes string - no
enabled Enable/disable resources creation bool true no
memory_utilization_high_alarm_actions A list of ARNs (i.e. SNS Topic ARN) to notify on Memory Utilization High Alarm action list(string) <list> no
memory_utilization_high_evaluation_periods Number of periods to evaluate for the alarm number 1 no
memory_utilization_high_ok_actions A list of ARNs (i.e. SNS Topic ARN) to notify on Memory Utilization High OK action list(string) <list> no
memory_utilization_high_period Duration in seconds to evaluate for the alarm number 300 no
memory_utilization_high_threshold The maximum percentage of Memory utilization average number 80 no
memory_utilization_low_alarm_actions A list of ARNs (i.e. SNS Topic ARN) to notify on Memory Utilization Low Alarm action list(string) <list> no
memory_utilization_low_evaluation_periods Number of periods to evaluate for the alarm number 1 no
memory_utilization_low_ok_actions A list of ARNs (i.e. SNS Topic ARN) to notify on Memory Utilization Low OK action list(string) <list> no
memory_utilization_low_period Duration in seconds to evaluate for the alarm number 300 no
memory_utilization_low_threshold The minimum percentage of Memory utilization average number 20 no
name Name of the application string - yes
namespace Namespace (e.g. eg or cp) string `` no
service_name The name of the ECS Service in the ECS cluster to monitor string `` no
stage Stage (e.g. prod, dev, staging) string `` no
tags Additional tags (e.g. { BusinessUnit : ABC }) map(string) <map> no

Outputs

Name Description
cpu_utilization_high_cloudwatch_metric_alarm_arn CPU utilization high CloudWatch metric alarm ARN
cpu_utilization_high_cloudwatch_metric_alarm_id CPU utilization high CloudWatch metric alarm ID
cpu_utilization_low_cloudwatch_metric_alarm_arn CPU utilization low CloudWatch metric alarm ARN
cpu_utilization_low_cloudwatch_metric_alarm_id CPU utilization low CloudWatch metric alarm ID
memory_utilization_high_cloudwatch_metric_alarm_arn Memory utilization high CloudWatch metric alarm ARN
memory_utilization_high_cloudwatch_metric_alarm_id Memory utilization high CloudWatch metric alarm ID
memory_utilization_low_cloudwatch_metric_alarm_arn Memory utilization low CloudWatch metric alarm ARN
memory_utilization_low_cloudwatch_metric_alarm_id Memory utilization low CloudWatch metric alarm ID

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

Help

Got a question?

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

README Commercial Support

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.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

Slack Community

Join our Open Source Community on Slack. It's FREE 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 totally sweet infrastructure.

Newsletter

Signup for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

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-2019 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 by leaving a testimonial!

Cloud Posse

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

We offer paid support on all of our projects.

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

Contributors

Erik Osterman
Erik Osterman
Jamie Nelson
Jamie Nelson
Sarkis Varozian
Sarkis Varozian
Andriy Knysh
Andriy Knysh

README Footer Beacon

You can’t perform that action at this time.