Skip to content

Commit 401958d

Browse files
committed
Update instructions
1 parent 689e395 commit 401958d

File tree

3 files changed

+14
-19
lines changed

3 files changed

+14
-19
lines changed

docs/infra/set-up-monitoring-alerts.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,21 @@
44

55
The monitoring module defines metric-based alerting policies that provide awareness into issues with the cloud application. The module supports integration with external incident management tools like Splunk-On-Call or Pagerduty. It also supports email alerts.
66

7-
### Set up email alerts.
8-
9-
1. Add the `email_alerts_subscription_list` variable to the monitoring module call in the service layer
10-
11-
For example:
12-
```
13-
module "monitoring" {
14-
source = "../../modules/monitoring"
15-
email_alerts_subscription_list = ["email1@email.com", "email2@email.com"]
16-
...
17-
}
18-
```
7+
### Set up email alerts
8+
9+
The monitoring module supports a simple email-based alerting system that does not rely on an external incident management service.
10+
11+
1. Update the `email_alert_recipients` variable in `app-config/env-config/monitoring.tf`
12+
1913
2. Run `make infra-update-app-service APP_NAME=<APP_NAME> ENVIRONMENT=<ENVIRONMENT>` to apply the changes to each environment.
20-
When any of the alerts described by the module are triggered notification will be sent to all emails specified in the `email_alerts_subscription_list`
2114

22-
### Set up External incident management service integration.
15+
### Integrate with an incident management service
2316

2417
1. Set setting `has_incident_management_service = true` in app-config/main.tf
2518
2. Get the integration URL for the incident management service and store it in AWS SSM Parameter Store by running the following command for each environment:
26-
```
27-
make infra-configure-monitoring-secrets APP_NAME=<APP_NAME> ENVIRONMENT=<ENVIRONMENT> URL=<WEBHOOK_URL>
28-
```
19+
20+
```bash
21+
make infra-configure-monitoring-secrets APP_NAME=<APP_NAME> ENVIRONMENT=<ENVIRONMENT> URL=<WEBHOOK_URL>
22+
```
23+
2924
3. Run `make infra-update-app-service APP_NAME=<APP_NAME> ENVIRONMENT=<ENVIRONMENT>` to apply the changes to each environment.

infra/app-rails/app-config/env-config/monitoring.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ locals {
22
monitoring_config = {
33
# Emails to notify for alerts.
44
# Use this as a simple notification mechanism if you don't have an incident management service.
5-
# email_alert_recipients = ["email1@email.com", "email2@email.com"]
5+
email_alert_recipients = []
66

77
incident_management_service = var.has_incident_management_service ? {
88
integration_url_param_name = "/monitoring/${var.app_name}/${var.environment}/incident-management-integration-url"

infra/app/app-config/env-config/monitoring.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ locals {
22
monitoring_config = {
33
# Emails to notify for alerts.
44
# Use this as a simple notification mechanism if you don't have an incident management service.
5-
# email_alert_recipients = ["email1@email.com", "email2@email.com"]
5+
email_alert_recipients = []
66

77
incident_management_service = var.has_incident_management_service ? {
88
integration_url_param_name = "/monitoring/${var.app_name}/${var.environment}/incident-management-integration-url"

0 commit comments

Comments
 (0)