> ## 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.

# Télémétrie

> La télémétrie anonyme sur l'utilisation du produit que recueille la CLI, et comment la désactiver.

L'XBOX CLI recueille une télémétrie d'utilisation anonyme et limitée pour aider Microsoft à comprendre quelles
commandes sont utilisées, leur fiabilité et leur durée d'exécution. Vous pouvez
[la désactiver](#opt-out). La télémétrie ne modifie jamais la sortie ni le code de sortie d'une commande.

Microsoft traite ces données comme le décrit la
[Déclaration de confidentialité de Microsoft](https://go.microsoft.com/fwlink/?LinkID=824704). L'[avis de confidentialité](https://github.com/xbox/cli/blob/v0.4.2/PRIVACY.md)
du dépôt couvre la collecte de données par le logiciel.

## Ce qui est recueilli

Chaque exécution de `xbox` crée au plus un événement, `xbox.cli.command_invocation`, avec ces champs
et rien d'autre :

| Champ | Contenu |
| - | - |
| `xbox.cli.schema_version` | La version du schéma de l'événement, `3` |
| Heure | Le moment où la commande s'est exécutée, arrondi à l'heure inférieure |
| `service.version` | La version de la CLI |
| `os.type`, `os.version` | La famille du système d'exploitation, comme `windows`, et uniquement sa version majeure |
| `host.arch` | L'architecture du processeur : `amd64`, `arm64` ou `unknown` |
| `process.runtime.name`, `process.runtime.version` | Le runtime .NET et sa version |
| `xbox.cli.command` | Le chemin de la commande dans l'arborescence des commandes, avec des traits d'union entre les éléments, comme `playfab-economy-inventory-transaction-list`; `root` pour `xbox` seul; `unknown` lorsqu'aucune commande n'a été reconnue |
| `xbox.cli.auth_mode` | La façon dont la CLI s'est connectée : `user`, un mode principal de service comme `githuboidc`, ou `invalid`; jamais le locataire, l'application ni l'identité |
| `xbox.cli.outcome` | `success`, `failure` ou `cancelled` |
| `process.exit.code` | Le code de sortie |
| `error.type` | La raison de l'échec d'une commande, parmi une liste fixe : `usage`, `context`, `auth`, `not_confirmed`, `transport`, `service_rejected`, `service_error`, `local_tool`, `io`, `cancelled` ou `_OTHER`. Non envoyé en cas de réussite. |
| `http.response.status_code` | L'état de la dernière réponse du service, s'il y en a eu une |
| `xbox.cli.duration_ms` | La durée d'exécution de la commande, en millisecondes |
| `xbox.cli.options` | Les noms des options fournies, sans tirets, triés, comme `output,verbose`; jamais leurs valeurs |
| `xbox.cli.context_keys` | Les valeurs de contexte dont disposait la commande, qu'elles proviennent d'une option, d'une variable d'environnement ou du contexte enregistré : `playfab-title-id`, `sandbox-id`, `seller-id` ou `title-id`; jamais les valeurs |
| `xbox.cli.ci` | `true` lorsqu'une variable CI bien connue, comme `CI` ou `TF_BUILD`, est définie; seul le fait qu'elle soit définie est lu |

Un nom de commande ou d'option que la CLI ne définit pas est envoyé sous la forme `unknown` ou omis; ainsi, une valeur
tapée au mauvais endroit n'est jamais envoyée.

### Emplacement approximatif

La CLI n'envoie jamais votre emplacement. Toutefois, Application Insights déduit un emplacement
approximatif (pays, région ou province/État, et ville) à partir de l'adresse IP qui envoie l'événement, et
le stocke avec chaque événement. L'adresse IP elle-même n'est pas conservée; elle est stockée sous la forme `0.0.0.0`.
L'emplacement sert uniquement à comprendre l'adoption dans les différents marchés. La [désactivation](#opt-out) arrête toute
la télémétrie, y compris cet emplacement.

## Ce qui n'est pas recueilli

La CLI ne recueille pas les valeurs des arguments ou des options, les corps des requêtes ou des réponses, les ID de titre
PlayFab, les ID de vendeur, les ID de sandbox, les noms d'utilisateur, les ID de locataire ou de compte, les jetons d'accès, les chemins de fichier,
les secrets configurés, les messages d'erreur ni le nom de l'ordinateur.

## Moment de l'envoi de l'événement

Lorsqu'une commande réussit, la CLI enregistre l'événement sur le disque, et une exécution ultérieure l'envoie; ainsi, la
commande n'attend pas le réseau. Lorsqu'une commande échoue, la CLI attend au plus 300
millisecondes pour envoyer son événement et ceux qui ont été enregistrés. En CI, où la CLI pourrait ne pas s'exécuter de nouveau, elle
envoie plutôt l'événement avant de se terminer au lieu de l'enregistrer. Cela peut ajouter jusqu'à environ 5 secondes lorsque
le point de terminaison est lent, et l'événement est abandonné s'il n'est pas envoyé dans ce délai.

## En-tête de version

Indépendamment de la télémétrie, chaque requête que la CLI envoie avec un jeton d'accès comporte un
en-tête `User-Agent: XboxDevCLI/<version>`, comme `XboxDevCLI/0.1.0.9`, afin que ces services puissent
savoir quelles versions de la CLI les appellent. Il ne contient rien d'autre, et la désactivation de la télémétrie ne le
retire pas.

## Avis à la première exécution

La première fois que la CLI recueille de la télémétrie sur un ordinateur, elle écrit cet avis sur stderr, une seule fois :

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

## Désactivation

### Pour une seule commande

Passez `--disable-telemetry` :

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

### Pour la session de shell actuelle

Définissez `XBOX_TELEMETRY_OPTOUT` dans PowerShell :

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

Dans bash ou zsh :

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

Les valeurs `1`, `true` et `yes` désactivent la télémétrie, quelle que soit la configuration par ailleurs. Définir
`XBOX_TELEMETRY__ENABLED` sur `false` la désactive également.

### Pour chaque nouveau terminal

Définissez la variable pour votre compte. Sous Windows, exécutez la commande suivante, puis rouvrez votre terminal, ainsi que votre
IDE si vous utilisez son terminal intégré :

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

Sous Linux et macOS, ajoutez la ligne `export` au fichier de démarrage de votre shell, comme `~/.zshrc` ou
`~/.bashrc`, de la même façon que [Installation](https://docs.xbox.com/fr-CA/tools/xbox-cli/installation.md) ajoute la CLI au `PATH`.

## Destination de la télémétrie

Les builds de version envoient la télémétrie à une ressource Azure Monitor Application Insights appartenant à Microsoft,
que vous ne pouvez pas changer. La CLI ignore `APPLICATIONINSIGHTS_CONNECTION_STRING`; ainsi, un hôte qui
la définit pour sa propre application ne redirige pas la télémétrie de la CLI.


## Related topics

- [Télémétrie](https://docs.xbox.com/fr-CA/services/playfab/data-analytics/ingest-data/telemetry-overview.md)
- [Clés de télémétrie](https://docs.xbox.com/fr-CA/services/playfab/data-analytics/ingest-data/telemetry-keys-overview.md)
- [Supprimer des clés de télémétrie](https://docs.xbox.com/fr-CA/services/playfab/data-analytics/ingest-data/ht-telemetry-keys-delete.md)
- [Répertorier les clés de télémétrie](https://docs.xbox.com/fr-CA/services/playfab/api-references/rest/events/play-stream-events/list-telemetry-keys.md)
- [Supprimer une clé de télémétrie](https://docs.xbox.com/fr-CA/services/playfab/api-references/rest/events/play-stream-events/delete-telemetry-key.md)
