neptune: add monitoring props and utility methods #20248

humanzz · 2022-05-07T15:38:51Z

Describe the feature

Update the Neptune DatabaseCluster construct to improve the monitoring experience

Update props to enable configuring CloudWatch Logs
- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html
- It seems like the only supported log type at the moment is audit
  - https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html
  - https://docs.aws.amazon.com/neptune/latest/userguide/auditing.html
Expose metricsXxx utility methods
- https://docs.aws.amazon.com/neptune/latest/userguide/cw-metrics.html
- https://docs.aws.amazon.com/neptune/latest/userguide/cw-dimensions.html

Use Case

Improving the monitoring experience for Neptune Clusters

Proposed Solution

No response

Other Information

No response

Acknowledgements

I may be able to implement this feature request
This feature might incur a breaking change

CDK version used

2.21.1

Environment details (OS name and version, etc.)

macOS

The text was updated successfully, but these errors were encountered:

indrora · 2022-07-19T17:32:59Z

Setting up logs appears to require AWS SDK access. Unless something Terribly Weird is going on with their Parameter configuration, setting up CloudWatch logs involves a custom integration added into the AWS CLI.

humanzz · 2022-09-04T16:10:42Z

@indrora Setting up logs does not require AWS SDK access. There are 2 steps involved

A parameter needs to be setup in the parameter group to enable audit logs https://docs.aws.amazon.com/neptune/latest/userguide/auditing.html#auditing-enable
A config needs to be set on the cluster to enable exporting the logs to cloudwatch logs

As such

a prop can be exposed to allow configuring https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-enablecloudwatchlogsexports on the cluster
This is where things get interesting as I wonder if in the presence of the prop above, should there be any checks on the input parameter groups, or even creating a default one or should that simply be left for the construct user to do the right thing

indrora · 2022-09-06T21:30:37Z

Ah, I see now. Thanks.

yeah this is a gap in the CloudFormation coverage.

humanzz · 2022-09-08T20:01:02Z

I came across #15888 which seems to be asking for the same thing as 1 above

Naumel · 2022-09-09T08:09:26Z

@humanzz Good eye!

I will close this issue in favor of the older one.

An extra 👍 on the feature request will make it easier for the team to gauge interest.

Additionally, thank you for the detailed inputs you have provided, it always appreciated!

github-actions · 2022-09-09T08:10:03Z

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

related to aws#20248

- introduce LogType and CloudwatchLogsExports for use in DatabaseClusterProps - introduce cloudwatchLogsExports prop to configure which log types should be exported to CloudWatch Logs and optionally set log retention - update tests and integ tests - update README related to aws#20248 closes aws#15888

kaizencc · 2022-09-13T00:14:12Z

Reopening this one to track the request for metricsXxx utility methods.

humanzz · 2022-09-19T12:17:27Z

Thanks @kaizencc
I just hope someone is able to start reviewing it soon :)

closes #20248 ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

github-actions · 2022-09-22T13:09:06Z

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

- introduce LogType and CloudwatchLogsExports for use in DatabaseClusterProps - introduce cloudwatchLogsExports prop to configure which log types should be exported to CloudWatch Logs and optionally set log retention - update tests and integ tests - update README related to #20248 closes #15888 ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [x] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

- introduce LogType and CloudwatchLogsExports for use in DatabaseClusterProps - introduce cloudwatchLogsExports prop to configure which log types should be exported to CloudWatch Logs and optionally set log retention - update tests and integ tests - update README related to aws#20248 closes aws#15888 ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [x] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

…1995) closes aws#20248 ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

- introduce LogType and CloudwatchLogsExports for use in DatabaseClusterProps - introduce cloudwatchLogsExports prop to configure which log types should be exported to CloudWatch Logs and optionally set log retention - update tests and integ tests - update README related to aws#20248 closes aws#15888 ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [x] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

humanzz added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels May 7, 2022

github-actions bot added the @aws-cdk/aws-neptune Related Amazon Neptune label May 7, 2022

github-actions bot assigned skinny85 May 7, 2022

indrora added p2 feature/coverage-gap Gaps in CloudFormation coverage by L2 constructs feature/service-integration Add functionality to an L2 construct to enable easier integration with another service and removed needs-triage This issue or PR still needs to be triaged. labels Jul 19, 2022

indrora added p1 and removed p2 labels Sep 6, 2022

Naumel closed this as completed Sep 9, 2022

Naumel mentioned this issue Sep 9, 2022

(@aws-cdk/aws-neptune): Amazon CloudWatch Logs Exports properties not available for class DatabaseCluster in Neptune #15888

Closed

2 tasks

humanzz mentioned this issue Sep 9, 2022

neptune: refactor DatabaseCluster to use DatabaseInstance instead of CfnDBInstance #21972

Closed

2 tasks

humanzz added a commit to humanzz/aws-cdk that referenced this issue Sep 11, 2022

feat(neptune): introduc metric method to cluster and instance

2e112ef

related to aws#20248

humanzz mentioned this issue Sep 11, 2022

feat(neptune): introduce metric method to cluster and instance #21995

Merged

4 tasks

humanzz mentioned this issue Sep 12, 2022

feat(neptune): enable cloudwatch logs exports #22004

Merged

4 tasks

kaizencc reopened this Sep 13, 2022

mergify bot closed this as completed in #21995 Sep 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

neptune: add monitoring props and utility methods #20248

neptune: add monitoring props and utility methods #20248

humanzz commented May 7, 2022

indrora commented Jul 19, 2022

humanzz commented Sep 4, 2022

indrora commented Sep 6, 2022

humanzz commented Sep 8, 2022

Naumel commented Sep 9, 2022

github-actions bot commented Sep 9, 2022

kaizencc commented Sep 13, 2022 •

edited

Loading

humanzz commented Sep 19, 2022

github-actions bot commented Sep 22, 2022

neptune: add monitoring props and utility methods #20248

neptune: add monitoring props and utility methods #20248

Comments

humanzz commented May 7, 2022

Describe the feature

Use Case

Proposed Solution

Other Information

Acknowledgements

CDK version used

Environment details (OS name and version, etc.)

indrora commented Jul 19, 2022

humanzz commented Sep 4, 2022

indrora commented Sep 6, 2022

humanzz commented Sep 8, 2022

Naumel commented Sep 9, 2022

github-actions bot commented Sep 9, 2022

⚠️COMMENT VISIBILITY WARNING⚠️

kaizencc commented Sep 13, 2022 • edited Loading

humanzz commented Sep 19, 2022

github-actions bot commented Sep 22, 2022

⚠️COMMENT VISIBILITY WARNING⚠️

kaizencc commented Sep 13, 2022 •

edited

Loading