Skip to content

Commit

Permalink
docs improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
EreminAnton committed Aug 24, 2023
1 parent 800613b commit 052b9c9
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
- [Configuration Guide](#configuration-guide)
- [Setting Up AWS Chatbot in Slack](#setting-up-aws-chatbot-in-slack)
- [Configuring Slack Channel to SNS Topic](#configuring-slack-channel-to-sns-topic)
- [Conclusion](#conclusion)
## Overview

The `aws-alerts-to-slack` Terraform module offers a seamless method to monitor critical AWS alerts and relay them directly to your Slack workspace. By encapsulating the complexities of AWS services and configurations, this module delivers a straightforward deployment process, allowing quick integration of comprehensive monitoring and alerting into your infrastructure.
Expand All @@ -35,19 +34,24 @@ The `aws-alerts-to-slack` Terraform module offers a seamless method to monitor c

## Implemented Alerts

- **Reservations Utilization Alert:** Activates when Reserved Instance utilization drops below a certain threshold.
Currently, the module supports the following alerts:

- **Savings Plans Utilization Alert:** Notifies when Savings Plans utilization decreases below a specified threshold.
- **Savings Plans Utilization Alert:** Notifies users when Savings Plans utilization falls below a specified threshold.

- **Budget Alerts:** Monitors forecasted and actual costs. Sends an alert if costs exceed a specific percentage of a set budget. By default, notifications are generated at 100%, 150%, and 200% of the budget for both forecasted and actual costs.

- **GuardDuty Findings:** Routes AWS GuardDuty findings directly to Slack.

The following alerts are in the testing phase and should be used with caution:

- **Reservations Utilization Alert:** Triggers when Reserved Instance utilization falls below a specified threshold.

- **Budget Alerts:** Observes forecasted or actual costs. An alert is sent if costs exceed a certain percentage of a set limit. The system auto-generates a budget with notifications at 100%, 150%, and 200% of the limit amount for both forecasted and actual costs.
- **AWS Health Events:** Keeps track of AWS Health-related events.

- **EventBridge Alerts:**
- **GuardDuty Findings:** Directs any AWS GuardDuty discoveries straight to Slack.
- **AWS Health Events:** Monitors AWS Health-related events.
- **Cost Anomaly Detection:** Leverages AWS Cost Explorer's Cost Anomaly Detection for alerts.

- **Cost Anomaly Detection:** Implements AWS Cost Explorer's Cost Anomaly Detection alerts.
For more information on each alert type, please refer to the `/modules` directory.

For further details on each alert, refer to the `/modules` directory.

## Configuration Guide

Expand Down Expand Up @@ -116,5 +120,3 @@ module "budget_alerts" {

For additional usage examples, consult the /examples directory.

# Conclusion
Stay proactive and enhance your alerting system with the aws-alerts-to-slack Terraform module. By channeling AWS alerts directly into Slack, your team remains informed and ready to act, ensuring the resilience and observability of your AWS infrastructure.

0 comments on commit 052b9c9

Please sign in to comment.