Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Reintroduce Monitoring option using CDK Monitoring Constructs. #278

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

DerDackel
Copy link
Contributor

  • Please check if the PR fulfills these requirements
  • The commit message describes your change
  • Tests for the changes have been added if possible (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Changes are mentioned in the changelog (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Re-add the monitoring option from cdk-serverless v1. This implementation builds on the cdk-monitoring-constructs library in hopes of keeping implementation effort for anything monitorting- and alerting-related low.

  • What is the current behavior? (You can also link to an open issue here)

There's a monitoring flag on the cdk-serverless' API constructs, but it currently does nothing.

  • What is the new behavior (if this is a feature change)?

A Cloudwatch dashboard with monitoring widgets for each API construct, including its endpoint Lambdas will be created if the monitoring flag is activated.

  • Does this PR introduce a breaking change? (What changes might users need to make in their setup due to this PR?)

As cdk-monitoring-constructs currently requires at least aws-cdk v2.112.0, this will raise the minimum required CDK version on cdk-serverless.

  • Other information:

Currently a rough draft, just to get something started as a discussion point on where to go. Not 100% sure about the usefulness of cdk-monitoring-constructs, I'm planning on evaluating it within the scope of this PR or return to a custom implementation if it proves not to be a good fit.
At the very least, I'd like to see the old Cloudwatch dashboard reconstructed. If possible, I want this to provide a base for an easy alerting abstraction over the API constructs, using Cloudwatch Alarms.

@DerDackel
Copy link
Contributor Author

WIP screenshot of the first draft dashboard: First Draft Rest API Dashboard

@hoegertn
Copy link
Contributor

Hi, any timeline for this PR?

@DerDackel
Copy link
Contributor Author

Currently got a bunch of work stuff to do, so will probably return to this one by the end of next week. Do you have any input on how the dashboard should look?

@DerDackel DerDackel force-pushed the reintroduce-monitoring branch from e72aa62 to 373de6c Compare February 26, 2024 06:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants