-
-
Notifications
You must be signed in to change notification settings - Fork 20
/
README.yaml
120 lines (105 loc) · 5.34 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: terraform-aws-cloudwatch-logs
# Tags of this project
tags:
- aws
- terraform
- terraform-modules
- logging
- cloudwatch
- cloudwatch-logs
# Categories of this project
categories:
- terraform-modules/logging
# Logo for this project
#logo: docs/logo.png
# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-cloudwatch-logs
# Badges to display
badges:
- name: Latest Release
image: https://img.shields.io/github/release/cloudposse/terraform-aws-cloudwatch-logs.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-aws-cloudwatch-logs/releases/latest
- name: Last Updated
image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-cloudwatch-logs.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-aws-cloudwatch-logs/commits
- name: Slack Community
image: https://slack.cloudposse.com/for-the-badge.svg
url: https://slack.cloudposse.com
# List any related terraform modules that this module may be used with or that this module depends on.
related:
- name: "terraform-aws-cloudwatch-flow-logs"
description: "Terraform module for enabling flow logs for vpc and subnets."
url: "https://github.com/cloudposse/terraform-aws-cloudwatch-flow-logs"
- name: "terraform-aws-ecs-web-app"
description: "Terraform module that implements a web app on ECS and supporting AWS resources."
url: "https://github.com/cloudposse/terraform-aws-ecs-web-app"
- name: "terraform-aws-cloudtrail-cloudwatch-alarms"
description: "Terraform module for creating alarms for tracking important changes and occurances from cloudtrail."
url: "https://github.com/cloudposse/terraform-aws-cloudtrail-cloudwatch-alarms"
- name: "prometheus-to-cloudwatch"
description: "Utility for scraping Prometheus metrics from a Prometheus client endpoint and publishing them to CloudWatch"
url: "https://github.com/cloudposse/prometheus-to-cloudwatch"
- name: "terraform-aws-cloudwatch-logs"
description: "Terraform Module to Provide a CloudWatch Logs Endpoint"
url: "https://github.com/cloudposse/terraform-aws-cloudwatch-logs"
- name: "terraform-aws-efs-cloudwatch-sns-alarms"
description: "Terraform module that configures CloudWatch SNS alerts for EFS"
url: "https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms"
- name: "terraform-aws-ecs-cloudwatch-autoscaling"
description: "Terraform module to autoscale ECS Service based on CloudWatch metrics"
url: "https://github.com/cloudposse/terraform-aws-ecs-cloudwatch-autoscaling"
- name: "terraform-aws-ecs-cloudwatch-sns-alarms"
description: "Terraform module to create CloudWatch Alarms on ECS Service level metrics."
url: "https://github.com/cloudposse/terraform-aws-ecs-cloudwatch-sns-alarms"
- name: "terraform-aws-sqs-cloudwatch-sns-alarms"
description: "Terraform module for creating alarms for SQS and notifying endpoints"
url: "https://github.com/cloudposse/terraform-aws-sqs-cloudwatch-sns-alarms"
- name: "terraform-aws-elasticache-cloudwatch-sns-alarms"
description: "Terraform module that configures CloudWatch SNS alerts for ElastiCache"
url: "https://github.com/cloudposse/terraform-aws-elasticache-cloudwatch-sns-alarms"
- name: "terraform-aws-ec2-cloudwatch-sns-alarms"
description: "Terraform module that configures CloudWatch SNS alerts for EC2 instances"
url: "https://github.com/cloudposse/terraform-aws-ec2-cloudwatch-sns-alarms"
- name: "terraform-aws-rds-cloudwatch-sns-alarms"
description: "Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic"
url: "https://github.com/cloudposse/terraform-aws-rds-cloudwatch-sns-alarms"
- name: "terraform-aws-lambda-cloudwatch-sns-alarms"
description: "Terraform module for creating a set of Lambda alarms and outputting to an endpoint"
url: "https://github.com/cloudposse/terraform-aws-lambda-cloudwatch-sns-alarms"
- name: "terraform-aws-alb-target-group-cloudwatch-sns-alarms"
description: "Terraform module to create CloudWatch Alarms on ALB Target level metrics."
url: "https://github.com/cloudposse/terraform-aws-alb-target-group-cloudwatch-sns-alarms"
- name: "terraform-aws-sns-lambda-notify-slack"
description: "Terraform module to provision a lambda function that subscribes to SNS and notifies to Slack."
url: "https://github.com/cloudposse/terraform-aws-sns-lambda-notify-slack"
# Short description of this project
description: |-
Terraform module for creation of CloudWatch Log Streams and Log Groups. Useful in combination with Fluentd/Fluent-bit for shipping logs.
# How to use this project
usage: |-
```terraform
module "cloudwatch_logs" {
source = "cloudposse/cloudwatch-logs/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "prod"
name = "app"
stream_names = ["kafka-instance-1", "kafka-instance-2"]
}
```
# Example usage
examples: |-
Here's a complete [example](examples/complete/main.tf) of using this `terraform-aws-cloudwatch-logs` module.
include:
- "docs/targets.md"
- "docs/terraform.md"
# Contributors to this project
contributors: []