Manage Telemetry in Vega Tools
Amazon collects telemetry to improve the performance, reliability, and usability of its Vega SDK developer tools. Usage data helps Amazon identify issues, prioritize improvements, and deliver a better developer experience. The Vega SDK and its packaged tools collect telemetry by default. This includes command usage, system information (such as OS and architecture), and runtime errors.
Telemetry is not anonymous, as it may include persistent identifiers that can be used to identify you and project-level identifiers (such as app_id) for your app. You can opt out at any time as described in How to opt out of telemetry collection. If telemetry remains enabled, data is collected in the background without additional prompts. For a full list of telemetry collected, see Types of telemetry collected from Vega SDK.
For more information about how Amazon uses personal information, see Amazon’s Privacy Notice.
Types of telemetry collected from Vega SDK
The following telemetry properties are collected across all tools packaged in the Vega SDK:
Properties | Description |
---|---|
component_name | The name of the SDK tool. |
sdk_version | The version of the Vega SDK. |
component_version | The version of the component tool. |
metric_type | The type or category of the collected data. |
operation_name | The name of the main operation. |
suboperation_name | The name of the specific operation. |
metric_value | The value of the collected data. |
architecture | The CPU architecture of your environment. |
os_name | The name of your operating system. |
os_codename | The codename of your operating system. |
os_version_number | The version number of your operating system. |
cpu_name | The name of your CPU. |
instance_id | The unique identifier for the tool instance. |
directed_id | The encrypted identifier for your customer ID. |
machine_id | The hashed identifier for your machine. |
How to opt out of telemetry collection
After installing the Vega SDK, you can disable telemetry collection using one of these options:
Option 1: Opt out by modifying the config
file:
- Open the file,
{$KEPLER_SDK_PATH}/state/kepler-telemetry/config.json
. -
Set the
optIn
key to false:{ "optIn": false }
Option 2: Opt out through Vega Studio
You can also disable telemetry collection through Vega Studio, which syncs the opt-in
flag from the config
file:
- In VS Code, go to Code > Settings > Settings.
- Switch to the User sub-tab.
- In the Settings search bar, enter Kepler: Telemetry.
- In the Telemetry: Telemetry Level panel, select Off from the drop-down list.
Tool-specific telemetry collection
Select a tab to see data collected by each tool.
Additional data collected from Vega Studio
Properties | Description |
---|---|
device_architecture | The architecture of your device (example: ARM or x86). |
device_build_version | The build version installed on your device. |
device_family | The family designation of your device. |
device_in_developer_mode | Indicates if the device is in developer mode. |
device_type | The type of device that the operation targets. |
error_message | The primary message that describes the encountered error. |
error_name | The name or classification of the encountered error. |
notification_message | The notification text shown to users. |
package_id | The unique identifier assigned to your app package. |
project_type | The type of project you're building or running. |
stack_trace | The sequence of method calls leading to an error. |
template_name | The name of the template you're using for your project. |
Additional data collected from Vega CLI
Properties | Description |
---|---|
build_targets | The build target configuration for your Vega CLI build. |
clean_build | Indicates if the build uses cached artifacts. |
cli_variant | The type of Vega CLI in use. |
cli_version | The version number of your Vega CLI. |
incremental_autolink | Specifies if the build is incremental autolink or not. |
install_component | The component installed by the bootstrapper. |
ntc_artifact_size | The size of the build artifact. |
ntc_build_time | The time of the build artifact. |
ntc_matching_file_count | The number of files produced in build. |
package_id | The unique identifier for your app package. |
package_type | The type of package that runs on your device (for example: .vpkg). |
project_type | The type of project you're creating or managing. |
request_id | The unique identifier for your Vega CLI request. |
session_id | The unique identifier for your active Vega CLI session. |
target_device | The type of device you're targeting (Vega Virtual Device or Fire TV Stick). |
template | The template name for your project. |
Additonal data collected from Vega Performance
Properties | Description |
---|---|
app_type | The type of app you're using. |
device_architecture | The architecture of your device (example: ARM or x86). |
device_build_version | The build version installed on your device. |
device_family | The family designation of your device. |
device_in_developer_mode | Indicates if the device is in developer mode. |
device_type | The type of of your target device (example: Vega Virtual Device or Fire TV Stick). |
device_type_id | The unique identifier that represents the specific device model type. |
error_stack | The sequence of method calls leading to an error. |
vs_code_version | The version number of Visual Studio Code. |
profile | The name of the profile. |
kepler_sdk_version | The version of the Vega SDK. |
launch_type | The method used to start the tool (CLI or VS Code). |
return_value | The result returned by the operation. |
duration | The time it takes to complete the operation. |
app_id | The unique identifier for your app. |
Additional data collected from Vega Virtual Device
Properties | Description |
---|---|
image_type | Specifies the device image is for Auto or TV. |
Additional data collected from Appium Vega Driver
Properties | Description |
---|---|
error_code | The error code generated during test. |
log | The captured log messages during test. |
Additional data collected from Vega ESLint Plugin
Properties | Description |
---|---|
rule_id | The identifier of the lint rule. |
message_id | The identifier of the lint message. |
message | The lint message text. |
lint_session_id | The unique identifier for the lint session. |
severity | The severity level of the lint issue. |
suppressions | The list of lint suppressions and their justifications. |
machine_id | The identifier of the machine. |
app_id | The unique identifier for your app. |
Related topics
Last updated: Sep 30, 2025