feat(cli): cli-telemetry status command #697
Open
Conversation
This file contains hidden or 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
kaizencc
commented
Jul 8, 2025
kaizencc
commented
Jul 8, 2025
| /** | ||
| * Whether or not we collect telemetry | ||
| */ | ||
| export function canCollectTelemetry(context: Context): boolean { |
Signed-off-by: github-actions <[email protected]>
aws-cdk-automation
requested a deployment
to
integ-approval
GitHub Actions
Waiting
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #697 +/- ##
==========================================
- Coverage 80.13% 80.06% -0.07%
==========================================
Files 49 50 +1
Lines 7358 7383 +25
Branches 827 828 +1
==========================================
+ Hits 5896 5911 +15
- Misses 1439 1453 +14
+ Partials 23 19 -4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
kaizencc
commented
Jul 8, 2025
.../cli-integ/tests/cli-integ-tests/cli-telemetry/cdk-cli-telemetry-reports-status.integtest.ts
Outdated
Show resolved
Hide resolved
kaizencc
commented
Jul 8, 2025
.../cli-integ/tests/cli-integ-tests/cli-telemetry/cdk-cli-telemetry-reports-status.integtest.ts
Outdated
Show resolved
Hide resolved
iliapolo
reviewed
Jul 13, 2025
| integTest( | ||
| 'CLI Telemetry reports status', | ||
| withDefaultFixture(async (fixture) => { | ||
| const contextFile = path.join(fixture.integTestDir, 'cdk.context.json'); |
There was a problem hiding this comment.
What is the impact of this file on the test?
| ### `cdk cli-telemetry` | ||
|
|
||
| Enables or disables cli telemetry collection for your local CDK App. Records your | ||
| choice in `cdk.context.json`. |
There was a problem hiding this comment.
Can I also set it manually in the context property of cdk.json on the project level?
|
|
||
| You can also check the current status on whether your CDK App is opted in or out of | ||
| cli telemetry collection. Note that this takes into account all methods of disabling | ||
| cli telemetry, including environment variables and preferences set globally in `~/.cdk.json`. |
There was a problem hiding this comment.
And context in <app-root>/cdk.json?
| @@ -206,6 +207,15 @@ export class CdkToolkit { | |||
| await this.props.configuration.saveContext(); | |||
| } | |||
|
|
|||
| public async cliTelemetryStatus() { | |||
| const currentStatus = canCollectTelemetry(this.props.configuration.context); | |||
There was a problem hiding this comment.
Suggested change
| const currentStatus = canCollectTelemetry(this.props.configuration.context); | |
| const canCollect = canCollectTelemetry(this.props.configuration.context); |
Makes the next if easier to read.
| public async cliTelemetryStatus() { | ||
| const currentStatus = canCollectTelemetry(this.props.configuration.context); | ||
| if (currentStatus) { | ||
| await this.ioHost.asIoHelper().defaults.info('CLI Telemetry is enabled. Run \'cdk cli-telemetry --disable\' to disable for this CDK App.'); |
There was a problem hiding this comment.
Maybe link to the README so that the user is also exposed to the other mechanisms?
| }); | ||
|
|
||
| test('returns false if env variable is set', async () => { | ||
| process.env.DISABLE_CLI_TELEMETRY = 'true'; |
There was a problem hiding this comment.
Should be in a finally block that reverts back to the original value (see if we already have a withEnv or something).
|
|
||
| // THEN | ||
| expect(info).toHaveBeenCalledWith('CLI Telemetry is disabled. Run \'cdk cli-telemetry --enable\' to enable for this CDK App.'); | ||
| process.env.CDK_CLI_DISABLE_TELEMETRY = CDK_CLI_DISABLE_TELEMETRY; |
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.
cdk cli-telemetry --statuscommand that reports whether cli telemetry is enabled/disabled.canCollectTelemetrycommand + tests out of feat(cli): send telemetry events to local file #631cli-telemetryto the readmeBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license