From 8566eba76fddebf91a356644ed3365a0dba56c46 Mon Sep 17 00:00:00 2001 From: "docs-sourcer[bot]" <99042413+docs-sourcer[bot]@users.noreply.github.com> Date: Fri, 13 Dec 2024 15:00:09 -0800 Subject: [PATCH] Updated with the [latest changes](https://github.com/gruntwork-io/terraform-aws-monitoring/releases/tag/v0.36.27) from the `terraform-aws-monitoring@v0.36.27` source branch. (#2258) Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com> --- .../terraform-aws-monitoring/alarms/alarms.md | 43 +++++++++---------- .../terraform-aws-monitoring/logs/logs.md | 23 +++++----- .../metrics/metrics.md | 23 +++++----- 3 files changed, 43 insertions(+), 46 deletions(-) diff --git a/docs/reference/modules/terraform-aws-monitoring/alarms/alarms.md b/docs/reference/modules/terraform-aws-monitoring/alarms/alarms.md index d0ed5cafc..5f5c13d1d 100644 --- a/docs/reference/modules/terraform-aws-monitoring/alarms/alarms.md +++ b/docs/reference/modules/terraform-aws-monitoring/alarms/alarms.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Alarm modules -View Source +View Source Release Notes @@ -21,29 +21,29 @@ This folder contains modules that configure [CloudWatch Alarms](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/AlarmThatSendsEmail.html) to go off and email or SMS you when something is going wrong. The modules are: -* [asg-cpu-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/asg-cpu-alarms): An alarm that goes off if CPU usage in an Auto Scaling Group (ASG) is too high. -* [asg-disk-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/asg-disk-alarms): An alarm that goes off if disk usage in an Auto Scaling Group (ASG) is too high. -* [asg-memory-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/asg-memory-alarms): An alarm that goes off if memory usage in an Auto Scaling Group (ASG) is +* [asg-cpu-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/asg-cpu-alarms): An alarm that goes off if CPU usage in an Auto Scaling Group (ASG) is too high. +* [asg-disk-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/asg-disk-alarms): An alarm that goes off if disk usage in an Auto Scaling Group (ASG) is too high. +* [asg-memory-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/asg-memory-alarms): An alarm that goes off if memory usage in an Auto Scaling Group (ASG) is too high. -* [ec2-cpu-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/ec2-cpu-alarms): An alarm that goes off if CPU usage for an EC2 Instance is too high. -* [ec2-disk-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/ec2-disk-alarms): An alarm that goes off if disk usage for an EC2 Instance is too high. -* [ec2-memory-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/ec2-memory-alarms): An alarm that goes off if memory usage for an EC2 Instance is too high. -* [ecs-cluster-alamrs](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/ecs-cluster-alarms): Alarms for an ECS cluster that go off if CPU or memory usage is too high +* [ec2-cpu-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/ec2-cpu-alarms): An alarm that goes off if CPU usage for an EC2 Instance is too high. +* [ec2-disk-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/ec2-disk-alarms): An alarm that goes off if disk usage for an EC2 Instance is too high. +* [ec2-memory-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/ec2-memory-alarms): An alarm that goes off if memory usage for an EC2 Instance is too high. +* [ecs-cluster-alamrs](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/ecs-cluster-alarms): Alarms for an ECS cluster that go off if CPU or memory usage is too high across the cluster. -* [ecs-service-alamrs](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/ecs-cluster-alarms): Alarms for an ECS service that go off if CPU or memory usage is too high +* [ecs-service-alamrs](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/ecs-cluster-alarms): Alarms for an ECS service that go off if CPU or memory usage is too high for this service. -* [elb-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/elb-alarms): A set of ELB alarms that go off if the latency gets too high, or there are +* [elb-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/elb-alarms): A set of ELB alarms that go off if the latency gets too high, or there are too many 5xx errors, or too few requests are coming in. -* [lambda-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/lambda-alarms): An alarm that goes off when a lambda function breaches an associated metric. -* [rds-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/rds-alarms): A set of RDS alarms that go off if the CPU usage, number of connections, or latency gets +* [lambda-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/lambda-alarms): An alarm that goes off when a lambda function breaches an associated metric. +* [rds-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/rds-alarms): A set of RDS alarms that go off if the CPU usage, number of connections, or latency gets too high or if the available memory or disk space gets too low. -* [route53-health-check-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/route53-health-check-alarms): Monitor a given domain (e.g. example.com) using Route +* [route53-health-check-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/route53-health-check-alarms): Monitor a given domain (e.g. example.com) using Route 53 and trigger an alarm if that domain is down or unresponsive. -* [scheduled-job-alarm](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/scheduled-job-alarm): An alarm that goes off if a scheduled job (e.g. a cron job) fails to +* [scheduled-job-alarm](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/scheduled-job-alarm): An alarm that goes off if a scheduled job (e.g. a cron job) fails to run. -* [sqs-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/alarms/sqs-alarms): Alarms that go off if the number of visible messages is too high or age of oldest message surpasses the threshold. +* [sqs-alarms](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/alarms/sqs-alarms): Alarms that go off if the number of visible messages is too high or age of oldest message surpasses the threshold. -Click on each module above to see its documentation. Head over to the [examples folder](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/examples) for examples. +Click on each module above to see its documentation. Head over to the [examples folder](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/examples) for examples. ## Information regarding tags for metric alarms @@ -55,15 +55,14 @@ aws cloudwatch list-tags-for-resource --resource-arn alarm_arn Tags associated with a metric alarm are not propagated with the alarm payload when the alarm is triggered. - diff --git a/docs/reference/modules/terraform-aws-monitoring/logs/logs.md b/docs/reference/modules/terraform-aws-monitoring/logs/logs.md index c64949801..f1e7664b4 100644 --- a/docs/reference/modules/terraform-aws-monitoring/logs/logs.md +++ b/docs/reference/modules/terraform-aws-monitoring/logs/logs.md @@ -9,33 +9,32 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Log modules -View Source +View Source Release Notes This folder contains modules that help with logging: -* [cloudwatch-log-aggregation-iam-policy](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/logs/cloudwatch-log-aggregation-iam-policy): A module that defines +* [cloudwatch-log-aggregation-iam-policy](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/logs/cloudwatch-log-aggregation-iam-policy): A module that defines an IAM policy that allows reading/writing CloudWatch log data. -* [cloudwatch-logs-metric-filters](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/logs/cloudwatch-logs-metric-filters): A Terraform module to send alerts when patterns are matched in CloudWatch Logs groups. -* [load-balancer-access-logs](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/logs/load-balancer-access-logs): Creates an S3 bucket to store ELB access logs, along with the appropriate access policy and lifecycle rules. -* [syslog](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/logs/syslog): Configures rate limiting and log rotation for syslog. - -Click on each module above to see its documentation. Head over to the [examples folder](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/examples) for examples. +* [cloudwatch-logs-metric-filters](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/logs/cloudwatch-logs-metric-filters): A Terraform module to send alerts when patterns are matched in CloudWatch Logs groups. +* [load-balancer-access-logs](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/logs/load-balancer-access-logs): Creates an S3 bucket to store ELB access logs, along with the appropriate access policy and lifecycle rules. +* [syslog](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/logs/syslog): Configures rate limiting and log rotation for syslog. +Click on each module above to see its documentation. Head over to the [examples folder](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/examples) for examples. diff --git a/docs/reference/modules/terraform-aws-monitoring/metrics/metrics.md b/docs/reference/modules/terraform-aws-monitoring/metrics/metrics.md index c61f96cde..2bb78592d 100644 --- a/docs/reference/modules/terraform-aws-monitoring/metrics/metrics.md +++ b/docs/reference/modules/terraform-aws-monitoring/metrics/metrics.md @@ -9,33 +9,32 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Metrics modules -View Source +View Source Release Notes This folder contains modules for working with CloudWatch metrics: -* [cloudwatch-custom-metrics-iam-policy](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/metrics/cloudwatch-custom-metrics-iam-policy): A module that defines +* [cloudwatch-custom-metrics-iam-policy](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/metrics/cloudwatch-custom-metrics-iam-policy): A module that defines an IAM policy that allows reading/writing CloudWatch metrics. -* [cloudwatch-dashboard-metric-widget](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/metrics/cloudwatch-dashboard-metric-widget): Configures a CloudWatch Dashboard metric widget. -* [cloudwatch-dashboard-text-widget](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/metrics/cloudwatch-dashboard-text-widget): Configures a CloudWatch Dashboard text widget. -* [cloudwatch-dashboard](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/modules/metrics/cloudwatch-dashboard): Configures and deploys a CloudWatch Dashboard. - -Click on each module above to see its documentation. Head over to the [examples folder](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.26/examples) for examples. +* [cloudwatch-dashboard-metric-widget](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/metrics/cloudwatch-dashboard-metric-widget): Configures a CloudWatch Dashboard metric widget. +* [cloudwatch-dashboard-text-widget](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/metrics/cloudwatch-dashboard-text-widget): Configures a CloudWatch Dashboard text widget. +* [cloudwatch-dashboard](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/modules/metrics/cloudwatch-dashboard): Configures and deploys a CloudWatch Dashboard. +Click on each module above to see its documentation. Head over to the [examples folder](https://github.com/gruntwork-io/terraform-aws-monitoring/tree/v0.36.27/examples) for examples.