GUI telemetry

GUI telemetry provides information about how operators interact with the Vault web interface. Vault emits telemetry events only when an operator enables GUI telemetry and a user grants consent. Events carry a generic IBM Tracking Plan event type and a set of properties for semantic context. Vault never includes PII, secrets, or request bodies. Users can withdraw consent at any time from User preferences -> Data & Privacy -> Share usage metrics.

To turn on GUI telemetry so Vault starts gathering these events, refer to the Enable Vault UI telemetry gathering guide.

Emitted as a UI Interaction event when a user clicks a primary or sub-navigation item in the sidebar.

Property	Value	Notes
`namespace`	`"nav"`
`action`	`"clicked"`
`elementId`	`"nav-dashboard"`, `"nav-secrets"`, and similar	One value per sidebar destination: `nav-dashboard`, `nav-secrets`, `nav-access-control`, `nav-acl-policies`, `nav-auth-methods`, `nav-namespaces`, `nav-operational-tools`, `nav-reporting`, `nav-client-count`, `nav-billing-metrics`, `nav-raft-storage`, `nav-resilience-recovery`
`CTA`	Navigation item label	For example, `"Dashboard"`, `"Secrets"`, `"Access control"`
`channel`	`"webpage"`

Dashboard

Quick actions

Emitted as a CTA Clicked event when a user clicks a call-to-action in the quick actions widget or triggers a navigate action.

Property	Value	Notes
`CTA`	Button or link label
`channel`	`"webpage"`
`location`	`"dashboard"`
`objectType`	`"quick-actions-widget"`, `"secrets-engine-widget"`	`quick-actions-widget` for CTA link clicks, `secrets-engine-widget` for navigate actions
`uiElement`	`"quick-action-cta"`, `"quick-action-navigate"`
`type`	`"Link"`, `"Button"`
`action`	`"clicked"`, `"navigated"`
`object`	Secrets engine type, for example `"kv"`, `"pki"`	Only present for navigate actions

Emitted as a UI Interaction event when a user clicks View all in the secrets engines dashboard widget.

Property	Value	Notes
`namespace`	`"dashboard"`
`action`	`"clicked"`
`elementId`	`"dashboard-secrets-engine-view-all"`
`channel`	`"webpage"`

Emitted as a UI Interaction event when a user clicks a specific plugin in the secrets engines dashboard widget.

Property	Value	Notes
`namespace`	`"dashboard"`
`action`	`"clicked"`
`elementId`	`"dashboard-secrets-engine-view"`
`channel`	`"webpage"`
`objectType`	`"secrets-engine"`
`object`	Backend type of the clicked engine	For example, `"kv"`, `"pki"`, `"transit"`

Emitted as a UI Interaction event when a user clicks the back button in the feature spotlight widget.

Property	Value	Notes
`action`	`"clicked"`
`channel`	`"webpage"`
`elementId`	`"feature-spotlight-card-<card_index>"`
`location`	`"dashboard"`
`object`	Title of the current card
`objectType`	`"feature-spotlight-widget"`
`type`	`"Button"`
`uiElement`	`"back-button"`

Emitted as a UI Interaction event when a user clicks the next button in the feature spotlight widget.

Property	Value	Notes
`action`	`"clicked"`
`channel`	`"webpage"`
`elementId`	`"feature-spotlight-card-<card_index>"`
`location`	`"dashboard"`
`object`	Title of the current card
`objectType`	`"feature-spotlight-widget"`
`type`	`"Button"`
`uiElement`	`"next-button"`

Emitted as a CTA Clicked event when a user clicks Learn more in the feature spotlight widget.

Property	Value	Notes
`action`	`"clicked"`
`channel`	`"webpage"`
`CTA`	`"Learn more"`
`elementId`	`"feature-spotlight-learn-more"`
`location`	`"dashboard"`
`object`	Title of the current card
`objectType`	`"feature-spotlight-widget"`
`type`	`"Link"`
`uiElement`	`"learn-more-link"`

Intro pages

Secrets engines intro

Emitted as a CTA Clicked event when a user interacts with a call-to-action on the secrets engines intro page or modal.

Property	Value	Notes
`CTA`	`"Guided start"`, `"Skip"`, `"Close"`
`channel`	`"webpage"`
`location`	`"intro-page"`
`objectType`	`"secrets-engine"`
`variation`	`"modal"`, `"page"`	`modal` for the overlay, `page` for the full page
`uiElement`	CTA identifier
`type`	`"Button"`
`action`	`"clicked"`, `"dismissed"`

Auth methods intro

Emitted as a CTA Clicked event when a user interacts with a call-to-action on the auth methods intro page or modal.

Property	Value	Notes
`CTA`	`"Guided start"`, `"Skip"`, `"Close"`
`channel`	`"webpage"`
`location`	`"intro-page"`
`objectType`	`"auth-method"`
`variation`	`"modal"`, `"page"`	`modal` for the overlay; `page` for the full page
`uiElement`	CTA identifier
`type`	`"Button"`
`action`	`"clicked"`, `"dismissed"`

ACL policies intro

Emitted as a CTA Clicked event when a user interacts with a call-to-action on the ACL policies intro page or modal.

Property	Value	Notes
`CTA`	`"Guided start"`, `"Skip"`, `"Close"`
`channel`	`"webpage"`
`location`	`"intro-page"`
`objectType`	`"acl-policy"`
`variation`	`"modal"`, `"page"`	`modal` for the overlay, `page` for the full page
`uiElement`	CTA identifier
`type`	`"Button"`
`action`	`"clicked"`, `"dismissed"`

Namespaces intro

Emitted as a CTA Clicked event when a user interacts with a call-to-action on the namespaces intro page or modal.

Property	Value	Notes
`CTA`	`"Guided start"`, `"View docs"`, `"Skip"`, `"Close"`
`channel`	`"webpage"`
`location`	`"intro-page"`
`objectType`	`"namespace"`
`variation`	`"modal"`, `"page"`	`modal` for the overlay, `page` for the full page
`uiElement`	CTA identifier
`type`	`"Button"`
`action`	`"clicked"`, `"dismissed"`

Reopening an intro

Emitted as a UI Interaction event when a user reopens a previously dismissed intro from a resource list page.

Property	Value	Notes
`namespace`	`"intro-page"`
`action`	`"clicked"`
`elementId`	`"intro-reopen-button"`
`channel`	`"webpage"`
`objectType`	`"secrets-engine"`, `"auth-method"`, `"acl-policy"`, `"namespace"`	The resource whose intro reopened

Namespace wizard

Security policy selection

Emitted as a UI Interaction event when a user selects a security policy in step 1 of the namespace wizard.

Property	Value	Notes
`namespace`	`"namespace-wizard"`
`action`	`"selected"`
`elementId`	`"policy-toggle"`
`channel`	`"webpage"`
`location`	`"step-1"`
`object`	`"flexible"`, `"strict"`	`flexible` for a single namespace, `strict` for multiple namespaces

Tips section collapse

Emitted as a UI Interaction event when a user collapses the tips reveal section in step 2 of the namespace wizard. Fires only on collapse, not on re-expand.

Property	Value	Notes
`namespace`	`"namespace-wizard"`
`action`	`"clicked"`
`elementId`	`"tips-reveal"`
`channel`	`"webpage"`
`location`	`"step-2"`

Namespace field input

Emitted as a UI Interaction event the first time a user types in the namespace name field. De-duplicated to fire at most once per wizard session, regardless of how many keystrokes occur.

Property	Value	Notes
`namespace`	`"namespace-wizard"`
`action`	`"typed"`
`elementId`	`"namespace-field"`
`channel`	`"webpage"`
`location`	`"step-2"`

Creation method selection

Emitted as a UI Interaction event when a user configures a new namespace in step 3 of the wizard. The selected method (Terraform, CLI/API, or UI) determines which event constant Vault uses internally, but the event type is the same for all three.

Property	Value	Notes
`namespace`	`"namespace-wizard"`
`action`	`"selected"`
`elementId`	`"method-selector"`
`channel`	`"webpage"`
`location`	`"step-3"`

Resource creation

Secrets engine created

Emitted as a Created Object event when a user submits the enable secrets engine form. Vault records the event regardless of whether the form succeeds or fails.

Property	Value	Notes
`objectType`	`"secrets-engine"`
`object`	Engine type, version-suffixed where applicable	For example, `"kv-v2"`, `"pki"`
`process`	`"UI"`
`successFlag`	`true`, `false`	`true` on success, `false` on failure

Auth method created

Emitted as a Created Object event when a user submits the enable auth method form. Vault records the event regardless of whether the form succeeds or fails.

Property	Value	Notes
`objectType`	`"auth-method"`
`object`	Auth method type	For example, `"oidc"`, `"github"`, `"userpass"`
`process`	`"UI"`
`successFlag`	`true`, `false`	`true` on success, `false` on failure

ACL policy created

Emitted as a Created Object event when a user saves a policy in the policy editor. Vault records the event regardless of whether the save succeeds or fails.

Property	Value	Notes
`objectType`	`"policy"`
`object`	Policy type	For example, `"acl"`, `"rgp"`, `"egp"`
`process`	`"UI"`
`successFlag`	`true`, `false`	`true` on success, `false` on failure

Policy creation cancelled

Emitted as a UI Interaction event when a user cancels out of the policy creation form without saving.

Property	Value	Notes
`namespace`	`"resource-creation"`
`action`	`"cancelled"`
`elementId`	`"policy-form"`
`channel`	`"webpage"`
`objectType`	`"policy"`
`object`	Policy type at cancellation	For example, `"acl"`, `"rgp"`, `"egp"`

Namespace created

Emitted as a Created Object event when the namespace wizard submits a creation request. Vault records the event regardless of whether the request succeeds or fails.

Property	Value	Notes
`objectType`	`"namespace"`
`object`	Security policy from step 1	`"flexible"`, `"strict"`, or undefined if step 1 did not complete
`process`	`"UI"`
`quantity`	Number of namespaces submitted	Batch size for the creation request
`successFlag`	`true`, `false`	`true` on success, `false` on failure

User preferences

User role set

Emitted as a UI Interaction event when a user sets a specific role from a given set of roles or provides a custom role indicative of their persona in Vault.

Property	Value	Notes
`action`	`"persona_set"`
`channel`	`"webpage"`
`elementId`	`"persona-select"`
`location`	`"user-preferences"`
`namespace`	`"user-preferences"`
`object`	The type of persona set
`objectType`	`"persona"`

Appearance theme set

Emitted as a UI Interaction event when a user toggles between appearance themes.

Property	Value	Notes
`action`	`"theme_set"`
`channel`	`"webpage"`
`elementId`	`"theme-select"`
`location`	`"user-preferences"`
`namespace`	`"user-preferences"`
`object`	The appearance theme set	For example, `"light"`, `"dark"` or `"system"`
`objectType`	`"theme"`