feat(core): custom resources deprecate `logRetention` in favor of `logGroup` #28783

mrgrain · 2024-01-19T19:00:46Z

In #28737 we have deprecated logRetention in favor of logGroup. Some custom resources have made the logRetention property part of their own API and are now emitting deprecation warnings with no way forward to resolve them. So we are now also deprecating logRetention for any custom resources.

Migrating log groups for custom resource would follow the same steps as outline in #28737. Given that custom resource logging is for debugging purposes and there are no guarantees about the output format, it should be possible to simply replace logRetention with a simple logGroup in most cases:

const awsCustom1 = new cr.AwsCustomResource(this, 'API1', {
  // Replace this
  logRetention: logs.RetentionDays.ONE_WEEK,
  // with
  logGroup: new logs.LogGroup(this, 'AwsCustomResourceLogs', {
    retention: logs.RetentionDays.ONE_WEEK,
  }),
});

Fixes #28806
Fixes #28809
Related to #28737

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

…avor of `logGroup` See #28737 for full details. Some custom resources have made the `logRetention` property part of their own API. In these cases, we are now also deprecating `logRetention`. Migrating log groups for custom resource would follow the same steps as outline in #28737. Given that custom resource logging is for debugging purposes and there are no guarantees about the output format, it should be possible to simply replace `logRetention` with a simple `logGroup` in most cases: ```ts const awsCustom1 = new cr.AwsCustomResource(this, 'API1', { // Replace this logRetention: logs.RetentionDays.ONE_WEEK, // with logGroup: new logs.LogGroup(this, 'AwsCustomResourceLogs', { retention: logs.RetentionDays.ONE_WEEK, }), }); ```

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

kaizencc

I am also surprised by lack of tests -- is the behavior already being tested elsewhere?

packages/aws-cdk-lib/aws-s3-deployment/lib/bucket-deployment.ts

mrgrain · 2024-01-19T21:02:42Z

I am also surprised by lack of tests -- is the behavior already being tested elsewhere?

Yes Function has extensive tests. The intermediates (AwsCustomResourceSingletonFunction and BucketDeploymentSingletonFunction) are codegen'd.

But you're right. I need to update a few tests.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

mrgrain · 2024-01-19T21:31:08Z

@kaizencc Added tests. Hope that satisfies your standards 😅

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

kaizencc

Yay :)

mergify · 2024-01-22T17:45:21Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2024-01-22T18:12:13Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 9e11bbd
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2024-01-22T18:12:35Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

### Issue Closes #28919 ### Reason for this change In #28737 and #28783 we have deprecated various `logRetention` properties in favor of the new Logging Configuration feature for Lambda Functions. This new feature provides full control over the Lambda Function log group via the `logGroup` property. However Logging Configuration is not available yet for all regions. Particularly GovCloud and CN regions (at the time this issue was created). For customers in of these regions there is currently no clear migration path. We therefore revert the deprecation of previously deprecated properties. ### Description of changes Revert the deprecation of previously deprecated `logRetention` properties. Update documentation to be more explicit about the various options customers have. ### Description of how you validated changes Documentation & annotation change only. This is a partial revert of the PRs linked about, with minor documentation updates. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

saurabhmarwaha · 2024-02-15T05:33:13Z

@mrgrain Any solution or workaround to this yet? I am still getting this error. Specific issue that I am getting is given in #28809

I didn't understand what to do based on

[WARNING] aws-cdk-lib.aws_lambda.FunctionOptions#logRetention is deprecated.
instead create a fully customizable log group with logs.LogGroup and use the logGroup property to instruct the Lambda function to send logs to it.
Migrating from logRetention to logGroup will cause the name of the log group to change.
Users and code and referencing the name verbatim will have to adjust.

In AWS CDK code, you can access the log group name directly from the LogGroup construct:

declare const myLogGroup: logs.LogGroup;
myLogGroup.logGroupName;

mrgrain · 2024-02-15T08:50:41Z

@saurabhmarwaha This was originally fixed in v2.123.0 and the deprecation was later reverted in v2.125.0. Please update your version of aws-cdk-lib.

aws-cdk-automation requested a review from a team January 19, 2024 19:01

github-actions bot added the p2 label Jan 19, 2024

mergify bot added the contribution/core This is a PR that came from AWS. label Jan 19, 2024

aws-cdk-automation previously requested changes Jan 19, 2024

View reviewed changes

mrgrain added pr-linter/exempt-test The PR linter will not require test changes pr-linter/exempt-integ-test The PR linter will not require integ test changes labels Jan 19, 2024

deprecation save assignment

b78ad0f

mrgrain marked this pull request as ready for review January 19, 2024 20:10

mrgrain changed the title ~~feat(core): custom resources deprecate logRetention properties in favor of logGroup~~ feat(core): custom resources deprecate logRetention in favor of logGroup Jan 19, 2024

mrgrain mentioned this pull request Jan 19, 2024

feat(lambda): deprecate logRetention properties in favor of logGroup #28737

Merged

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 19, 2024

kaizencc reviewed Jan 19, 2024

View reviewed changes

packages/aws-cdk-lib/aws-s3-deployment/lib/bucket-deployment.ts Show resolved Hide resolved

packages/aws-cdk-lib/aws-s3-deployment/lib/bucket-deployment.ts Show resolved Hide resolved

packages/aws-cdk-lib/aws-s3-deployment/lib/bucket-deployment.ts Show resolved Hide resolved

mrgrain removed pr-linter/exempt-test The PR linter will not require test changes pr-linter/exempt-integ-test The PR linter will not require integ test changes labels Jan 19, 2024

aws-cdk-automation previously requested changes Jan 19, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 19, 2024

make kaizen happy

106bc14

mrgrain requested a review from kaizencc January 19, 2024 21:30

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 19, 2024

laurelmay mentioned this pull request Jan 22, 2024

aws-lambda: logRetention deprecation messages for Provider or CustomResource (most likely) #28806

Closed

github-actions bot added the bug This issue is a bug. label Jan 22, 2024

mrgrain mentioned this pull request Jan 22, 2024

aws-s3-deployment: logRetention is deprecated warnings #28809

Closed

mrgrain added p1 and removed p2 labels Jan 22, 2024

kaizencc approved these changes Jan 22, 2024

View reviewed changes

Merge branch 'main' into mrgrain/feat/deprecate-more-log-retention

9e11bbd

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 22, 2024

mergify bot merged commit ea34c89 into main Jan 22, 2024
15 checks passed

mergify bot deleted the mrgrain/feat/deprecate-more-log-retention branch January 22, 2024 18:12

mrgrain mentioned this pull request Jan 31, 2024

fix: revert deprecation of logRetention properties #28934

Merged

1 task

github-actions bot mentioned this pull request Feb 1, 2024

Monthly PR metrics report - Jan 2024 #28952

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): custom resources deprecate `logRetention` in favor of `logGroup` #28783

feat(core): custom resources deprecate `logRetention` in favor of `logGroup` #28783

mrgrain commented Jan 19, 2024 •

edited

Loading

aws-cdk-automation left a comment

kaizencc left a comment

mrgrain commented Jan 19, 2024

aws-cdk-automation left a comment

mrgrain commented Jan 19, 2024

kaizencc left a comment

mergify bot commented Jan 22, 2024

aws-cdk-automation commented Jan 22, 2024

mergify bot commented Jan 22, 2024

saurabhmarwaha commented Feb 15, 2024

mrgrain commented Feb 15, 2024

feat(core): custom resources deprecate logRetention in favor of logGroup #28783

feat(core): custom resources deprecate logRetention in favor of logGroup #28783

Conversation

mrgrain commented Jan 19, 2024 • edited Loading

aws-cdk-automation left a comment

Choose a reason for hiding this comment

kaizencc left a comment

Choose a reason for hiding this comment

mrgrain commented Jan 19, 2024

aws-cdk-automation left a comment

Choose a reason for hiding this comment

mrgrain commented Jan 19, 2024

kaizencc left a comment

Choose a reason for hiding this comment

mergify bot commented Jan 22, 2024

aws-cdk-automation commented Jan 22, 2024

AWS CodeBuild CI Report

mergify bot commented Jan 22, 2024

saurabhmarwaha commented Feb 15, 2024

mrgrain commented Feb 15, 2024

feat(core): custom resources deprecate `logRetention` in favor of `logGroup` #28783

feat(core): custom resources deprecate `logRetention` in favor of `logGroup` #28783

mrgrain commented Jan 19, 2024 •

edited

Loading