License report reference | Terraform

This topic provides reference information about the license usage data HashiCorp collects as defined in our contracts.

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
    - workspacecount - Total number of workspaces defined in the Terraform Enterprise instance
    - kind - The kind of metric (feature, counter, sum, or mean)
    - mode - The mode of operation associated with this metric (write or collect)
    - value - The value of the metric at the time the licensing exporter took this snapshot
metadata - Optional product-specific metadata
- replicated_license_id - The unique ID of the Replicated license
- sf_opportunity_id - The Salesforce Opportunity ID associated with the license

Example payload

{  "payload_version": "1",  "license_id": "934b62bd-7e7b-7872-7341-9683ecd9acb4",  "product": "terraform",  "product_version": "v202305-01",  "export_timestamp": "2023-05-24T10:11:12Z",  "snapshots": [    {      "snapshot_version": 1,      "snapshot_id": "01GW2Y117Z2BZ7MGS9YQXPF2A4",      "process_id": "01GVKT7533WF8TBNSJYZV0T10F",      "timestamp": "2023-05-23T20:33:32.927Z",      "schema_version": "1.0.0",      "service": "terraform",      "metrics": {        "terraform.workspacecount": {          "key": "terraform.workspacecount",          "kind": "counter",          "mode": "write",          "value": 20        }      }    }  ],  "metadata": {    "terraform": {      "replicated_license_id": "vi15fg2ysml54yhhd8evcfjl63h6pt6k",      "sf_opportunity_id": "ix0z0kj5f7egd64bo1"    }  }}