Telemetry

Specmatic offers users insights into the usage of its features. But it goes beyond usage. Specmatic 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.

{
  "usages": [
    {
      "labels": [
        "label_1",
        "label_2"
      ],
      "consumption": [
        {
          "product": "Specmatic Enterprise",
          "feature": "test",
          "used": 10,
          "protocol": "mqtt+Amazon SQS"
        }
      ]
    }
  ],
  "usageMetadata": {
    "productName": "Specmatic Enterprise",
    "productVersion": "1.0.3",
    "runId": "AD4BF181-6E88-4380-A344-9E0A85EF916D",
    "osName": "Linux",
    "osVersion": "6.12.54-linuxkit",
    "osArch": "aarch64",
    "javaVersion": "17.0.17+10-alpine-r0",
    "javaVendor": "Alpine",
    "executor": "docker"
  }
}

Opt-Out of Usage Analytics

Trial and other free-tier users may choose to opt-out of Telemetry with the following configuration in specmatic.yml file.

Version 3 (recommended)

YAML

specmatic.yaml

version: 3
specmatic:
  settings:
    general:
      disableTelemetry: true

specmatic.json

specmatic.json

{
  "version": 3,
  "specmatic": {
    "settings": {
      "general": {
        "disableTelemetry": true
      }
    }
  }
}

Version 2

YAML

specmatic.yaml

version: 2
disableTelemetry: true

JSON

specmatic.json

{
  "version": 2,
  "disableTelemetry": true
}

This will turn off Telemetry and notify Specmatic Insights that the user has opted-out.