Skip to content

Commit f6e9379

Browse files
committed
Add Troubleshooting section to generated README
1 parent 2211002 commit f6e9379

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

assets/monitoring/aws-template/README.md.hbs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,24 @@ Monitoring setup for MCA generated by the MCA CLI tool
99
* `npm run synth` Emits the synthesized CloudFormation template
1010
* `npm run diff` Compare deployed stack with current state
1111
* `npm run deploy` Deploy this stack to your default AWS account/region
12+
13+
## Troubleshooting
14+
15+
### CloudFormation: "Rate exceeded"
16+
17+
Stacks are being deployed all at once by default.
18+
19+
If some stacks contain too many resources for the deployment to succeed, deployment dependencies can be defined to reduce amount of requests sent to CloudFormation, e.g.:
20+
21+
```js
22+
import * as mca from "mca-monitoring";
23+
24+
const app = mca.createApp();
25+
26+
const stack = mca.setupMonitoringStack(app, "monitoring");
27+
const logGroupMonitoringStacks = stack.addDefaultLogGroupMonitoring();
28+
29+
logGroupMonitoringStacks.forEach(logGroupMonitoringStack => {
30+
stack.addDefaultLambdaMonitoring().forEach(defaultStack => defaultStack.addDependency(logGroupMonitoringStack));
31+
})
32+
```

0 commit comments

Comments
 (0)