diff --git a/website/content/api-docs/system/internal-counters.mdx b/website/content/api-docs/system/internal-counters.mdx index 97d4cec5032e..52c470541a5c 100644 --- a/website/content/api-docs/system/internal-counters.mdx +++ b/website/content/api-docs/system/internal-counters.mdx @@ -1037,6 +1037,16 @@ The `/sys/internal/counters/config` endpoint is used to configure logging of act - `enabled` `(string: enable, disable, default)` - Enable or disable counting of client activity. When set to `default`, the client counts are enabled on Enterprise builds and disabled on community builds. Disabling the feature during the middle of a month will discard any data recorded for that month, but does not delete previous months. + + + + + License utilization cannot be reported if client counting is disabled. + + As of 1.16.0, 1.15.6 and 1.14.10, client counting cannot be disabled as manual license utilization reporting is always enabled. + + As of 1.14.0, 1.13.4, 1.12.8 and 1.11.12, client counting cannot be disabled when automated license utilization reporting is enabled. + - `retention_months` `(integer: 48)` - The number of months of history to retain. The minimum is 48 months and the maximum is 60 months. Any missing parameters are left at their existing value. diff --git a/website/content/docs/upgrading/upgrade-to-1.11.x.mdx b/website/content/docs/upgrading/upgrade-to-1.11.x.mdx index 54d775ec70bf..086116f66889 100644 --- a/website/content/docs/upgrading/upgrade-to-1.11.x.mdx +++ b/website/content/docs/upgrading/upgrade-to-1.11.x.mdx @@ -19,6 +19,12 @@ an Elasticsearch version prior to 6, they will need to switch back to the old API path by setting the [bool config option](/vault/api-docs/secret/databases/elasticdb#use_old_xpack) `use_old_xpack=true`. +## Activity Log Changes + +### Disable client counting activity + +License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.11.12 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint when automated license utilization reporting is enabled. + ## Changes @include 'pgx-params.mdx' diff --git a/website/content/docs/upgrading/upgrade-to-1.12.x.mdx b/website/content/docs/upgrading/upgrade-to-1.12.x.mdx index bf1c6abb34c7..683ef04eb4eb 100644 --- a/website/content/docs/upgrading/upgrade-to-1.12.x.mdx +++ b/website/content/docs/upgrading/upgrade-to-1.12.x.mdx @@ -29,6 +29,12 @@ processes were killed after a successful mount and then respawned when a request is routed to them. Vault 1.12.0 introduced auto mutual TLS for secrets/auth plugins so we do not lazy load them on startup anymore. +### Activity Log Changes + +#### Disable client counting activity + +License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.12.8 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint when automated license utilization reporting is enabled. + ## Known issues ### Pinning to builtin plugin versions may cause failure on upgrade diff --git a/website/content/docs/upgrading/upgrade-to-1.13.x.mdx b/website/content/docs/upgrading/upgrade-to-1.13.x.mdx index 9ed4d7443bc6..9a2f684b1d55 100644 --- a/website/content/docs/upgrading/upgrade-to-1.13.x.mdx +++ b/website/content/docs/upgrading/upgrade-to-1.13.x.mdx @@ -97,6 +97,12 @@ are unaffected. @include 'application-of-sentinel-rgps-via-identity-groups.mdx' +### Activity Log Changes + +#### Disable client counting activity + +License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.13.4 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint when automated license utilization reporting is enabled. + ## Known issues @include 'tokenization-rotation-persistence.mdx' diff --git a/website/content/docs/upgrading/upgrade-to-1.14.x.mdx b/website/content/docs/upgrading/upgrade-to-1.14.x.mdx index 59128816d142..d72ac6a6f94b 100644 --- a/website/content/docs/upgrading/upgrade-to-1.14.x.mdx +++ b/website/content/docs/upgrading/upgrade-to-1.14.x.mdx @@ -35,6 +35,16 @@ is measuring cumulative time writing, and not the distribution of individual wri @include 'application-of-sentinel-rgps-via-identity-groups.mdx' +### Activity Log Changes + +#### Disable client counting activity + +License utilization cannot be reported if client counting is disabled. + +As of Vault Enterprise 1.14.10 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint as manual license utilization reporting is always enabled. + +As of Vault Enterprise 1.14.0 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint when automated license utilization reporting is enabled. + ## Known issues and workarounds @include 'known-issues/ui-pki-control-groups.mdx' diff --git a/website/content/docs/upgrading/upgrade-to-1.15.x.mdx b/website/content/docs/upgrading/upgrade-to-1.15.x.mdx index 02007159f4c0..d2429ef2dd38 100644 --- a/website/content/docs/upgrading/upgrade-to-1.15.x.mdx +++ b/website/content/docs/upgrading/upgrade-to-1.15.x.mdx @@ -85,6 +85,12 @@ kubectl exec -ti -- wget https://github.com/moparisthebest/static-curl/re **NOTE:** When using this option you'll want to verify that the static binary comes from a trusted source. +## Activity Log Changes + +### Disable client counting activity + +License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.15.6 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint as manual license utilization reporting is always enabled. + ## Known issues and workarounds @include 'known-issues/1_15-auto-upgrade.mdx' diff --git a/website/content/docs/upgrading/upgrade-to-1.16.x.mdx b/website/content/docs/upgrading/upgrade-to-1.16.x.mdx index 9646a9858009..11ca5ae75d34 100644 --- a/website/content/docs/upgrading/upgrade-to-1.16.x.mdx +++ b/website/content/docs/upgrading/upgrade-to-1.16.x.mdx @@ -96,6 +96,10 @@ decides to trigger the flag. More information can be found in the ### Activity Log Changes +#### Disable client counting activity + +License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.16.0 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint as manual license utilization reporting is always enabled. + #### Default Activity Log Querying Period As of 1.16.13 and later, the field `default_report_months` can no longer be configured or read. Any previously set values diff --git a/website/content/partials/faq/client-count/usage.mdx b/website/content/partials/faq/client-count/usage.mdx index c0dd80396d79..aae80daf93f9 100644 --- a/website/content/partials/faq/client-count/usage.mdx +++ b/website/content/partials/faq/client-count/usage.mdx @@ -62,6 +62,19 @@ and disable the tracking parameter. If you disable client counting in the middle of a month, Vault will discard any data currently recorded for the month. Data for previous months is preserved. + + + + + License utilization cannot be reported if client counting is disabled. + + As of 1.16.0, 1.15.6 and 1.14.10, client counting cannot be disabled as manual license utilization reporting is always enabled. + + As of 1.14.0, 1.13.4, 1.12.8 and 1.11.12, client counting cannot be disabled when automated license utilization reporting is enabled. + + + + ### Can I configure Vault to log the client count data? ((#log-client-count)) **Yes**.