Skip to content

Commit

Permalink
Add Troubleshooting section to generated README
Browse files Browse the repository at this point in the history
  • Loading branch information
biphobe committed Oct 29, 2024
1 parent 2211002 commit f6e9379
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions assets/monitoring/aws-template/README.md.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,24 @@ Monitoring setup for MCA generated by the MCA CLI tool
* `npm run synth` Emits the synthesized CloudFormation template
* `npm run diff` Compare deployed stack with current state
* `npm run deploy` Deploy this stack to your default AWS account/region

## Troubleshooting

### CloudFormation: "Rate exceeded"

Stacks are being deployed all at once by default.

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.:

```js
import * as mca from "mca-monitoring";

const app = mca.createApp();

const stack = mca.setupMonitoringStack(app, "monitoring");
const logGroupMonitoringStacks = stack.addDefaultLogGroupMonitoring();

logGroupMonitoringStacks.forEach(logGroupMonitoringStack => {
stack.addDefaultLambdaMonitoring().forEach(defaultStack => defaultStack.addDependency(logGroupMonitoringStack));
})
```

0 comments on commit f6e9379

Please sign in to comment.