Merge pull request #194 from ericzbeard/waterfall

Add Gantt chart output to rain logs command
aws-cloudformation · Sep 7, 2023 · a4083ad · a4083ad
2 parents fe83ac4 + 5b5dc34
commit a4083ad
Show file tree

Hide file tree

Showing 33 changed files with 5,719 additions and 174 deletions.
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ cfn-lint, Guard and more:
 
 * **Consistent formatting of CloudFormation templates**: Using `rain fmt`, you can format your CloudFormation templates to a consistent standard or reformat a template from JSON to YAML (or YAML to JSON if you prefer). Rain preserves your comments when using YAML and switches use of [intrinsic functions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html) to use the short syntax where possible.
 
-* **Combined logs for nested stacks with sensible filtering**: When you run `rain log`, you will see a combined stream of logs from the stack you specified along with any nested stack associated with it. Rain also filters out uninteresting log messages by default so you just see the errors that require attention.
+* **Combined logs for nested stacks with sensible filtering**: When you run `rain log`, you will see a combined stream of logs from the stack you specified along with any nested stack associated with it. Rain also filters out uninteresting log messages by default so you just see the errors that require attention. You can also use `rain log --chart` to see a Gantt chart that shows you how long each operation took for a given stack.
 
 * **Build new CloudFormation templates**: `rain build` generates new CloudFormation templates containing skeleton resources that you specify. This saves you having to look up which properties are available and which are required vs. optional.
 
@@ -107,7 +107,7 @@ The template:
 ```yaml
 Resources:
   Test:
-    Type: AWS::CloudFormation:WaitHandle
+    Type: AWS::CloudFormation::WaitConditionHandle
     Metadata:
       Comment: !Rain::Embed embed.txt
 ```
@@ -122,7 +122,7 @@ The resulting packaged template:
 ```yaml
 Resources:
   Test:
-    Type: AWS::CloudFormation:WaitHandle
+    Type: AWS::CloudFormation::WaitConditionHandle
     Metadata:
       Comment: This is a test
 ```
@@ -406,6 +406,14 @@ Resources:
         RestrictPublicBuckets: true
 ```
 
+### Gantt Chart
+
+Output a chart to an HTML file that you can view with a browser to look at how long stack operations take for each resource.
+
+`rain log --chart CDKToolkit > ~/Desktop/chart.html`
+
+<img src="./docs/chart.png" />
+
 ## Other CloudFormation tools
 
 * [cfn-lint](https://github.com/aws-cloudformation/cfn-python-lint)

diff --git a/cft/pkg/tmpl/embed-expect.yaml b/cft/pkg/tmpl/embed-expect.yaml
@@ -1,6 +1,6 @@
 Resources:
   Test:
-    Type: AWS::CloudFormation:WaitHandle
+    Type: AWS::CloudFormation::WaitConditionHandle
     Metadata:
       Comment: This is a test
 
diff --git a/cft/pkg/tmpl/embed-template.yaml b/cft/pkg/tmpl/embed-template.yaml
@@ -1,6 +1,6 @@
 Resources:
   Test:
-    Type: AWS::CloudFormation:WaitHandle
+    Type: AWS::CloudFormation::WaitConditionHandle
     Metadata:
       Comment: !Rain::Embed embed.txt
 
diff --git a/cft/spec/cfn.go b/cft/spec/cfn.go
diff --git a/docs/README.tmpl b/docs/README.tmpl
@@ -25,7 +25,7 @@ cfn-lint, Guard and more:
 
 * **Consistent formatting of CloudFormation templates**: Using `rain fmt`, you can format your CloudFormation templates to a consistent standard or reformat a template from JSON to YAML (or YAML to JSON if you prefer). Rain preserves your comments when using YAML and switches use of [intrinsic functions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html) to use the short syntax where possible.
 
-* **Combined logs for nested stacks with sensible filtering**: When you run `rain log`, you will see a combined stream of logs from the stack you specified along with any nested stack associated with it. Rain also filters out uninteresting log messages by default so you just see the errors that require attention.
+* **Combined logs for nested stacks with sensible filtering**: When you run `rain log`, you will see a combined stream of logs from the stack you specified along with any nested stack associated with it. Rain also filters out uninteresting log messages by default so you just see the errors that require attention. You can also use `rain log --chart` to see a Gantt chart that shows you how long each operation took for a given stack.
 
 * **Build new CloudFormation templates**: `rain build` generates new CloudFormation templates containing skeleton resources that you specify. This saves you having to look up which properties are available and which are required vs. optional.
 
@@ -81,7 +81,7 @@ The template:
 ```yaml
 Resources:
   Test:
-    Type: AWS::CloudFormation:WaitHandle
+    Type: AWS::CloudFormation::WaitConditionHandle
     Metadata:
       Comment: !Rain::Embed embed.txt
 ```
@@ -96,7 +96,7 @@ The resulting packaged template:
 ```yaml
 Resources:
   Test:
-    Type: AWS::CloudFormation:WaitHandle
+    Type: AWS::CloudFormation::WaitConditionHandle
     Metadata:
       Comment: This is a test
 ```
@@ -380,6 +380,14 @@ Resources:
         RestrictPublicBuckets: true
 ```
 
+### Gantt Chart
+
+Output a chart to an HTML file that you can view with a browser to look at how long stack operations take for each resource.
+
+`rain log --chart CDKToolkit > ~/Desktop/chart.html`
+
+<img src="./docs/chart.png" />
+
 ## Other CloudFormation tools
 
 * [cfn-lint](https://github.com/aws-cloudformation/cfn-python-lint)

diff --git a/docs/bash_completion.sh b/docs/bash_completion.sh
@@ -842,6 +842,10 @@ _rain_logs()
     flags+=("-a")
     local_nonpersistent_flags+=("--all")
     local_nonpersistent_flags+=("-a")
+    flags+=("--chart")
+    flags+=("-c")
+    local_nonpersistent_flags+=("--chart")
+    local_nonpersistent_flags+=("-c")
     flags+=("--help")
     flags+=("-h")
     local_nonpersistent_flags+=("--help")

diff --git a/docs/chart.png b/docs/chart.png
diff --git a/docs/index.md b/docs/index.md
@@ -34,4 +34,4 @@ Rain is a command line tool for working with AWS CloudFormation templates and st
 * [rain tree](rain_tree.md)	 - Find dependencies of Resources and Outputs in a local template
 * [rain watch](rain_watch.md)	 - Display an updating view of a CloudFormation stack
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_bootstrap.md b/docs/rain_bootstrap.md
@@ -30,4 +30,4 @@ rain bootstrap
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_build.md b/docs/rain_build.md
@@ -30,4 +30,4 @@ rain build [<resource type>...]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_cat.md b/docs/rain_cat.md
@@ -31,4 +31,4 @@ rain cat <stack>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_console.md b/docs/rain_console.md
@@ -38,4 +38,4 @@ rain console [stack]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_deploy.md b/docs/rain_deploy.md
@@ -70,4 +70,4 @@ rain deploy <template> [stack]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_diff.md b/docs/rain_diff.md
@@ -28,4 +28,4 @@ rain diff <from> <to>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_fmt.md b/docs/rain_fmt.md
@@ -32,4 +32,4 @@ rain fmt <filename>...
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_forecast.md b/docs/rain_forecast.md
@@ -59,4 +59,4 @@ rain forecast --experimental <template> [stackName]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_info.md b/docs/rain_info.md
@@ -30,4 +30,4 @@ rain info
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_logs.md b/docs/rain_logs.md
@@ -4,7 +4,7 @@ Show the event log for the named stack
 
 ### Synopsis
 
-Shows the event log for a stack and its nested stack. Optionally, filter by a specific resource by name.
+Shows the event log for a stack and its nested stack. Optionally, filter by a specific resource by name, or see a gantt chart of the most recent stack action.
 
 By default, only show log entries that contain a useful message (e.g. a failure message).
 You can use the --all flag to change this behaviour.
@@ -17,6 +17,7 @@ rain logs <stack> (<resource>)
 
 ```
   -a, --all              include uninteresting logs
+  -c, --chart            Output a gantt chart of the most recent action as an html file
   -h, --help             help for logs
   -p, --profile string   AWS profile name; read from the AWS CLI configuration file
   -r, --region string    AWS region to use
@@ -33,4 +34,4 @@ rain logs <stack> (<resource>)
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_ls.md b/docs/rain_ls.md
@@ -30,4 +30,4 @@ rain ls <stack>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_merge.md b/docs/rain_merge.md
@@ -29,4 +29,4 @@ rain merge <template> <template> ...
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_pkg.md b/docs/rain_pkg.md
@@ -66,4 +66,4 @@ rain pkg <template>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_rm.md b/docs/rain_rm.md
@@ -32,4 +32,4 @@ rain rm <stack>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_stackset.md b/docs/rain_stackset.md
@@ -28,4 +28,4 @@ This command manipulates stack sets. It has no action if specific stack set comm
 * [rain stackset ls](rain_stackset_ls.md)	 - List a CloudFormation stack sets in a given region
 * [rain stackset rm](rain_stackset_rm.md)	 - Delete a CloudFormation stack set and/or its instances.
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_stackset_deploy.md b/docs/rain_stackset_deploy.md
@@ -64,4 +64,4 @@ rain stackset deploy <template> [stackset] [flags]
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_stackset_ls.md b/docs/rain_stackset_ls.md
@@ -30,4 +30,4 @@ rain stackset ls <stack set>
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_stackset_rm.md b/docs/rain_stackset_rm.md
@@ -30,4 +30,4 @@ rain stackset rm <stackset>
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_tree.md b/docs/rain_tree.md
@@ -30,4 +30,4 @@ rain tree [template]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023
diff --git a/docs/rain_watch.md b/docs/rain_watch.md
@@ -30,4 +30,4 @@ rain watch <stack>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-Aug-2023
+###### Auto generated by spf13/cobra on 6-Sep-2023