Merge pull request #1890 from quixoticmonk/d-improve-awscc_cloudwatch…

…_dashboard docs: add examples for awscc_cloudwatch_dashboard
hashicorp · Jul 19, 2024 · fca777a · fca777a
2 parents cfeae70 + 13db16a
commit fca777a
Show file tree

Hide file tree

Showing 3 changed files with 555 additions and 2 deletions.
diff --git a/docs/resources/cloudwatch_dashboard.md b/docs/resources/cloudwatch_dashboard.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "awscc_cloudwatch_dashboard Resource - terraform-provider-awscc"
 subcategory: ""
 description: |-
@@ -10,7 +9,273 @@ description: |-
 
 Resource Type definition for AWS::CloudWatch::Dashboard
 
+## Example Usage based on https://github.com/aws-solutions-library-samples/guidance-for-crossregion-failover-and-graceful-failback-and-observability-on-aws
 
+```terraform
+resource "awscc_cloudwatch_dashboard" "example" {
+  dashboard_body = jsonencode(
+    {
+      "widgets" : [
+        {
+          "height" : 2,
+          "width" : 13,
+          "y" : 2,
+          "x" : 0,
+          "type" : "alarm",
+          "properties" : {
+            "title" : "Composite Alarms by Service",
+            "alarms" : [
+              "arn:aws:cloudwatch:us-east-1:${data.aws_caller_identity.current.account_id}:alarm:API Gateway Health",
+              "arn:aws:cloudwatch:us-east-1:${data.aws_caller_identity.current.account_id}:alarm:Lambda Health",
+              "arn:aws:cloudwatch:us-east-1:${data.aws_caller_identity.current.account_id}:alarm:RDS Health"
+            ]
+          }
+        },
+        {
+          "height" : 4,
+          "width" : 15,
+          "y" : 26,
+          "x" : 0,
+          "type" : "metric",
+          "properties" : {
+            "metrics" : [
+              ["AWS/RDS", "CPUUtilization", "DBClusterIdentifier", "dbcluster1"],
+              [".", "Deadlocks", ".", "."],
+              [".", "FreeableMemory", ".", "."],
+              [".", "ReadLatency", ".", "."],
+              [".", "WriteLatency", ".", "."]
+            ],
+            "view" : "singleValue",
+            "region" : "us-east-1",
+            "yAxis" : {
+              "left" : {
+                "min" : 0,
+                "max" : 100
+              }
+            },
+            "title" : "dbcluster1-instance1",
+            "period" : 300,
+            "setPeriodToTimeRange" : true,
+            "sparkline" : false,
+            "trend" : false,
+            "stacked" : false,
+            "stat" : "Average",
+            "singleValueFullPrecision" : false
+          }
+        },
+        {
+          "height" : 1,
+          "width" : 13,
+          "y" : 4,
+          "x" : 0,
+          "type" : "text",
+          "properties" : {
+            "markdown" : "## Integration"
+          }
+        },
+        {
+          "height" : 1,
+          "width" : 19,
+          "y" : 24,
+          "x" : 0,
+          "type" : "text",
+          "properties" : {
+            "markdown" : "## Storage\n"
+          }
+        },
+        {
+          "height" : 1,
+          "width" : 19,
+          "y" : 10,
+          "x" : 0,
+          "type" : "text",
+          "properties" : {
+            "markdown" : "## Compute\n"
+          }
+        },
+        {
+          "height" : 2,
+          "width" : 13,
+          "y" : 0,
+          "x" : 0,
+          "type" : "text",
+          "properties" : {
+            "markdown" : "# Application Health Dashboard\nCombined Dashboard of **AWS Health** and **health of each service** for the Regional Failover solution.\n \n"
+          }
+        },
+        {
+          "height" : 4,
+          "width" : 12,
+          "y" : 6,
+          "x" : 0,
+          "type" : "metric",
+          "properties" : {
+            "metrics" : [
+              ["AWS/ApiGateway", "Count", "ApiName", "Remittance", { "yAxis" : "left", "label" : "API Calls" }],
+              [".", "Latency", ".", ".", { "stat" : "Average", "label" : "Avg Latency" }],
+              [".", "4XXError", ".", "."],
+              [".", "5XXError", ".", "."]
+            ],
+            "sparkline" : false,
+            "view" : "singleValue",
+            "region" : "us-east-1",
+            "period" : 300,
+            "stat" : "Sum",
+            "setPeriodToTimeRange" : true,
+            "trend" : false,
+            "liveData" : false,
+            "stacked" : false,
+            "singleValueFullPrecision" : false,
+            "title" : "Dev Resource APIs"
+          }
+        },
+        {
+          "height" : 4,
+          "width" : 11,
+          "y" : 20,
+          "x" : 0,
+          "type" : "metric",
+          "properties" : {
+            "metrics" : [
+              ["AWS/Lambda", "Invocations", "FunctionName", "UpdateRemittance"],
+              [".", "Errors", ".", "."],
+              [".", "Duration", ".", ".", { "stat" : "Average" }],
+              [".", "Throttles", ".", "."]
+            ],
+            "sparkline" : false,
+            "view" : "singleValue",
+            "region" : "us-east-1",
+            "period" : 300,
+            "stat" : "Sum",
+            "setPeriodToTimeRange" : true,
+            "trend" : false,
+            "title" : "UpdateRemittance"
+          }
+        },
+        {
+          "height" : 4,
+          "width" : 11,
+          "y" : 12,
+          "x" : 0,
+          "type" : "metric",
+          "properties" : {
+            "metrics" : [
+              ["AWS/Lambda", "Invocations", "FunctionName", "GetRemittances", { "region" : "us-east-1" }],
+              ["AWS/Lambda", "Errors", "FunctionName", "GetRemittances", { "region" : "us-east-1" }],
+              ["AWS/Lambda", "Duration", "FunctionName", "GetRemittances", { "stat" : "Average", "region" : "us-east-1" }],
+              ["AWS/Lambda", "Throttles", "FunctionName", "GetRemittances", { "region" : "us-east-1" }]
+            ],
+            "sparkline" : false,
+            "view" : "singleValue",
+            "region" : "us-east-1",
+            "stat" : "Sum",
+            "period" : 300,
+            "setPeriodToTimeRange" : true,
+            "trend" : false,
+            "title" : "GetRemittance",
+            "stacked" : false
+          }
+        },
+        {
+          "height" : 4,
+          "width" : 11,
+          "y" : 16,
+          "x" : 0,
+          "type" : "metric",
+          "properties" : {
+            "metrics" : [
+              ["AWS/Lambda", "Invocations", "FunctionName", "CreateRemittance"],
+              [".", "Errors", ".", "."],
+              [".", "Duration", ".", ".", { "stat" : "Average" }],
+              [".", "Throttles", ".", "."]
+            ],
+            "sparkline" : false,
+            "view" : "singleValue",
+            "region" : "us-east-1",
+            "period" : 300,
+            "stat" : "Sum",
+            "setPeriodToTimeRange" : true,
+            "trend" : false,
+            "title" : "CreateRemittance"
+          }
+        },
+        {
+          "height" : 10,
+          "width" : 24,
+          "y" : 30,
+          "x" : 0,
+          "type" : "trace",
+          "properties" : {
+            "service" : "ServiceLensWidget",
+            "title" : "Region Failover Solution Traces",
+            "params" : {
+              "view" : "tracesTable",
+              "group" : "Default",
+              "region" : "us-east-1"
+            }
+          }
+        },
+        {
+          "height" : 1,
+          "width" : 12,
+          "y" : 5,
+          "x" : 0,
+          "type" : "text",
+          "properties" : {
+            "markdown" : "### API Gateway"
+          }
+        },
+        {
+          "height" : 1,
+          "width" : 18,
+          "y" : 11,
+          "x" : 0,
+          "type" : "text",
+          "properties" : {
+            "markdown" : "### Lambda"
+          }
+        },
+        {
+          "height" : 1,
+          "width" : 15,
+          "y" : 25,
+          "x" : 0,
+          "type" : "text",
+          "properties" : {
+            "markdown" : "### RDS Aurora PostgreSQL\n"
+          }
+        },
+        {
+          "height" : 4,
+          "width" : 7,
+          "y" : 12,
+          "x" : 11,
+          "type" : "metric",
+          "properties" : {
+            "metrics" : [
+              ["LambdaGetRemittance", "AccessDeniedException", { "color" : "#d62728", "label" : "SecretsManager AccessDeniedException" }],
+              [".", "DBConnectionTimedOut"]
+            ],
+            "sparkline" : false,
+            "view" : "singleValue",
+            "region" : "us-east-1",
+            "title" : "GetRemittance - Function Errors",
+            "period" : 300,
+            "stat" : "Sum",
+            "setPeriodToTimeRange" : true,
+            "trend" : false
+          }
+        }
+      ]
+    }
+  )
+  dashboard_name = "example"
+
+}
+
+
+data "aws_caller_identity" "current" {}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
@@ -33,4 +298,4 @@ Import is supported using the following syntax:
 
 ```shell
 $ terraform import awscc_cloudwatch_dashboard.example <resource ID>
-```
+```