dtkt telemetry
CommandDisplay or toggle telemetry collection.
Description
Display the current telemetry status or enable/disable telemetry collection.
Use off to disable telemetry and on to enable it. Omit the argument to view the current telemetry status.
It respects the DTKT_DO_NOT_TRACK and DO_NOT_TRACK environment variables, which can be set to true or 1to disable telemetry regardless of what may be defined in the config.
By default, telemetry is off and we do not yet prompt to turn it on as this feature has not been implemented yet; enabling it currently has no effect! In the future we will ask users if they would let us enable it on the first CLI run.
Telemetry usage data consists of information about how the CLI is used; such as:
- Commands executed
- Errors encountered
For anonymous users (not logged in to DataKit Cloud) we exclude any potentially sensitive flags or arguments from telemetry data to keep telemetry data anonymous. DataKit Cloud users/organizations will have the option to require or opt-in to detailed telemetry logging for auditing purposes.
This data helps us improve the CLI experience and prioritize features based on real-world usage.
To learn more about telemetry, visit https://withdatakit.com/docs/telemetry and or check out our privacy policy.
Usage
dtkt telemetry [off/on] [flags]Flags
| Field | Default | Usage |
|---|---|---|
| --compact, -c | false | Compact output (no extra whitespace). |
| --expr | CEL expression to filter/transform output data. | |
| --help, -h | false | Show help for the telemetry command. |
| --output-delim | Output delimiter when streaming, format-specific defaults: (json: "\n", yaml: "---\n"). | |
| --output-file, -w | stdout | Output file: (PATH|stdout|stderr). |
| --output-format, -o | pretty | Output format: [pretty | json | yaml | go-template]. |
| --output-stream | false | Encode output list as stream of individual items. |
| --raw | false | Raw output (unquoted when output is a single string). |
| --redact | false | Redact sensitive data from output. |
| --template | Template string; when set, output format | |
| --template-file | Template file path; when set, output format |
Inherited Flags
| Field | Default | Usage |
|---|---|---|
| --accept-legal-notices | false | Accept legal notices (license). |
| --cloud | false | Overrides the contexts to cloud; equivalent to --contexts=cloud. |
| --cloud-org | Cloud Organization by (UID|NAME). | |
| --cloud-space | Cloud Space by (UID|NAME). | |
| --config | The active configuration name to override. | |
| --contexts | [] | Overrides any current contexts from config. |
| --local | false | Overrides the contexts to local; equivalent to --contexts=local. |
| --log-format | pretty | Log format: (text|json|pretty). |
| --log-level | info | Log level: (debug|info|warn|error). |
| --non-interactive | false | Run in non-interactive mode. |
| --remote | false | Overrides the contexts to the configured remote. |