Merge pull request #89 from specmatic/telemetry

chore: fixup and document telemetry configuration

Author: joelrosario

docs/references/configuration/includes/telemetry/v2/specmatic.json

@@ -0,0 +1,4 @@
+{
+  "version": 2,
+  "disableTelemetry": true
+}

docs/references/configuration/includes/telemetry/v3/specmatic.json

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "specmatic": {
+    "settings": {
+      "general": {
+        "disableTelemetry": true
+      }
+    }
+  }
+}

docs/references/configuration/telemetry.mdx

@@ -2,14 +2,18 @@
 title: Telemetry
 sidebar_position: 12
 ---
+import {V2V3SpecmaticConfigTabs} from "../../../src/components/V2V3SpecmaticConfigTabs";
+
 # Telemetry
 
 Specmatic offers users insights into the [usage](https://insights.specmatic.io/dashboard/settings/usage) of its features. But it goes beyond usage.
 [Specmatic Insights](/enterprise_onboarding/insights) provides reports on coverage, service dependency graphs, adoption by providers and consumers etc.
 
 ## Typical Payload
+
 Usage analytics are posted roughly every minute (and once at exit) with the following payload shape.
 
+
 ```json
 {
   "usages": [
@@ -20,7 +24,7 @@ Usage analytics are posted roughly every minute (and once at exit) with the foll
       ],
       "consumption": [
         {
-          "product": "Specmatic AsyncAPI",
+          "product": "Specmatic Enterprise",
           "feature": "test",
           "used": 10,
           "protocol": "mqtt+Amazon SQS"
@@ -30,7 +34,7 @@ Usage analytics are posted roughly every minute (and once at exit) with the foll
   ],
   "usageMetadata": {
     "productName": "Specmatic Enterprise",
-    "productVersion": "2.1.3-SNAPSHOT",
+    "productVersion": "1.0.3",
     "runId": "AD4BF181-6E88-4380-A344-9E0A85EF916D",
     "osName": "Linux",
     "osVersion": "6.12.54-linuxkit",
@@ -43,9 +47,11 @@ Usage analytics are posted roughly every minute (and once at exit) with the foll
 ```
 
 ## Opt-Out of Usage Analytics
-Trial and other free-tier users may choose to opt-out of Telemetry with the following top-level configuration in specmatic.yml file.
 
-```yaml
-disable_telemetry = true
-```
+Trial and other free-tier users may choose to opt-out of Telemetry with the following configuration in specmatic.yml file.
+
+<V2V3SpecmaticConfigTabs
+  v2Object={require('./includes/telemetry/v2/specmatic.json')}
+  v3Object={require('./includes/telemetry/v3/specmatic.json')}/>
+
 This will turn off Telemetry and notify Specmatic Insights that the user has opted-out.