Terraform Enterprise usage data reference

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[!IMPORTANT]
Documentation Update: Product documentation previously located in /website has moved to the hashicorp/web-unified-docs repository, where all product documentation is now centralized. Please make contributions directly to web-unified-docs, since changes to /website in this repository will not appear on developer.hashicorp.com. ⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

This topic provides reference information about the product usage information Terraform Enterprise collects so that HashiCorp can improve service. Refer to Enable automated product usage reports. For information about how to configure Terraform Enterprise to automatically send product usage reports.

Product data collection reference

The following JSON payload describes the product usage data that Terraform Enterprise collects.

{
    "version":"2",
    "mode": "automatic",
    "timestamp":"${TIME_OF_EXPORT}",
    "signature": "${UUID}",
    "checksum": "${UUID}",
    "snapshots":[
      {
        "snapshot_version":2,
        "id":"${SNAPSHOT_ID}",
        "timestamp":"${TIME_OF_EXPORT}",
        "schema_version":"2.0.1",
        "product":"terraform",
        "process_id":"${PROCESS_ID}",
        "product_version":"${TFE_VERSION}",
        "license_id":"${LICENSE_IDENTIFIER}",
        "checksum": "${SHA}",
        "metrics":{
          "billable_rum_count":{
              "key": "billable_rum_count",
              "value": 1,
              "mode": "write"
          },
          "billable_rum_count_workspace_80th_percentile":{
              "key": "billable_rum_count_workspace_80th_percentile",
              "value": 1,
              "mode": "write"
          },
          "billable_rum_count_workspace_avg":{
              "key": "billable_rum_count_workspace_avg",
              "value": 1,
              "mode": "write"
          },
          "billable_rum_count_workspace_max":{
              "key": "billable_rum_count_workspace_max",
              "value": 1,
              "mode": "write"
          },
          "billable_rum_count_workspace_median":{
              "key": "billable_rum_count_workspace_median",
              "value": 1,
              "mode": "write"
          },
          "billable_rum_count_workspace_min":{
              "key": "billable_rum_count_workspace_min",
              "value": 1,
              "mode": "write"
          },
          "billable_rum_opt_in":{
              "key": "billable_rum_opt_in",
              "value": 1,
              "mode": "write"
          },
          "ado_vcs_present":{
              "key": "ado_vcs_present",
              "value": 1,
              "mode": "write"
          },
          "aws_provider_present":{
              "key": "aws_provider_present",
              "value": 1,
              "mode": "write"
          },
          "azure_provider_present":{
              "key": "azure_provider_present",
              "value": 1,
              "mode": "write"
          },
          "bitbucket_vcs_present":{
              "key": "bitbucket_vcs_present",
              "value": 1,
              "mode": "write"
          },
          "continuous_validation_used_last_90_days":{
              "key": "continuous_validation_used_last_90_days",
              "value": 1,
              "mode": "write"
          },
          "drift_detection_used_last_90_days":{
              "key": "drift_detection_used_last_90_days",
              "value": 1,
              "mode": "write"
          },
          "gcp_provider_present":{
              "key": "gcp_provider_present",
              "value": 1,
              "mode": "write"
          },
          "github_vcs_present":{
              "key": "github_vcs_present",
              "value": 1,
              "mode": "write"
          },
          "gitlab_vcs_present":{
              "key": "gitlab_vcs_present",
              "value": 1,
              "mode": "write"
          },
          "product_usage_reporting_opt_in":{
              "key": "product_usage_reporting_opt_in",
              "value": 1,
              "mode": "write"
          },
          "run_tasks_used_last_90_days":{
              "key": "run_tasks_used_last_90_days",
              "value": 1,
              "mode": "write"
          },
          "run_triggers_used_last_90_days":{
              "key": "run_triggers_used_last_90_days",
              "value": 1,
              "mode": "write"
          },
          "sentinel_used_last_90_days":{
              "key": "sentinel_used_last_90_days",
              "value": 1,
              "mode": "write"
          },
          "servicenow_catalog_billable_rum_count":{
              "key": "servicenow_catalog_billable_rum_count",
              "value": 1,
              "mode": "write"
          },
          "servicenow_catalog_run_count":{
              "key": "servicenow_catalog_run_count",
              "value": 1,
              "mode": "write"
          },
          "servicenow_catalog_workspace_count":{
              "key": "servicenow_catalog_workspace_count",
              "value": 1,
              "mode": "write"
          },
          "teams_count":{
              "key": "teams_count",
              "value": 1,
              "mode": "write"
          },
          "varsets_count":{
              "key": "varsets_count",
              "value": 1,
              "mode": "write"
          },
          "workspacecount":{
              "key": "workspacecount",
              "value": 1,
              "mode": "write"
          },
          "private_modules_count":{
              "key":"private_modules_count",
              "value": 1,
              "mode":"write"
          },
        }
      }
    ],
    "metadata":{

    }
  }
}