The public documentation for the gruntwork-io/module-aws-monitoring repo, which contains modules that configure monitoring, log aggregation, and alerting using services built-into AWS, including CloudWatch, SNS, and S3
HCL Go Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Note: This public repo contains the documentation for the private GitHub repo https://github.com/gruntwork-io/module-aws-monitoring. We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer. If you're already a Gruntwork customer, the original source for this file is at: https://github.com/gruntwork-io/module-aws-monitoring/blob/master/README.md. If you're not a customer, contact us at info@gruntwork.io or http://www.gruntwork.io for info on how to get access!

AWS Monitoring Modules

This repo contains modules for configure monitoring, log aggregation, and alerting using services built-in to AWS, including CloudWatch, SNS, and S3. The modules are:

  • alarms: A collection of CloudWatch Alarms for a variety of metrics (e.g. CPU usage, memory usage, disk space usage, latency, etc.) that you can add to Auto Scaling Groups, EC2 instances, Elastic Load Balancers, and other resources.
  • logs: Modules that help with log aggregation in CloudWatch Logs, access logging for your Elastic Load Balancers, and log rotation and rate limiting for syslog.
  • metrics: Modules that add custom metrics to CloudWatch, including metrics not visible to the EC2 hypervisor, such as memory usage and disk space usage.

Click on each module above to see its documentation. Head over to the examples folder for examples.

What is a Gruntwork module?

At Gruntwork, we've taken the thousands of hours we spent building infrastructure on AWS and condensed all that experience and code into pre-built packages or modules. Each module is a battle-tested, best-practices definition of a piece of infrastructure, such as a VPC, ECS cluster, or an Auto Scaling Group. Modules are versioned using Semantic Versioning to allow Gruntwork clients to keep up to date with the latest infrastructure best practices in a systematic way.

How do you use a module?

Most of our modules contain either:

  1. Terraform code
  2. Scripts & binaries

Using a Terraform Module

To use a module in your Terraform templates, create a module resource and set its source field to the Git URL of this repo. You should also set the ref parameter so you're fixed to a specific version of this repo, as the master branch may have backwards incompatible changes (see module sources).

For example, to use v1.0.8 of the elb-access-logs module, you would add the following:

module "ecs_cluster" {
  source = "git::git@github.com:gruntwork-io/module-aws-monitoring.git//modules/logs/elb-access-logs?ref=v1.0.8"

  // set the parameters for the ELB access logs module
}

Note: the double slash (//) is intentional and required. It's part of Terraform's Git syntax (see module sources).

See the module's documentation and vars.tf file for all the parameters you can set. Run terraform get -update to pull the latest version of this module from this repo before runnin gthe standard terraform plan and terraform apply commands.

Using scripts & binaries

You can install the scripts and binaries in the modules folder of any repo using the Gruntwork Installer. For example, if the scripts you want to install are in the modules/ecs-scripts folder of the https://github.com/gruntwork-io/module-ecs repo, you could install them as follows:

gruntwork-install --module-name "ecs-scripts" --repo "https://github.com/gruntwork-io/module-ecs" --tag "0.0.1"

See the docs for each script & binary for detailed instructions on how to use them.

Developing a module

Versioning

We are following the principles of Semantic Versioning. During initial development, the major version is to 0 (e.g., 0.x.y), which indicates the code does not yet have a stable API. Once we hit 1.0.0, we will follow these rules:

  1. Increment the patch version for backwards-compatible bug fixes (e.g., v1.0.8 -> v1.0.9).
  2. Increment the minor version for new features that are backwards-compatible (e.g., v1.0.8 -> 1.1.0).
  3. Increment the major version for any backwards-incompatible changes (e.g. 1.0.8 -> 2.0.0).

The version is defined using Git tags. Use GitHub to create a release, which will have the effect of adding a git tag.

Tests

See the test folder for details.

License

Please see LICENSE.txt for details on how the code in this repo is licensed.