Skip to content

feat(cli): stabilize --telemetry-file option #988

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.

Sign up for GitHub

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

Merged
aws-cdk-automation merged 1 commit into from
Dec 12, 2025
Merged

feat(cli): stabilize --telemetry-file option #988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/@aws-cdk-testing/cli-integ/lib/with-cdk-app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ export class TestFixture extends ShellHelper {
// use events because bar renders bad in tests
'--progress', 'events',
...(skipStackRename ? stackNames : this.fullStackName(stackNames)),
...(options.telemetryFile ? ['--unstable=telemetry', `--telemetry-file=${options.telemetryFile}`] : []),
...(options.telemetryFile ? [`--telemetry-file=${options.telemetryFile}`] : []),
];
}

Expand Down
19 changes: 0 additions & 19 deletions .../tests/cli-integ-tests/cli-telemetry/cdk-cli-telemetry-send-to-file-unstable.integtest.ts
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion ...esting/cli-integ/tests/telemetry-integ-tests/cdk-synth-telemetry-with-errors.integtest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ integTest(
'cdk synth with telemetry and validation error leads to invoke failure',
withDefaultFixture(async (fixture) => {
const telemetryFile = path.join(fixture.integTestDir, `telemetry-${Date.now()}.json`);
const output = await fixture.cdk(['synth', '--unstable=telemetry', `--telemetry-file=${telemetryFile}`], {
const output = await fixture.cdk(['synth', `--telemetry-file=${telemetryFile}`], {
allowErrExit: true,
modEnv: {
INTEG_STACK_SET: 'stage-with-errors',
Expand Down
2 changes: 1 addition & 1 deletion ...s/@aws-cdk-testing/cli-integ/tests/telemetry-integ-tests/cdk-synth-telemetry.integtest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ integTest(
const telemetryFile = path.join(fixture.integTestDir, `telemetry-${Date.now()}.json`);

const synthOutput = await fixture.cdk(
['synth', fixture.fullStackName('test-1'), '--unstable=telemetry', `--telemetry-file=${telemetryFile}`],
['synth', fixture.fullStackName('test-1'), `--telemetry-file=${telemetryFile}`],
{ modEnv: { TELEMETRY_ENDPOINT: TELEMETRY_ENDPOINT }, verboseLevel: 3 }, // trace mode
);

Expand Down
4 changes: 0 additions & 4 deletions packages/aws-cdk/lib/cli/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,6 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
caBundlePath: configuration.settings.get(['caBundlePath']),
});

if (argv['telemetry-file'] && !configuration.settings.get(['unstable']).includes('telemetry')) {
Copy link
Contributor

@iliapolo iliapolo Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will running with --unstable=telemetry-file still work?

Copy link
Contributor Author

@kaizencc kaizencc Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, we're only deleting a check. but also i tested it

throw new ToolkitError('Unstable feature use: \'telemetry-file\' is unstable. It must be opted in via \'--unstable\', e.g. \'cdk deploy --unstable=telemetry --telemetry-file=my/file/path\'');
}

try {
await ioHost.startTelemetry(argv, configuration.context);
} catch (e: any) {
Expand Down
Loading