What is collected
Each run ofxbox creates at most one event, xbox.cli.command_invocation, with these fields
and nothing else:
A command or option name the CLI doesn’t define is sent as
unknown or left out, so a value
typed in the wrong place is never sent.
Approximate location
The CLI never sends your location. However, Application Insights derives an approximate location (country, region or state, and city) from the IP address that sends the event, and stores it on every event. The IP address itself isn’t kept; it’s stored as0.0.0.0. The
location is used only to understand adoption across markets. Opting out stops all
telemetry, including this location.
What isn’t collected
The CLI doesn’t collect argument or option values, request or response bodies, PlayFab title IDs, seller IDs, sandbox IDs, usernames, tenant or account IDs, access tokens, file paths, configured secrets, error messages, or the machine’s name.When the event is sent
When a command succeeds, the CLI saves the event on disk, and a later run sends it, so the command doesn’t wait on the network. When a command fails, the CLI waits at most 300 milliseconds to send its event and any saved ones. In CI, where the CLI might not run again, it sends the event before it exits instead of saving it. That can add up to about 5 seconds when the endpoint is slow, and the event is dropped if it isn’t sent in that time.Version header
Separately from telemetry, every request the CLI sends with an access token carries aUser-Agent: XboxDevCLI/<version> header, such as XboxDevCLI/0.1.0.9, so those services can
tell which CLI versions call them. It holds nothing else, and opting out of telemetry doesn’t
remove it.
First-run disclosure
The first time the CLI collects telemetry on a machine, it writes this notice to stderr, once:Opt out
For one command
Pass--disable-telemetry:
For the current shell session
SetXBOX_TELEMETRY_OPTOUT in PowerShell:
1, true, and yes turn telemetry off, whatever else is configured. Setting
XBOX_TELEMETRY__ENABLED to false turns it off too.
For every new terminal
Set the variable for your account. On Windows, run this, then reopen your terminal, and your IDE if you use its integrated terminal:export line to your shell’s startup file, such as ~/.zshrc or
~/.bashrc, the same way Installation adds the CLI to PATH.
Where telemetry goes
Release builds send telemetry to a Microsoft-owned Azure Monitor Application Insights resource, which you can’t change. The CLI ignoresAPPLICATIONINSIGHTS_CONNECTION_STRING, so a host that
sets it for its own application doesn’t redirect the CLI’s telemetry.