chore: change logging to use a single base logging method #32081

HBobertz · 2024-11-11T05:02:22Z

Closes #32039

Modified the existing logging mechanism to route to a single log function. Adapted the existing structure so that very minimal changes were required for existing logging functions and how they are used today

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.

codecov · 2024-11-12T04:55:36Z

Codecov Report

Attention: Patch coverage is 97.05882% with 2 lines in your changes missing coverage. Please review.

Project coverage is 78.19%. Comparing base (be000a2) to head (237e74d).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32081      +/-   ##
==========================================
+ Coverage   77.46%   78.19%   +0.72%     
==========================================
  Files         105      105              
  Lines        7168     7176       +8     
  Branches     1314     1318       +4     
==========================================
+ Hits         5553     5611      +58     
+ Misses       1433     1377      -56     
- Partials      182      188       +6

Flag	Coverage Δ
suite.unit	`78.19% <97.05%> (+0.72%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`78.19% <97.05%> (+0.72%)`	⬆️

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

mrgrain · 2024-11-27T11:58:03Z

packages/aws-cdk/lib/cli.ts

@@ -49,7 +49,7 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
  const argv = await parseCommandLineArguments(args, makeBrowserDefault(), await availableInitLanguages(), MIGRATE_SUPPORTED_LANGUAGES as string[], version.DISPLAY_VERSION, yargsNegativeAlias);

  if (argv.verbose) {
-    setLogLevel(argv.verbose);
+    setLogLevelByValue(argv.verbose+2);


That's unexepected. If intentional it needs a comment why.

mrgrain · 2024-11-27T12:04:31Z

packages/aws-cdk/lib/api/util/cloudformation/stack-activity-monitor.ts

@@ -674,8 +674,7 @@ export class CurrentActivityPrinter extends ActivityPrinterBase {
  public start() {
    // Need to prevent the waiter from printing 'stack not stable' every 5 seconds, it messes
    // with the output calculations.
-    this.oldLogLevel = logLevel;
-    setLogLevel(LogLevel.DEFAULT);
+    setLogLevel(LogLevel.INFO);


okay for now but we will need to get rid of this eventually. setLogLevel should only every be set once as it affects the output. These messages just need to be logged with the correct level (or not at all).

mrgrain

1 small request. Otherwise the build is not passing.

mrgrain · 2024-11-27T16:59:56Z

packages/aws-cdk/lib/cli.ts

+  // if one -v, log at a DEBUG level
+  // if 2 -v, log at a TRACE level


What about -vvv

Suggested change

// if one -v, log at a DEBUG level

// if 2 -v, log at a TRACE level

// if -v, log at a DEBUG level

// if -vv, log at a TRACE level

aws-cdk-automation · 2024-11-27T17:56:13Z

AWS CodeBuild CI Report

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

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

mergify · 2024-11-27T18:07:08Z

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

github-actions · 2024-11-27T18:07:32Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

logging changes

726cad2

aws-cdk-automation requested a review from a team November 11, 2024 05:02

github-actions bot added the p2 label Nov 11, 2024

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

github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. labels Nov 11, 2024

HBobertz had a problem deploying to test-pipeline November 11, 2024 05:03 — with GitHub Actions Failure

aws-cdk-automation previously requested changes Nov 11, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Nov 11, 2024

Merge branch 'main' into bobertzh/logging

2050aaf

HBobertz requested a deployment to test-pipeline November 12, 2024 04:33 — with GitHub Actions Waiting

update log level default

a944f4b

HBobertz requested a deployment to test-pipeline November 12, 2024 04:40 — with GitHub Actions Waiting

remove unnecessary line

5c5bcfc

HBobertz temporarily deployed to test-pipeline November 12, 2024 04:45 — with GitHub Actions Inactive

HBobertz marked this pull request as ready for review November 12, 2024 14:46

Merge branch 'main' into bobertzh/logging

bf92086

HBobertz requested a deployment to test-pipeline November 12, 2024 19:02 — with GitHub Actions Waiting

Merge branch 'main' into bobertzh/logging

f2dc7a4

HBobertz requested a review from a team as a code owner November 22, 2024 04:07

HBobertz temporarily deployed to test-pipeline November 22, 2024 04:08 — with GitHub Actions Inactive

HBobertz and others added 2 commits November 24, 2024 18:58

fix data() convenience method to always push to stdout

107d3ad

Merge branch 'main' into bobertzh/logging

c5c865c

HBobertz temporarily deployed to test-pipeline November 25, 2024 00:00 — with GitHub Actions Inactive

logging testing

cb815f5

HBobertz temporarily deployed to test-pipeline November 25, 2024 02:30 — with GitHub Actions Inactive

HBobertz added 2 commits November 24, 2024 21:51

fix tests

1f53ed0

clean up comments

994f030

HBobertz temporarily deployed to test-pipeline November 25, 2024 02:52 — with GitHub Actions Inactive

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

clean up and tsdoc code

e5c9634

HBobertz requested a deployment to test-pipeline November 27, 2024 05:33 — with GitHub Actions Waiting

mrgrain reviewed Nov 27, 2024

View reviewed changes

mrgrain requested changes Nov 27, 2024

View reviewed changes

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

remove unnecessary function

7587528

HBobertz requested a deployment to test-pipeline November 27, 2024 14:00 — with GitHub Actions Waiting

HBobertz and others added 2 commits November 27, 2024 09:30

further testing

c3331ad

Merge branch 'main' into bobertzh/logging

fd01852

HBobertz requested a deployment to test-pipeline November 27, 2024 14:31 — with GitHub Actions Waiting

fix licences

19b1465

HBobertz requested a deployment to test-pipeline November 27, 2024 14:52 — with GitHub Actions Waiting

add cli testing

7f4ade2

HBobertz requested a deployment to test-pipeline November 27, 2024 15:29 — with GitHub Actions Waiting

even better cli testing

a735e2d

HBobertz requested a deployment to test-pipeline November 27, 2024 15:33 — with GitHub Actions Waiting

HBobertz requested a review from mrgrain November 27, 2024 16:33

mrgrain reviewed Nov 27, 2024

View reviewed changes

remove unnecessary bool check

237e74d

HBobertz requested a deployment to test-pipeline November 27, 2024 17:26 — with GitHub Actions Waiting

mrgrain approved these changes Nov 27, 2024

View reviewed changes

mergify bot merged commit 069b72c into main Nov 27, 2024
17 of 18 checks passed

mergify bot deleted the bobertzh/logging branch November 27, 2024 18:07

github-actions bot locked as resolved and limited conversation to collaborators Nov 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: change logging to use a single base logging method #32081

chore: change logging to use a single base logging method #32081

HBobertz commented Nov 11, 2024 •

edited

Loading

aws-cdk-automation left a comment

codecov bot commented Nov 12, 2024 •

edited

Loading

mrgrain Nov 27, 2024

mrgrain Nov 27, 2024

mrgrain left a comment

mrgrain Nov 27, 2024

aws-cdk-automation commented Nov 27, 2024

mergify bot commented Nov 27, 2024

github-actions bot commented Nov 27, 2024

		// if one -v, log at a DEBUG level
		// if 2 -v, log at a TRACE level

chore: change logging to use a single base logging method #32081

chore: change logging to use a single base logging method #32081

Conversation

HBobertz commented Nov 11, 2024 • edited Loading

aws-cdk-automation left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 12, 2024 • edited Loading

Codecov Report

mrgrain Nov 27, 2024

Choose a reason for hiding this comment

mrgrain Nov 27, 2024

Choose a reason for hiding this comment

mrgrain left a comment

Choose a reason for hiding this comment

mrgrain Nov 27, 2024

Choose a reason for hiding this comment

aws-cdk-automation commented Nov 27, 2024

AWS CodeBuild CI Report

mergify bot commented Nov 27, 2024

github-actions bot commented Nov 27, 2024

HBobertz commented Nov 11, 2024 •

edited

Loading

codecov bot commented Nov 12, 2024 •

edited

Loading