[LS-44464] Add dashboard descriptions (#94)

lightstep · Jun 1, 2023 · 226d4e8 · 226d4e8
1 parent 70a924f
commit 226d4e8
Show file tree

Hide file tree

Showing 16 changed files with 47 additions and 40 deletions.
diff --git a/Makefile b/Makefile
@@ -6,7 +6,7 @@ gen:
 	go run tools/generaterootmod.go
 
 fmt:
-	terraform fmt
+	terraform fmt -recursive
 	gofmt -w -s ./tools
 
 check:

diff --git a/README.md b/README.md
@@ -18,18 +18,18 @@ Each AWS resource has an associated module that will create Lightstep dashboards
 <!-- modules autogenerated section -->
 * __Amplify__ (module: [`amplify-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/amplify-dashboard))
 * __API Gateway__ (module: [`apigateway-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/apigateway-dashboard))
-* __Application ELB Load Balancer__ (module: [`applicationelb-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/applicationelb-dashboard))
-* ____ (module: [`athena-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/athena-dashboard))
+* __Application ELB__ (module: [`applicationelb-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/applicationelb-dashboard))
+* __Athena__ (module: [`athena-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/athena-dashboard))
 * __Aurora__ (module: [`aurora-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/aurora-dashboard))
-* __Auto Scaling__ (module: [`autoscaling-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/autoscaling-dashboard))
+* __AutoScaling__ (module: [`autoscaling-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/autoscaling-dashboard))
 * __Backup__ (module: [`backup-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/backup-dashboard))
 * __Certificate Manager__ (module: [`certificatemanager-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/certificatemanager-dashboard))
 * __Chatbot__ (module: [`chatbot-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/chatbot-dashboard))
 * __Chime SDK__ (module: [`chime-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/chime-dashboard))
 * __CloudFront__ (module: [`cloudfront-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/cloudfront-dashboard))
 * __CloudHSM__ (module: [`cloudhsm-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/cloudhsm-dashboard))
 * __CloudTrail__ (module: [`cloudtrail-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/cloudtrail-dashboard))
-* __COGNITO__ (module: [`cognito-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/cognito-dashboard))
+* __Cognito__ (module: [`cognito-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/cognito-dashboard))
 * __DynamoDB__ (module: [`dynamodb-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/dynamodb-dashboard))
 * __EBS__ (module: [`ebs-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/ebs-dashboard))
 * __EC2__ (module: [`ec2-dashboard`](https://github.com/lightstep/terraform-lightstep-aws-dashboards/tree/main/modules/ec2-dashboard))

diff --git a/main.tf b/main.tf
@@ -29,11 +29,6 @@ module "lightstep_applicationelb_dashboard" {
   lightstep_project = var.lightstep_project
 }
 
-module "lightstep_applicationelb_dashboard" {
-  source            = "./modules/applicationelb-dashboard"
-  lightstep_project = var.lightstep_project
-}
-
 module "lightstep_athena_dashboard" {
   source            = "./modules/athena-dashboard"
   lightstep_project = var.lightstep_project

diff --git a/modules/athena-dashboard/main.tf b/modules/athena-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_athena_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS Athena"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS Athena"
+  dashboard_description = "Monitor AWS Athena with this dashboard."
 
   chart {
     name = "Total Execution Time"

diff --git a/modules/autoscaling-dashboard/main.tf b/modules/autoscaling-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_autoscaling_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS Auto Scaling"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS AutoScaling"
+  dashboard_description = "Monitor AWS AutoScaling with this dashboard."
 
   chart {
     name = "Instances"

diff --git a/modules/backup-dashboard/main.tf b/modules/backup-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_backup_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS Backup"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS Backup"
+  dashboard_description = "Monitor AWS Backup with this dashboard."
 
   chart {
     name = "Number of Backup Jobs"
@@ -206,4 +207,4 @@ metric aws.backup.number_of_recovery_points_cold_sum | delta | group_by [], sum
 EOT
     }
   }
-}
+}
diff --git a/modules/certificatemanager-dashboard/main.tf b/modules/certificatemanager-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_certificatemanager_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS Certificate Manager"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS Certificate Manager"
+  dashboard_description = "Monitor AWS Certificate Manager with this dashboard."
 
   chart {
     name = "Days To Expiry"

diff --git a/modules/chatbot-dashboard/main.tf b/modules/chatbot-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_chatbot_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS Chatbot"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS Chatbot"
+  dashboard_description = "Monitor AWS Chatbot with this dashboard."
 
   chart {
     name = "Events"
@@ -74,4 +75,4 @@ metric aws.chatbot.message_delivery_failure_sum | delta | group_by [], sum
 EOT
     }
   }
-}
+}
diff --git a/modules/cloudfront-dashboard/main.tf b/modules/cloudfront-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_cloudfront_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS CloudFront"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS CloudFront"
+  dashboard_description = "Monitor AWS CloudFront with this dashboard."
 
   chart {
     name = "Requests / TotalErrorRate"

diff --git a/modules/cloudtrail-dashboard/main.tf b/modules/cloudtrail-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_cloudtrail_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS CloudTrail"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS CloudTrail"
+  dashboard_description = "Monitor AWS CloudTrail with this dashboard."
 
   chart {
     name = "Units Count"

diff --git a/modules/cognito-dashboard/main.tf b/modules/cognito-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_cognito_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS COGNITO"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS Cognito"
+  dashboard_description = "Monitor AWS Cognito with this dashboard."
 
   chart {
     name = "Sign In Successes"

diff --git a/modules/eks-node-dashboard/main.tf b/modules/eks-node-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_eks_node_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS EKS Node"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS EKS Node"
+  dashboard_description = "Monitor AWS EKS Node with this dashboard."
 
   chart {
     name = "Cluster Node"

diff --git a/modules/elasticmapreduce-dashboard/main.tf b/modules/elasticmapreduce-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_elasticmapreduce_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS EMR Hadoop 2"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS EMR Hadoop 2"
+  dashboard_description = "Monitor AWS EMR with this dashboard."
 
   chart {
     name = "Containers"

diff --git a/modules/networkfirewall-dashboard/main.tf b/modules/networkfirewall-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_networkfirewall_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS Network Firewall"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS Network Firewall"
+  dashboard_description = "Monitor AWS Network Firewall with this dashboard."
 
   chart {
     name = "Passed Packets / Dropped Packets "

diff --git a/modules/ses-dashboard/main.tf b/modules/ses-dashboard/main.tf
@@ -9,8 +9,9 @@ terraform {
 }
 
 resource "lightstep_dashboard" "aws_ses_dashboard" {
-  project_name   = var.lightstep_project
-  dashboard_name = "AWS SES"
+  project_name          = var.lightstep_project
+  dashboard_name        = "AWS SES"
+  dashboard_description = "Monitor AWS SES with this dashboard."
 
   chart {
     name = "Send / Delivery"

diff --git a/outputs.tf b/outputs.tf
@@ -11,12 +11,12 @@ output "lightstep_apigateway_dashboard_url" {
 
 output "lightstep_applicationelb_dashboard_url" {
   value       = module.lightstep_applicationelb_dashboard.dashboard_url
-  description = "Lightstep AWS Application ELB Dashboard URL"
+  description = "Lightstep AWS Application ELB Dashboard"
 }
 
 output "lightstep_athena_dashboard_url" {
   value       = module.lightstep_athena_dashboard.dashboard_url
-  description = "Lightstep AWS  Dashboard"
+  description = "Lightstep AWS Athena Dashboard"
 }
 
 output "lightstep_aurora_dashboard_url" {
@@ -26,7 +26,7 @@ output "lightstep_aurora_dashboard_url" {
 
 output "lightstep_autoscaling_dashboard_url" {
   value       = module.lightstep_autoscaling_dashboard.dashboard_url
-  description = "Lightstep AWS Auto Scaling Dashboard"
+  description = "Lightstep AWS AutoScaling Dashboard"
 }
 
 output "lightstep_backup_dashboard_url" {
@@ -66,7 +66,7 @@ output "lightstep_cloudtrail_dashboard_url" {
 
 output "lightstep_cognito_dashboard_url" {
   value       = module.lightstep_cognito_dashboard.dashboard_url
-  description = "Lightstep AWS COGNITO Dashboard"
+  description = "Lightstep AWS Cognito Dashboard"
 }
 
 output "lightstep_dynamodb_dashboard_url" {