feat(core): make creationStack collection for Lazy opt-in #11170
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The collection of creation stack traces for each instanciation of a `Lazy` object is fairly slow, and retention of the stack traces incurs a significant toll on heap memory usage; especially in contexts where many such instances are created. In order to remove the performance toll of those and remove the impact on heap allocation, while retaining the ability to get access to the stack traces when they are useful (i.e: for debugging a resolution time issue), the stack trace capture is now conditioned to the `CDK_DEBUG` environment variable being set to `'true'`, which can also be set via the new `--debug` argument of the `cdk` command line tool. BREAKING CHANGE: Creation stack traces for `Lazy` values are no longer captured by default. The `CDK_DEBUG=true` environment variable must be set in order to capture stack traces (this is also achieved by using the `--debug` option of the `cdk` CLI). Users should not need those stack traces most of the time, and should only enable creation stack trace captures when tyring to troubleshoot a resolution error that they are otherwise unable to trace back.
RomainMuller
added
@aws-cdk/core
|
|
RomainMuller
added
the
pr-linter/exempt-readme
rix0rrr
requested changes
Oct 28, 2020
rix0rrr
approved these changes
Oct 28, 2020
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
rix0rrr
added a commit
that referenced
this pull request
Dec 21, 2020
Stack trace captured was intended to be disabled by default in #11170. However, due to a logic error that didn't actually happen. This change *actually* disables stack trace capture. BREAKING CHANGE: Creation stack traces for `Lazy` values are no longer captured by default in order to speed up tests. Run with `CDK_DEBUG=true` (or `cdk --debug`) to capture stack traces.
mergify bot
pushed a commit
that referenced
this pull request
Dec 21, 2020
Stack trace captured was intended to be disabled by default in #11170. However, due to a logic error that didn't actually happen. This change *actually* disables stack trace capture. The intent of the original change was to capture *Token* stack traces if and only if `CDK_DEBUG=true` was set. *Metadata* and *Construct* stack traces are managed in the `constructs` library, no longer in CDK. BREAKING CHANGE: Creation stack traces for `Lazy` values are no longer captured by default in order to speed up tests. Run with `CDK_DEBUG=true` (or `cdk --debug`) to capture stack traces. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
flochaz
pushed a commit
to flochaz/aws-cdk
that referenced
this pull request
Jan 5, 2021
Stack trace captured was intended to be disabled by default in aws#11170. However, due to a logic error that didn't actually happen. This change *actually* disables stack trace capture. The intent of the original change was to capture *Token* stack traces if and only if `CDK_DEBUG=true` was set. *Metadata* and *Construct* stack traces are managed in the `constructs` library, no longer in CDK. BREAKING CHANGE: Creation stack traces for `Lazy` values are no longer captured by default in order to speed up tests. Run with `CDK_DEBUG=true` (or `cdk --debug`) to capture stack traces. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The collection of creation stack traces for each instanciation of a
Lazyobject is fairly slow, and retention of the stack traces incurs asignificant toll on heap memory usage; especially in contexts where many
such instances are created.
In order to remove the performance toll of those and remove the impact
on heap allocation, while retaining the ability to get access to the
stack traces when they are useful (i.e: for debugging a resolution time
issue), the stack trace capture is now conditioned to the
CDK_DEBUGenvironment variable being set to
'true', which can also be set viathe new
--debugargument of thecdkcommand line tool.BREAKING CHANGE: Creation stack traces for
Lazyvalues are no longercaptured by default. The
CDK_DEBUG=trueenvironment variable must beset in order to capture stack traces (this is also achieved by using the
--debugoption of thecdkCLI). Users should not need those stacktraces most of the time, and should only enable creation stack trace
captures when tyring to troubleshoot a resolution error that they are
otherwise unable to trace back.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license