Skip to main content

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 AsyncAPI",
          "feature": "test",
          "used": 10,
          "protocol": "mqtt+Amazon SQS"
        }
      ]
    }
  ],
  "usageMetadata": {
    "productName": "Specmatic Enterprise",
    "productVersion": "2.1.3-SNAPSHOT",
    "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 top-level configuration in specmatic.yml file.

disable_telemetry = true

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