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

(aws-cdk): centralize all cli logging into a single logging function #32039

Closed
1 of 2 tasks
HBobertz opened this issue Nov 6, 2024 · 3 comments · Fixed by #32081
Closed
1 of 2 tasks

(aws-cdk): centralize all cli logging into a single logging function #32039

HBobertz opened this issue Nov 6, 2024 · 3 comments · Fixed by #32081
Assignees
Labels
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 package/tools Related to AWS CDK Tools or CLI

Comments

@HBobertz
Copy link
Contributor

HBobertz commented Nov 6, 2024

Describe the feature

This file defines our logging tools for the CDK CLI. Refactor the logging implementation into a single logging function which takes both a message and the logging type (info, debug, trace, error, etc...), and then additionally ensure any logging in the package uses this logging function.

Use Case

needed to support future CDK Programmatic Access, but also Centralizes and consolidates logging for the CLI.

Proposed Solution

Probably something like

export type LogLevel = 'error' | 'warn' | 'info' | 'debug' | 'trace';

export interface LogEntry = {
  level: LogLevel
  message: string
}

export function log(...args: LogEntry[]) {
  // do the stuff
}

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

Environment details (OS name and version, etc.)

macOS 15 Sequoia

@HBobertz HBobertz added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Nov 6, 2024
@github-actions github-actions bot added the package/tools Related to AWS CDK Tools or CLI label Nov 6, 2024
@HBobertz HBobertz self-assigned this Nov 6, 2024
@ashishdhingra
Copy link
Contributor

Worked upon by CDK team.

@ashishdhingra ashishdhingra added p2 effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. labels Nov 6, 2024
@jiayiwang7 jiayiwang7 added this to the Programmatic Toolkit milestone Nov 26, 2024
@mergify mergify bot closed this as completed in #32081 Nov 27, 2024
@mergify mergify bot closed this as completed in 069b72c Nov 27, 2024
Copy link

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.

1 similar comment
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 package/tools Related to AWS CDK Tools or CLI
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants