> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Telemetría

> Qué telemetría anónima de uso del producto recopila la CLI y cómo desactivarla.

La XBOX CLI recopila telemetría de uso anónima y limitada para ayudar a Microsoft a comprender qué
comandos se usan, qué fiabilidad tienen y cuánto tardan. Puedes
[desactivarla](#opt-out). La telemetría nunca cambia la salida ni el código de salida de un comando.

Microsoft trata estos datos tal como se describe en la
[declaración de privacidad de Microsoft](https://go.microsoft.com/fwlink/?LinkID=824704). El
[aviso de privacidad](https://github.com/xbox/cli/blob/v0.4.2/PRIVACY.md) del repositorio abarca la recopilación de datos que realiza el software.

## Qué se recopila

Cada ejecución de `xbox` crea como máximo un evento, `xbox.cli.command_invocation`, con estos campos
y nada más:

| Campo | Contiene |
| - | - |
| `xbox.cli.schema_version` | La versión del esquema del evento, `3` |
| Hora | Cuándo se ejecutó el comando, redondeada a la baja a la hora |
| `service.version` | La versión de la CLI |
| `os.type`, `os.version` | La familia del sistema operativo, como `windows`, y solo su versión principal |
| `host.arch` | La arquitectura del procesador: `amd64`, `arm64` o `unknown` |
| `process.runtime.name`, `process.runtime.version` | El entorno de ejecución de .NET y su versión |
| `xbox.cli.command` | La ruta del comando en el árbol de comandos, unida con guiones, como `playfab-economy-inventory-transaction-list`; `root` para `xbox` solo; `unknown` cuando no se reconoció ningún comando |
| `xbox.cli.auth_mode` | Cómo inició sesión la CLI: `user`, un modo de entidad de servicio como `githuboidc`, o `invalid`; nunca el inquilino, la aplicación ni la identidad |
| `xbox.cli.outcome` | `success`, `failure` o `cancelled` |
| `process.exit.code` | El código de salida |
| `error.type` | Por qué falló un comando, de una lista fija: `usage`, `context`, `auth`, `not_confirmed`, `transport`, `service_rejected`, `service_error`, `local_tool`, `io`, `cancelled` o `_OTHER`. No se envía si el comando se ejecuta correctamente. |
| `http.response.status_code` | El estado de la última respuesta del servicio, cuando la hubo |
| `xbox.cli.duration_ms` | Cuánto tardó el comando, en milisegundos |
| `xbox.cli.options` | Los nombres de las opciones proporcionadas, sin guiones y ordenados, como `output,verbose`; nunca sus valores |
| `xbox.cli.context_keys` | Qué valores de contexto tenía el comando, ya sea de una opción, de una variable de entorno o del contexto guardado: `playfab-title-id`, `sandbox-id`, `seller-id` o `title-id`; nunca los valores |
| `xbox.cli.ci` | `true` cuando está establecida una variable de CI conocida, como `CI` o `TF_BUILD`; solo se lee si está establecida |

Un nombre de comando u opción que la CLI no define se envía como `unknown` o se omite, por lo que nunca se envía un valor
escrito en el lugar equivocado.

### Ubicación aproximada

La CLI nunca envía tu ubicación. Sin embargo, Application Insights deriva una ubicación
aproximada (país, región o estado, y ciudad) de la dirección IP que envía el evento, y
la almacena en cada evento. La dirección IP en sí no se conserva; se almacena como `0.0.0.0`. La
ubicación solo se usa para comprender la adopción en los distintos mercados. [Desactivar la telemetría](#opt-out) detiene toda
la telemetría, incluida esta ubicación.

## Qué no se recopila

La CLI no recopila valores de argumentos ni de opciones, cuerpos de solicitudes ni de respuestas, id. de título
de PlayFab, id. de vendedor, id. de sandbox, nombres de usuario, id. de inquilino ni de cuenta, tokens de acceso, rutas de archivo,
secretos configurados, mensajes de error ni el nombre de la máquina.

## Cuándo se envía el evento

Cuando un comando se ejecuta correctamente, la CLI guarda el evento en el disco y una ejecución posterior lo envía, por lo que el
comando no espera a la red. Cuando un comando falla, la CLI espera como máximo 300
milisegundos para enviar su evento y los que haya guardados. En CI, donde es posible que la CLI no vuelva a ejecutarse,
envía el evento antes de salir en lugar de guardarlo. Esto puede agregar hasta unos 5 segundos cuando
el punto de conexión es lento, y el evento se descarta si no se envía en ese tiempo.

## Encabezado de versión

Independientemente de la telemetría, cada solicitud que la CLI envía con un token de acceso lleva un
encabezado `User-Agent: XboxDevCLI/<version>`, como `XboxDevCLI/0.1.0.9`, para que esos servicios puedan
saber qué versiones de la CLI los llaman. No contiene nada más, y desactivar la telemetría no
lo quita.

## Aviso en la primera ejecución

La primera vez que la CLI recopila telemetría en una máquina, escribe este aviso en stderr, una sola vez:

```text theme={null}
TELEMETRY
  XBOX CLI collects anonymous usage telemetry.
  Learn more or opt out: https://go.xbox/cli/telemetry
```

## Desactivar la telemetría

### Para un comando

Pasa `--disable-telemetry`:

```powershell theme={null}
xbox --disable-telemetry auth status
```

### Para la sesión de shell actual

Establece `XBOX_TELEMETRY_OPTOUT` en PowerShell:

```powershell theme={null}
$env:XBOX_TELEMETRY_OPTOUT = "1"
```

En bash o zsh:

```bash theme={null}
export XBOX_TELEMETRY_OPTOUT=1
```

Los valores `1`, `true` y `yes` desactivan la telemetría, independientemente de cualquier otra configuración. Establecer
`XBOX_TELEMETRY__ENABLED` en `false` también la desactiva.

### Para cada terminal nuevo

Establece la variable para tu cuenta. En Windows, ejecuta lo siguiente y, después, vuelve a abrir el terminal, y tu
IDE si usas su terminal integrado:

```powershell theme={null}
[Environment]::SetEnvironmentVariable("XBOX_TELEMETRY_OPTOUT", "1", "User")
```

En Linux y macOS, agrega la línea `export` al archivo de inicio de tu shell, como `~/.zshrc` o
`~/.bashrc`, del mismo modo que [Instalación](https://docs.xbox.com/es/tools/xbox-cli/installation.md) agrega la CLI a `PATH`.

## Adónde va la telemetría

Las compilaciones de versión envían la telemetría a un recurso de Application Insights de Azure Monitor propiedad de Microsoft,
que no puedes cambiar. La CLI omite `APPLICATIONINSIGHTS_CONNECTION_STRING`, por lo que un host que
la establece para su propia aplicación no redirige la telemetría de la CLI.


## Related topics

- [Telemetría](https://docs.xbox.com/es/services/playfab/data-analytics/ingest-data/telemetry-overview.md)
- [Claves de telemetría](https://docs.xbox.com/es/services/playfab/data-analytics/ingest-data/telemetry-keys-overview.md)
- [Eliminar clave de telemetría](https://docs.xbox.com/es/services/playfab/api-references/rest/events/play-stream-events/delete-telemetry-key.md)
- [Enumerar claves de telemetría](https://docs.xbox.com/es/services/playfab/api-references/rest/events/play-stream-events/list-telemetry-keys.md)
- [Obtener clave de telemetría](https://docs.xbox.com/es/services/playfab/api-references/rest/events/play-stream-events/get-telemetry-key.md)
