From 460815581dd473753db12bde0b3e1ba0a713fa30 Mon Sep 17 00:00:00 2001 From: hc-github-team-secure-vault-core <82990506+hc-github-team-secure-vault-core@users.noreply.github.com> Date: Tue, 13 Jun 2023 12:30:39 -0400 Subject: [PATCH] backport of commit 51c7e3e31ae8c927e35a52ab636a0817cf5f8fc8 (#21176) Co-authored-by: Yoko Hyakuna --- .../license/utilization-reporting.mdx | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/website/content/docs/enterprise/license/utilization-reporting.mdx b/website/content/docs/enterprise/license/utilization-reporting.mdx index 845226d39..4cb798b4a 100644 --- a/website/content/docs/enterprise/license/utilization-reporting.mdx +++ b/website/content/docs/enterprise/license/utilization-reporting.mdx @@ -197,6 +197,35 @@ variable setting will take precedence. HashiCorp collects the following utilization data as JSON payloads: +- `payload_version` - The version of this payload schema +- `license_id` - The license ID for this product +- `product` - The product that this contribution is for +- `product_version` - The product version this contribution is for +- `export_timestamp`- The date and time for this contribution +- `snapshots` - An array of snapshot details. A snapshot is a structure that + represents a single data collection + - `snapshot_version` - The version of the snapshot package that produced this + snapshot + - `snapshot_id` - A unique identifier for this particular snapshot + - `process_id` - An identifier for the system that produced this snapshot + - `timestamp` - The date and time for this snapshot + - `schema_version` - The version of the schema associated with this snapshot + - `service` - The service that produced this snapshot (likely to be product + name) + - `metrics` - A map of representations of snapshot metrics contained within + this snapshot + - `key` - The key name associated with this metric + - `kind` - The kind of metric (feature, counter, sum, or mean) + - `mode` - The mode of operation associated with this metric (write or + collect) + - `labels` - The labels associated with each collected metric + - `entity` - The sum of tokens generated for a unique client identifier + - `nonentity` - The sum of tokens without an entity attached +- `metadata` - Optional product-specific metadata + - `billing_start` - The billing start date associated with the reporting cluster (license start date if not configured) + - `cluster_id` - The cluster UUID as shown by `vault status` on the reporting + cluster + ```json