Skip to main content
The CDK Terrain CLI can send two kinds of data to the CDKTN project’s Sentry: anonymous usage metrics and crash reports. Each one has its own consent flag in your cdktf.json file. The maintainers use this data to decide which features, languages, and providers to prioritize.
Before v0.25, the CLI reported usage data to HashiCorp Checkpoint. v0.25 removed Checkpoint, and the CLI no longer contacts checkpoint-api.hashicorp.com. See What’s New: Usage Metrics and Consent.
sendUsageTelemetry controls usage metrics, and sendCrashReports controls crash reports:
cdktf.json
  • To turn usage metrics off everywhere, for example on CI runners, set CHECKPOINT_DISABLE to a non-empty value. It takes precedence over cdktf.json.
  • The flags accept booleans or the strings "true" and "false". Any other value counts as missing.
  • The CLI only prompts when stdin and stdout are terminals, it isn’t running in CI, and the project has a cdktf.json file to save the answer to.
  • cdktn init asks both questions for a new project. To answer them without a prompt, pass --enable-usage-telemetry=true|false and --enable-crash-reporting=true|false.
  • If you agree to usage metrics only, the CLI sends no crash reports.

Usage metrics

Usage metrics are counters and durations, aggregated per run. They cover the commands you run and whether they succeed, your environment (CI system, project language, operating system, Terraform or OpenTofu version, declared targetVersions, and package manager), and counts that describe your stacks, such as the backend type and the public registry providers you use. The v0.25 release notes list every metric and which commands report them. Sentry adds a random install ID, stored in ~/.cdktf/config.json. To create a new ID, delete that file. The CLI never sends stack names, construct IDs, resource addresses, file paths, your hostname or username, error messages, or SENTRY_* environment variables. Private registry hosts and module sources are reduced to a category such as private-registry, git, or local.

Crash Reporting

Crash reports help the maintainers improve the stability of the CLI. A crash report includes a stack trace and the log events that happened before the error. The CLI only sends a report when an error occurs, and it doesn’t report usage errors. The CLI sends no crash reports unless the sendCrashReports property in your cdktf.json file is true. If the property is missing, the CLI asks you in an interactive terminal and saves your answer. To stop sending crash reports, set the property to false.