feat(lambda): support enums in loggingFormat #28942

ConnorRobertson · 2024-01-31T19:05:08Z

Issue

The issue is that LogFormat is a String so it doesn't allow the enum LogFormat.

Solution

Created a new enum for the LoggingFormat and added testing.
So the solution sets these values as potential environment variables.
The main difference is LoggingFormat is assigned to an enum instead of a string.

Important Design Decisions

This is so that an enum could be used for LoggingFormat without breaking JSII target languages. Some background information is in this pr #28127. Was a recommended solution here. #28127

Remember to follow the CONTRIBUTING GUIDE and DESIGN GUIDELINES for any
code you submit.

Closes #28114.

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

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.

ConnorRobertson · 2024-01-31T22:31:46Z

packages/aws-cdk-lib/aws-lambda/lib/function.ts

@@ -501,6 +519,12 @@ export interface FunctionOptions extends EventInvokeConfigOptions {
   */
  readonly logFormat?: string;


Here is where it is not an enum.

ConnorRobertson · 2024-01-31T22:31:47Z

packages/aws-cdk-lib/aws-lambda/lib/function.ts

+   * Sets the loggingFormat for the function.
+   * @default Text format
+   */
+  readonly loggingFormat?: LoggingFormat;


Here is the enum change.

aws-cdk-automation · 2024-01-31T22:54:19Z

AWS CodeBuild CI Report

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

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

mergify · 2024-01-31T22:58:31Z

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 # (if applicable) Fixes bug in LoggingFormat `@default` ### Reason for this change Incorrect #28114 related issue ### Description of changes Not much to describe here. ### Description of how you validated changes Shouldn't need any as there is integ tests from this pr #28942 ### 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) BREAKING CHANGE: changing the default type of `lambda.loggingFormat`. Previously it was a string `"Text format"`, not it is an enum `LoggingFormat.TEXT`. *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

> # Issue > > The issue is that LogFormat is a String so it doesn't allow the enum LogFormat. > # Solution > > Created a new enum for the LoggingFormat and added testing. So the solution sets these values as potential environment variables. The main difference is LoggingFormat is assigned to an enum instead of a string. > # Important Design Decisions > > This is so that an enum could be used for LoggingFormat without breaking JSII target languages. Some background information is in this pr #28127. Was a recommended solution here. #28127 > > Remember to follow the [CONTRIBUTING GUIDE] and [DESIGN GUIDELINES] for any > code you submit. > > [CONTRIBUTING GUIDE]: https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md > [DESIGN GUIDELINES]: https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md Closes #28114. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

### Issue # (if applicable) Fixes bug in LoggingFormat `@default` ### Reason for this change Incorrect #28114 related issue ### Description of changes Not much to describe here. ### Description of how you validated changes Shouldn't need any as there is integ tests from this pr #28942 ### 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) BREAKING CHANGE: changing the default type of `lambda.loggingFormat`. Previously it was a string `"Text format"`, not it is an enum `LoggingFormat.TEXT`. *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

> # Issue > > The issue is that LogFormat is a String so it doesn't allow the enum LogFormat. > # Solution > > Created a new enum for the LoggingFormat and added testing. So the solution sets these values as potential environment variables. The main difference is LoggingFormat is assigned to an enum instead of a string. > # Important Design Decisions > > This is so that an enum could be used for LoggingFormat without breaking JSII target languages. Some background information is in this pr #28127. Was a recommended solution here. #28127 > > Remember to follow the [CONTRIBUTING GUIDE] and [DESIGN GUIDELINES] for any > code you submit. > > [CONTRIBUTING GUIDE]: https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md > [DESIGN GUIDELINES]: https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md Closes #28114. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

### Issue # (if applicable) Fixes bug in LoggingFormat `@default` ### Reason for this change Incorrect #28114 related issue ### Description of changes Not much to describe here. ### Description of how you validated changes Shouldn't need any as there is integ tests from this pr #28942 ### 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) BREAKING CHANGE: changing the default type of `lambda.loggingFormat`. Previously it was a string `"Text format"`, not it is an enum `LoggingFormat.TEXT`. *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

ConnorRobertson added 4 commits January 25, 2024 16:11

Function + unit tests

f7b6418

integ-test

7e1cec9

Merge branch 'aws:main' into logging-format

64cdcab

Merge branch 'main' into logging-format

e6d0a50

github-actions bot added bug This issue is a bug. effort/small Small work item – less than a day of effort p2 labels Jan 31, 2024

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

ConnorRobertson marked this pull request as draft January 31, 2024 19:05

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

ConnorRobertson marked this pull request as ready for review January 31, 2024 19:05

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

View reviewed changes

ConnorRobertson marked this pull request as draft January 31, 2024 19:08

Update README.md

03cec18

ConnorRobertson requested a review from aws-cdk-automation January 31, 2024 19:38

ConnorRobertson marked this pull request as ready for review January 31, 2024 19:42

Merge branch 'main' into logging-format

e043d7b

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

ConnorRobertson added 3 commits January 31, 2024 14:09

Consistent format in error message

187f8c4

Merge branch 'main' into logging-format

1db12d2

Adding a space at the end of file

993d271

ConnorRobertson commented Jan 31, 2024

View reviewed changes

paulhcsun approved these changes Jan 31, 2024

View reviewed changes

mergify bot merged commit fb2329f into aws:main Jan 31, 2024
16 checks passed

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

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

Monthly PR metrics report - Jan 2024 #28952

Closed

ConnorRobertson mentioned this pull request Feb 2, 2024

fix(lambda): LoggingConfig default error #28973

Merged

1 task

aaythapa mentioned this pull request Apr 22, 2024

fix(lambda): use enum values for applicationLogLevel and systemLogLevel #29904

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(lambda): support enums in loggingFormat #28942

feat(lambda): support enums in loggingFormat #28942

ConnorRobertson commented Jan 31, 2024 •

edited by aaythapa

Loading

aws-cdk-automation left a comment

ConnorRobertson Jan 31, 2024

ConnorRobertson Jan 31, 2024

aws-cdk-automation commented Jan 31, 2024

mergify bot commented Jan 31, 2024

		@@ -501,6 +519,12 @@ export interface FunctionOptions extends EventInvokeConfigOptions {
		*/
		readonly logFormat?: string;

feat(lambda): support enums in loggingFormat #28942

feat(lambda): support enums in loggingFormat #28942

Conversation

ConnorRobertson commented Jan 31, 2024 • edited by aaythapa Loading

Issue

Solution

Important Design Decisions

aws-cdk-automation left a comment

Choose a reason for hiding this comment

ConnorRobertson Jan 31, 2024

Choose a reason for hiding this comment

ConnorRobertson Jan 31, 2024

Choose a reason for hiding this comment

aws-cdk-automation commented Jan 31, 2024

AWS CodeBuild CI Report

mergify bot commented Jan 31, 2024

ConnorRobertson commented Jan 31, 2024 •

edited by aaythapa

Loading