Product usage reporting

Appropriate Vault Enterprise license required

HashiCorp collects usage data about how Vault clusters are being used. This data is not used for billing or and is numerical only, and no sensitive information of any nature is being collected. The data is GDPR compliant and is collected as part of the license utilization reporting process. If automated reporting is enabled, this data will be collected automatically. If automated reporting is disabled, then this will be collected as part of the manual reports.

Opt out

While none of the collected usage metrics are sensitive in any way, if you are still concerned about these usage metrics being reported, then you can opt-out of them being collected.

If you are considering opting out because you’re worried about the data, we strongly recommend that you review the usage metrics list before opting out. If you have concerns with any of the automatically-reported data please bring them to your account manager.

You have two options to opt out of product usage collection:

HCL configuration (recommended)
Environment variable (requires restart)

HCL configuration

Opting out in your product's configuration file doesn't require a system restart, and is the method we recommend. Add the following block to your server configuration file (e.g. vault-config.hcl).

reporting {  disable_product_usage_reporting = true}

Warning

When you have a cluster, each node must have the reporting stanza in its configuration to be consistent. In the event of leadership change, nodes will use its server configuration to determine whether or not to opt-out the product usage collection. Inconsistent configuration between nodes will change the reporting status upon active unseal.

You will find the following entries in the server log.

[DEBUG] activity: there is no reporting agent configured, skipping counts reporting

Environment variable

If you need to, you can also opt out using an environment variable, which will provide a startup message confirming that you have product usage data collection. This option requires a system restart.

Note

If the reporting stanza exists in the configuration file, the OPTOUT_PRODUCT_USAGE_REPORTING value overrides the configuration.

Set the following environment variable.

$ export OPTOUT_PRODUCT_USAGE_REPORTING=true

Now, restart your Vault servers from the shell where you set the environment variable.

You will find the following entries in the server log.

[DEBUG] core: product usage reporting disabled

If your configuration file and environment variable differ, the environment variable setting will take precedence.

Usage metrics list

HashiCorp collects the following product usage metrics as part of the metrics part of the JSON payload that it collects for licence utilization. All of these metrics are numerical, and contain no sensitive values or additional metadata:

Metric Name	Description
`vault.namespaces.count`	Total number of namespaces.
`vault.leases.count`	Total number of leases within Vault.
`vault.quotas.ratelimit.count`	Total number of rate limit quotas within Vault.
`vault.quotas.leasecount.count`	Total number of lease count quotas within Vault.
`vault.kv.version1.secrets.count`	Total number of KVv1 secrets within Vault.
`vault.kv.version2.secrets.count`	Total number of KVv2 secrets within Vault.
`vault.kv.version1.secrets.namespace.max`	The highest number of KVv1 secrets in a namespace in Vault, e.g. `1000`.
`vault.kv.version2.secrets.namespace.max`	The highest number of KVv2 secrets in a namespace in Vault, e.g. `1000`.
`vault.kv.version1.secrets.namespace.min`	The lowest number of KVv1 secrets in a namespace in Vault, e.g. `2`.
`vault.kv.version2.secrets.namespace.min`	The highest number of KVv2 secrets in a namespace in Vault, e.g. `1000`.
`vault.kv.version1.secrets.namespace.mean`	The mean number of KVv1 secrets in namespaces in Vault, e.g. `52.8`.
`vault.kv.version2.secrets.namespace.mean`	The mean number of KVv2 secrets in namespaces in Vault, e.g. `52.8`.
`vault.auth.method.approle.count`	The total number of Approle auth mounts in Vault.
`vault.auth.method.alicloud.count`	The total number of Alicloud auth mounts in Vault.
`vault.auth.method.aws.count`	The total number of AWS auth mounts in Vault.
`vault.auth.method.appid.count`	The total number of App ID auth mounts in Vault.
`vault.auth.method.azure.count`	The total number of Azure auth mounts in Vault.
`vault.auth.method.cloudfoundry.count`	The total number of Cloud Foundry auth mounts in Vault.
`vault.auth.method.github.count`	The total number of GitHub auth mounts in Vault.
`vault.auth.method.gcp.count`	The total number of GCP auth mounts in Vault.
`vault.auth.method.jwt.count`	The total number of JWT auth mounts in Vault.
`vault.auth.method.kerberos.count`	The total number of Kerberos auth mounts in Vault.
`vault.auth.method.kubernetes.count`	The total number of kubernetes auth mounts in Vault.
`vault.auth.method.ldap.count`	The total number of LDAP auth mounts in Vault.
`vault.auth.method.oci.count`	The total number of OCI auth mounts in Vault.
`vault.auth.method.okta.count`	The total number of Okta auth mounts in Vault.
`vault.auth.method.pcf.count`	The total number of PCF auth mounts in Vault.
`vault.auth.method.radius.count`	The total number of Radius auth mounts in Vault.
`vault.auth.method.saml.count`	The total number of SAML auth mounts in Vault.
`vault.auth.method.cert.count`	The total number of Cert auth mounts in Vault.
`vault.auth.method.oidc.count`	The total number of OIDC auth mounts in Vault.
`vault.auth.method.token.count`	The total number of Token auth mounts in Vault.
`vault.auth.method.userpass.count`	The total number of Userpass auth mounts in Vault.
`vault.auth.method.plugin.count`	The total number of custom plugin auth mounts in Vault.

Usage metadata list

HashiCorp collects the following product usage metadata as part of the metadata part of the JSON payload that it collects for licence utilization:

Metadata Name	Description
`replication_status`	Replication status of this cluster, e.g. `perf-disabled,dr-disabled`