Terraform Enterprise usage data reference

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.

{
  "payload":{
    "payload_version":"1",
    "license_id":"${LICENSE_IDENTIFIER}",
    "product":"terraform",
    "product_version":"${TFE_VERSION}",
    "export_timestamp":"${TIME_OF_EXPORT}",
    "snapshots":[
      {
        "snapshot_version":1,
        "snapshot_id":"${SNAPSHOT_ID}",
        "process_id":"${PROCESS_ID}",
        "timestamp":"${TIME_OF_EXPORT}",
        "schema_version":"1.1.0",
        "service":"terraform",
        "metrics":{
          "billable_rum_count":{
            "key":"billable_rum_count",
            "kind":"counter",
            "mode":"write",
            "value":1
          },
          "billable_rum_count_workspace_80th_percentile":{
            "key":"billable_rum_count_workspace_80th_percentile",
            "kind":"counter",
            "mode":"write",
            "value":1
          },
          "billable_rum_count_workspace_avg":{
            "key":"billable_rum_count_workspace_avg",
            "kind":"counter",
            "mode":"write",
            "value":1
          },
          "billable_rum_count_workspace_max":{
            "key":"billable_rum_count_workspace_max",
            "kind":"counter",
            "mode":"write",
            "value":1
          },
          "billable_rum_count_workspace_median":{
            "key":"billable_rum_count_workspace_median",
            "kind":"counter",
            "mode":"write",
            "value":1
          },
          "billable_rum_count_workspace_min":{
            "key":"billable_rum_count_workspace_min",
            "kind":"counter",
            "mode":"write",
            "value":1
          },
          "billable_rum_opt_in":{
            "key":"billable_rum_opt_in",
            "kind":"counter",
            "mode":"write",
            "value":1
          },
          "workspacecount":{
            "key":"workspacecount",
            "kind":"counter",
            "mode":"write",
            "value":0
          }
        }
      }
    ],
    "metadata":{

    }
  }
}