Telemetry

Qlty collects usage analytics which we use to help improve the CLI. For example, this usage data helps us find and fix issues, like performance issues and bugs, as well as to prioritize new features. This page explains what data we collect and why we collect it.

Telemetry data never includes your source code or identifiers (e.g. filenames) from your repository.

Types of telemetry data

Qlty CLI collects two types of telemetry data:

1. Crash reports: When the CLI crashes, it sends a report to Qlty. This information is used to understand why the CLI crashed and the changes that we need to make to prevent future crashes.

2. Usage analytics: The CLI sends usage analytics to Qlty. This information is used for product improvements.

Example analytics event

Here is an example of an analytics event that the CLI sends to Qlty:

1
{
2
    "type": "track",
3
    "event": "Command Run",
4
    "properties": {
5
        "Subcommand": "smells",
6
        "Command": "qlty smells --debug VALUE",
7
        "Duration MS": 833,
8
        "Repository": "a8f97a11fe29de4f636340ae2485e0a5",
9
        "Success": "true",
10
        "Exit Code": 0,
11
        "Failed": "false"
12
    },
13
    "timestamp": "2024-11-17T01:38:43.120696Z",
14
    "context": {
15
    "locale": "en-US",
16
    "os": {
17
        "name": "macos"
18
    },
19
    "device": {
20
        "type": "aarch64"
21
    },
22
    "app": {
23
        "name": "qlty",
24
        "version": "0.422.0",
25
        "build": "(1f77afa)"
26
    }
27
    },
28
    "anonymousId": "de38bf69f6249b6228d81223f9885504",
29
    "messageId": "fea07bfb-3cce-4cf0-bec1-eecf6e5c1896"
30
}

Can I disable telemetry?

Yes. Telemetry can be disabled by setting the QLTY_TELEMETRY environment variable. The value of the environment variable can be set to errors or off. The default value is all.