Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rhythmictech/terraform-aws-rhythmic-monitoring
Configures a basic monitoring pattern based on three thresholds
https://github.com/rhythmictech/terraform-aws-rhythmic-monitoring
aws cloudwatch jira monitoring pagerduty slack terraform terraform-module
Last synced: 2 days ago
JSON representation
Configures a basic monitoring pattern based on three thresholds
- Host: GitHub
- URL: https://github.com/rhythmictech/terraform-aws-rhythmic-monitoring
- Owner: rhythmictech
- License: mit
- Created: 2020-05-27T15:47:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-16T01:26:16.000Z (almost 3 years ago)
- Last Synced: 2024-11-10T23:10:10.829Z (2 months ago)
- Topics: aws, cloudwatch, jira, monitoring, pagerduty, slack, terraform, terraform-module
- Language: HCL
- Homepage: https://registry.terraform.io/modules/rhythmictech/rhythmic-monitoring/aws/latest
- Size: 74.2 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# terraform-aws-rhythmic-monitoring
[](https://github.com/rhythmictech/terraform-aws-rhythmic-monitoring/actions?query=workflow%3Atflint+event%3Apush+branch%3Amaster)
[](https://github.com/rhythmictech/terraform-aws-rhythmic-monitoring/actions?query=workflow%3Atfsec+event%3Apush+branch%3Amaster)
[](https://github.com/rhythmictech/terraform-aws-rhythmic-monitoring/actions?query=workflow%3Ayamllint+event%3Apush+branch%3Amaster)
[](https://github.com/rhythmictech/terraform-aws-rhythmic-monitoring/actions?query=workflow%3Amisspell+event%3Apush+branch%3Amaster)
[](https://github.com/rhythmictech/terraform-aws-rhythmic-monitoring/actions?query=workflow%3Apre-commit-check+event%3Apush+branch%3Amaster)
_This is an experimental module_
Configures a basic monitoring pattern based on three thresholds:
* *Alerting* - send to something like PagerDuty
* *Ticketing* - send to something like Jira
* *Notify* - send to something like Slack
Currently this module only supports these targets, though we aim to make it more flexible over time to support different integrations.
You can attach currently CloudWatch Alarms and Metric Alarms.
## Example
Here's what using the module will look like
```tf
module "monitoring" {
source = "rhythmictech/terraform-aws-rhythmic-monitoring"
alert_webhook = var.pagerduty_webhook
enable_jira_integration = true
name = "Monitoring"
notify_webhook = var.slack_webhook
jira_api_token_secret_name = "jira-api-token"
jira_issue_type = "Incident"
jira_project = "JSD"
jira_url = "https://customer.atlassian.net/"
jira_username = "[email protected]"
slack_channel = var.slack_channel
slack_username = var.slack_username
}
```
## Jira integration
To use Jira integration, you need to save your API key in AWS Secrets Manager. Something like this would work:
```sh
aws secretsmanager create-secret \
--region us-east-1 \
--name jira-api-token \
--secret-string="JIRA_API_TOKEN" \
--tags '[{"Key":"terraform_managed","Value":"false"}]'
```
You can read more about how to generate them on the [Atlassian Docs](https://confluence.atlassian.com/cloud/api-tokens-938839638.html). If yopu are unsure of what issue types or projects you have available [this blog post](https://blog.developer.atlassian.com/creating-a-jira-cloud-issue-in-a-single-rest-call/) has some useful `curl` calls.
## Slack Integration
To create an incoming Slack webhook you can [read these docs](https://api.slack.com/messaging/webhooks) and will end up with a webhook like this:
```
https://hooks.slack.com/services/T1GG3R/K1NG3YR4BW/2hWASoxAt8lHOAXizwdvsa
```
## Pagerduty Integration
This module uses Pagerduty's AWS Cloudwatch integration, which you can read about [on the pagerduty docs](https://support.pagerduty.com/docs/aws-cloudwatch-integration-guide).
Another helpful example is [this blog post](https://www.giladpeleg.com/blog/aws-sns-topic-subscription-with-pagerduty-terraform/)
You will end up with a webhook like the one below:
```
https://events.pagerduty.com/integration/10101RhythmicTechDaBest200hassh/enqueue
```
## Requirements
| Name | Version |
|------|---------|
| terraform | >= 0.13.0 |
| archive | 1.3.0 |
| aws | >= 3.0 |
| null | 3.0.0 |
## Providers
| Name | Version |
|------|---------|
| archive | 1.3.0 |
| aws | >= 3.0 |
| null | 3.0.0 |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| alert\_webhook | Webhook to send alerts to. Currently must be a PagerDuty webhook | `string` | n/a | yes |
| name | Moniker to apply to all resources in the module | `string` | n/a | yes |
| notify\_webhook | Webhook to send notifications to. Currently must be a Slack webhook | `string` | n/a | yes |
| slack\_channel | Slack channel to route alerts to | `string` | n/a | yes |
| create\_jira\_secret\_access\_policy | If true, will attach an IAM policy granting read access to the secret containing the Jira access token. Only effective if `enable_jira_integration=true` | `bool` | `true` | no |
| enable\_jira\_integration | Enable Jira integration Lambda | `bool` | `false` | no |
| jira\_api\_token\_secret\_name | Name of Secrets Manager secret containing API Token to use for requests (see https://confluence.atlassian.com/cloud/api-tokens-938839638.html) | `string` | `null` | no |
| jira\_issue\_type | Issue Type (key) to use for all issues | `string` | `null` | no |
| jira\_project | Jira Project Key to create issues in | `string` | `null` | no |
| jira\_url | URL of Jira instance | `string` | `null` | no |
| jira\_username | Jira Username (must match specified API key) | `string` | `null` | no |
| pip\_path | Path to your pip installation (must be valid if `enable_jira_integration=true`) | `string` | `"/usr/local/bin/pip"` | no |
| slack\_username | Slack username to post alerts as (will use aws account id if not specified) | `string` | `""` | no |
| tags | User-Defined tags | `map(string)` | `{}` | no |
## Outputs
| Name | Description |
|------|-------------|
| sns\_topic\_alert\_arn | Alert Topic ARN |
| sns\_topic\_notify\_arn | Notification Topic ARN |
| sns\_topic\_ticket\_arn | Ticketing Topic ARN |