Enable Vault GUI telemetry gathering

Collect anonymous usage analytics about how operators interact with the Vault web UI. Vault disables GUI telemetry by default and requires two independent opt-ins:

1. An operator must enable GUI telemetry in the server configuration.
2. Each user must grant consent in the browser for Vault to collect their interactions.

Before you start

• You must have Vault 2.2.0 or later installed and running.
• You must have access to your Vault configuration file.
• You must have the Vault web UI enabled (ui = true).
• You must be able to restart your Vault nodes to apply configuration changes.

Step 1: Enable GUI telemetry in your configuration

Add a ui_settings stanza to your Vault configuration and set ui_telemetry to true.

ui = true

ui_settings {
  ui_telemetry = true
}

GUI telemetry stays off unless you set ui_telemetry to true. To rollback or disable telemetry gathering, set ui_telemetry to false or omit the stanza entirely.

Step 2: Restart Vault

Restart your Vault nodes so the new configuration takes effect (see Run Vault as a service). For an HA cluster, follow the node ordering in the Vault HA upgrade guide. Vault reads GUI settings at startup and does not reload them on SIGHUP.

Step 3: Confirm the setting

Read the GUI settings endpoint to confirm Vault advertises telemetry as enabled:

$ vault read sys/internal/ui/settings

$ vault read sys/internal/ui/settings

Key                   Value
---                   -----
ui_telemetry_enabled  true

$ curl -s \
    --header "X-Vault-Token: $VAULT_TOKEN" \
    $VAULT_ADDR/v1/sys/internal/ui/settings | jq -r ".data"

{
  "ui_telemetry_enabled": true
}

Vault uses responses from the sys/internal/ui/settings endpoint to decide whether to prompt users for consent.

Step 4: Users grant consent

Enabling telemetry in the configuration does not, by itself, collect any data. When you enable GUI telemetry, the web UI prompts each user to opt in. Vault gathers events only after a user grants consent, and never collects PII, secrets, or request bodies.

Users can grant or withdraw consent at any time from User preferences -> Data & Privacy -> Share usage metrics.

For the full list of events and properties Vault gathers once a user consents, see GUI telemetry events.