Docs: Update to Reflect Client Count Changes (#30798)

* naming updates

* start of renaming usage-metrics to client-usage

* update screenshots and remove docs for removed charts

* add redirect from usage-metrics to client-usage and rename doc file

* rename links

* add screenshot for attribution table

* update table screenshot

* update urls to new pattern

* Update website/content/docs/commands/operator/usage.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/concepts/client-count/client-usage.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/concepts/client-count/client-usage.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/concepts/client-count/client-usage.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/concepts/client-count/counting.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/partials/faq/client-count/tools.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* alt text improvements + removed outdated faq section

---------

Co-authored-by: claire bontempo <cbontempo@hashicorp.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

ui/app/components/clients/usage-stats.hbs

@@ -15,8 +15,8 @@
       {{@title}}
     </Hds::Text::Display>
     <Hds::Link::Standalone
-      @href={{doc-link "/vault/tutorials/monitoring/usage-metrics"}}
-      @text="Usage metrics tutorial"
+      @href={{doc-link "/vault/docs/concepts/client-count/client-usage"}}
+      @text="Client usage tutorial"
       @icon="learn-link"
       @iconPosition="trailing"
       class="has-bottom-margin-s"

ui/tests/integration/components/clients/page/acme-test.js

@@ -84,7 +84,7 @@ module('Integration | Component | clients | Clients::Page::Acme', function (hook
     assert
       .dom(usageStats('ACME usage'))
       .hasText(
-        `ACME usage Usage metrics tutorial ACME clients which interacted with Vault for the first time each month. Each bar represents the total new ACME clients for that month. Total ACME clients ${expectedTotal}`,
+        `ACME usage Client usage tutorial ACME clients which interacted with Vault for the first time each month. Each bar represents the total new ACME clients for that month. Total ACME clients ${expectedTotal}`,
         'it renders usage stats with single month copy'
       );
   });

ui/tests/integration/components/clients/page/sync-test.js

@@ -97,7 +97,7 @@ module('Integration | Component | clients | Clients::Page::Sync', function (hook
       assert
         .dom(usageStats('Secrets sync usage'))
         .hasText(
-          `Secrets sync usage Usage metrics tutorial Secrets sync clients which interacted with Vault for the first time each month. Each bar represents the total new sync clients for that month. Total sync clients ${expectedTotal}`,
+          `Secrets sync usage Client usage tutorial Secrets sync clients which interacted with Vault for the first time each month. Each bar represents the total new sync clients for that month. Total sync clients ${expectedTotal}`,
           'it renders usage stats with single month copy'
         );
     });

ui/tests/integration/components/clients/usage-stats-test.js

@@ -27,6 +27,6 @@ module('Integration | Component | clients/usage-stats', function (hooks) {
       .hasTextContaining('yielded content!', 'it renders yielded content');
     assert
       .dom('a')
-      .hasAttribute('href', 'https://developer.hashicorp.com/vault/tutorials/monitoring/usage-metrics');
+      .hasAttribute('href', 'https://developer.hashicorp.com/vault/docs/concepts/client-count/client-usage');
   });
 });

website/README.md

@@ -88,7 +88,7 @@ The significant keys in the YAML frontmatter are:
 
 ### Validating Content
 
-Content changes are automatically validated against a set of rules as part of the pull request process. If you want to run these checks locally to validate your content before comitting your changes, you can run the following command:
+Content changes are automatically validated against a set of rules as part of the pull request process. If you want to run these checks locally to validate your content before committing your changes, you can run the following command:
 
 ```
 npm run content-check

website/content/docs/commands/operator/usage.mdx

@@ -18,7 +18,7 @@ requested time range, which may be because the client count reporting is
 disabled, the time range is too far in the past, or no data has yet been
 collected since the feature was enabled.
 
-> Refer to the [Vault Usage Metrics](/vault/tutorials/monitoring/usage-metrics) tutorial to learn more about usage metrics,
+> Refer to the [Vault Client Usage](/vault/docs/concepts/client-count/client-usage) guide to learn more about usage metrics,
 > including required policy and data collection details.
 
 ## Examples

website/content/docs/concepts/client-count/client-usage.mdx

@@ -1,22 +1,22 @@
 ---
 layout: docs
-page_title: Vault usage metrics
+page_title: Vault client usage
 description: |-
   Learn how to discover the number of Vault clients for each namespace in Vault.
 ---
 
-# Vault usage metrics
+# Monitor client usage in Vault
 
 Client calculation and sizing can be complex to compute when you have multiple
-namespaces and auth mounts. The **Vault Usage Metrics** dashboard on Vault UI
+namespaces and auth mounts. The **Vault Client Usage** dashboard in the Vault GUI
 provides the information where you can filter the data by namespace and/or auth
 mounts. You can also use Vault CLI or API to query the usage metrics.
 
-## Enable usage metrics
+## Enable client usage metrics
 
-Usage metrics are a feature that is enabled by default for Vault Enterprise and
+Client usage metrics are a feature that is enabled by default for Vault Enterprise and
 HCP Vault Dedicated. However, if you are running Vault Community Edition, you
-need to enable usage metrics since it is disabled by default.
+need to enable usage data collection since it is disabled by default.
 
 <Tabs>
 <Tab heading="Web UI" group="ui">
@@ -29,15 +29,15 @@ need to enable usage metrics since it is disabled by default.
 
 1. Select **Edit configuration**.
 
-   ![Edit configuration](/img/ui-usage-metrics-config.png)
+   ![Edit configuration button location emphasized](/img/ui-client-usage-config.png)
 
 1. Select the toggle for **Usage data collection** so that the text reads **Data
-   collection  is on**.
+   collection is on**.
 
    <Tip title="Retention period">
 
-    The retention period sets the number of months for which Vault will maintain
-    activity logs to track active clients. (Default: 48 months)
+   The retention period sets the number of months for which Vault will maintain
+   activity logs to track active clients. (Default: 48 months)
 
     </Tip>
 
@@ -56,7 +56,7 @@ Valid values for `enabled` parameter are: `default`, `enable`, and `disable`.
 
 <Tip title="Retention period">
 
- By default, Vault maintains activity logs to track
+By default, Vault maintains activity logs to track
 active clients for 24 months. If you wish to change the retention period, use
 the `retention_months` parameter.
 
@@ -84,7 +84,7 @@ Valid values for `enabled` parameter are: `default`, `enable`, and `disable`.
 
 <Tip title="Retention period">
 
- By default, Vault maintains activity logs to track
+By default, Vault maintains activity logs to track
 active clients for 24 months. If you wish to change the retention period, use
 the `retention_months` parameter.
 
@@ -102,7 +102,7 @@ $ curl --header "X-Vault-Token: <TOKEN>" \
 </Tab>
 </Tabs>
 
-## Usage metrics dashboard
+## Client usage dashboard
 
 1. Sign into Vault UI. The **Client count** section displays the total number of
    clients for the current billing period.
@@ -110,10 +110,10 @@ $ curl --header "X-Vault-Token: <TOKEN>" \
 1. Select **Details**.
    ![Vault UI default dashboard example](/img/ui-client-count.png)
 
-1. Examine the **Vault Usage Metrics** dashboard to learn your Vault usage.
-   ![Example Vault Usage Metrics dashboard view](/img/ui-usage-metrics-1.png)
+1. Examine the **Vault Client Usage** dashboard to learn your Vault usage.
+   ![Example Vault Client Usage dashboard view](/img/ui-client-usage-1.png)
 
-#### Usage metrics data categories
+#### Client usage data categories
 
 - **Running client total** are the primary metric on which pricing is based.
   It is the sum of entity clients (or distinct entities) and non-entity clients.
@@ -147,45 +147,35 @@ $ curl --header "X-Vault-Token: <TOKEN>" \
   [documentation](/vault/docs/concepts/client-count#entity-assignment-with-acme)
   for more details.
 
-    ![ACME clients example](/img/ui-usage-metrics-acme.png)
-
+  ![view with ACME clients tab view selected](/img/ui-client-usage-acme.png)
 
 ## Select a data range
 
-Under the **Client counting period**, select **Edit** to query the data for
+For Vault Enterprise, under the **Change billing period**, select **Billing start date** to query the data for
 a different billing period.
 
-![Query](/img/ui-usage-metrics-period.png)
+![Example of Enterprise date picker dropdown options](/img/ui-client-usage-period-enterprise.png)
+
+For Vault Community, under the **Client counting period**, select **Edit** to query the data for
+a different billing period.
+![Example of Community date picker modal](/img/ui-client-usage-period-ce.png)
 
 Keep in mind that Vault begins collecting data when the feature is enabled. For
 example, if you enabled the usage metrics in March of 2023, you cannot query
 data in January of 2023.
 
-Vault will return metrics from March of 2023 through most recent full month. 
+Vault will return metrics from March of 2023 through most recent full month.
 
 ## Filter by namespaces
 
-If you have [namespaces](/vault/docs/enterprise/namespaces), the dashboard
-displays the top ten namespaces by total clients.
-
-![Namespace attribution example](/img/ui-usage-metrics-namespace.png)
-
 Use the **Filters** to view the metrics data of a specific namespace.
 
-![Filter by namespace](/img/ui-usage-metrics-filter.png)
+![Filter by namespace input field emphasized](/img/ui-client-usage-filter.png)
 
-## Mount attribution
-
-The clients are also shown as graphs per auth mount. The **Mount attribution**
-section displays the top auth mounts where you can expect to find your most used
-auth method mounts with respect to client usage. This allows you to detect which
-auth mount had the most number of total clients in the given billing period. You
-can filter for auth mounts within a namespace, or view auth mounts across
-namespaces. The mount attribution is available even if you are not using
-namespaces. 
-
-![Usage metrics by mount attribution](/img/ui-usage-metrics-mounts.png)
+## Filter by month
 
+Use the **Client attribution table** to view the metrics data of a specific month.
+![Month filter and table view for client attribution](/img/ui-client-usage-table.png)
 
 ## Query usage metrics via CLI
 
@@ -254,7 +244,7 @@ time.
 ```shell-session
 $ vault operator usage \
      -start-time=2024-06-01T00:00:00Z \
-     -end-time=2024-06-30T23:59:59Z 
+     -end-time=2024-06-30T23:59:59Z
 ```
 
 **Example output:**
@@ -283,19 +273,17 @@ Total                                                 90               92
 
 </CodeBlockConfig>
 
-
 ## Export the metrics data
 
 You can export the metrics data by clicking on the **Export attribution data**
 button.
 
-![Metrics UI](/img/ui-usage-metrics-export.png)
+![Export button popup modal emphasized](/img/ui-client-usage-export.png)
 
 This downloads the usage metrics data on your local drive in comma separated
 values format (`.csv`) or JSON.
 
-
-## API 
+## API
 
 - Refer to the
   [`sys/internal/counters`](/vault/api-docs/system/internal-counters#client-count)

website/content/docs/concepts/client-count/counting.mdx

@@ -171,12 +171,12 @@ over the default 48-month retention period.
 <Tab heading="Related tutorials">
 <ul>
   <li>
-    <a href="/vault/tutorials/monitoring/usage-metrics">
-      Vault Usage Metrics in Vault UI
+    <a href="/vault/docs/concepts/client-count/client-usage">
+      Client Usage in Vault GUI
     </a>
   </li>
   <li>
-    <a href="/vault/tutorials/monitoring/usage-metrics">KMIP Client metrics</a>
+    <a href="/vault/docs/concepts/client-count/client-usage">KMIP Client metrics</a>
   </li>
 </ul>
 </Tab>

website/content/docs/internals/recommended-patterns.mdx

@@ -246,7 +246,7 @@ A baseline provides insight into current utilization and thresholds. Telemetry m
 Telemetry information can also be streamed directly from Vault to a range of metrics aggregation solutions and 
 saved for aggregation and inspection. 
 
-- [Vault usage metrics](/vault/tutorials/monitoring/usage-metrics)
+- [Vault client usage](/vault/docs/concepts/client-count/client-usage)
 - [Diagnose server issues](/vault/tutorials/monitoring/diagnose-startup-issues)
 
 **Anti-pattern issue:**

website/content/docs/internals/telemetry/key-metrics.mdx

@@ -291,4 +291,4 @@ Refer to the [Monitoring Vault replication](/vault/tutorials/monitoring/monitor-
 
 - [Monitor telemetry with Prometheus & Grafana](/vault/tutorials/monitoring/monitor-telemetry-grafana-prometheus)
 - [Monitor telemetry & Audit Device Log Data](/vault/tutorials/monitoring/monitor-telemetry-audit-splunk)
-- [Vault usage metrics](/vault/tutorials/monitoring/usage-metrics)
+- [Vault client usage](/vault/docs/concepts/client-count/client-usage)

website/content/partials/faq/client-count/computing-clients.mdx

@@ -1,14 +1,3 @@
-### Can I compute clients for Vault versions before v1.6? ((#before-1-6))
-
-@include 'alerts/auditor-deprecated.mdx'
-
-**Yes**.
-
-Use the [Vault auditor tool](/vault/tutorials/monitoring/usage-metrics#vault-auditor-tool)
-to compute and display client count data for Vault v1.3 – v1.5 using the
-client compute logic available in Vault 1.7. Auditor use with Vault versions
-older than 1.3 is untested.
-
 ### Can I compute KMIP clients for Vault? ((#kmip))
 
 **No**.
@@ -55,13 +44,13 @@ details.
 The [Nomad Vault integration](/nomad/docs/integrations/vault-integration)
 uses either Workload Identity (JWT) or token roles for client count:
 
-	- Vault bases Workload Identity client counts on the
-	  [`user_claim`](/vault/api-docs/auth/jwt#user_claim) field. The
-	  recommended default is `nomad_job`, which results in 1 client per
-	  Nomad job.
-	- Nomad deprecated token roles and will remove the feature in v1.10. Client
-	  counts for legacy token roles treat each unique policy combination as 1
-		non-entity client.
+    - Vault bases Workload Identity client counts on the
+      [`user_claim`](/vault/api-docs/auth/jwt#user_claim) field. The
+      recommended default is `nomad_job`, which results in 1 client per
+      Nomad job.
+    - Nomad deprecated token roles and will remove the feature in v1.10. Client
+      counts for legacy token roles treat each unique policy combination as 1
+    	non-entity client.
 
 ### Are batch tokens counted differently than service tokens? ((#batch-tokens))
 
@@ -92,5 +81,5 @@ If you are using Vault 1.10+:
 - Migrating mounts **across** namespace will create duplication in the client count.
 - Migrating mounts **within** a namespace will not affect client count.
 
-If you are using an older version of Vault, migrating mounts will always create 
+If you are using an older version of Vault, migrating mounts will always create
 duplication in the client count.

website/content/partials/faq/client-count/tools.mdx

@@ -2,7 +2,7 @@
 
 @include 'alerts/auditor-deprecated.mdx'
 
-The [Vault auditor tool](/vault/tutorials/monitoring/usage-metrics#vault-auditor-tool)
+The Vault auditor tool
 lets customers running Vault v1.3 – v1.5 compute and display client
 count data using the client compute logic available in Vault 1.7. Auditor use
 with Vault versions older than 1.3 is untested.

website/data/docs-nav-data.json

@@ -203,8 +203,8 @@
             "path": "concepts/client-count/counting"
           },
           {
-            "title": "Usage metrics",
-            "path": "concepts/client-count/usage-metrics"
+            "title": "Client usage",
+            "path": "concepts/client-count/client-usage"
           },
           {
             "title": "FAQ",

website/redirects.js

@@ -309,5 +309,10 @@ module.exports = [
     source: '/vault/docs/enterprise/license/faq',
     destination: '/vault/docs/license',
     permanent: true,
-  }
+  },
+  {
+    source: '/vault/docs/concepts/client-count/usage-metrics',
+    destination: '/vault/docs/concepts/client-count/client-usage',
+    permanent: true,
+  },
 ]