Skip to content

Commit 5b07ad4

Browse files
authored
[DO NOT MERGE] feat(telemetry): feature docs (#6827)
# Description ### **NOTE:** This feature will not be enabled until 1.12 New telemetry feature reference ### Other PR's for this feature: * [Feature Reference Docs](#6827) (this PR) * [CLI Reference Docs](#6826) * [Feature implementation](#6743)
1 parent f5237ae commit 5b07ad4

File tree

2 files changed

+68
-1
lines changed

2 files changed

+68
-1
lines changed

docs/pages/repo/docs/_meta.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515
"newWindow": true
1616
},
1717
"upgrading-to-v1": "Upgrading to v1",
18-
"acknowledgements": "Acknowledgements",
18+
"telemetry": "Telemetry",
1919
"support": "Support Policy",
20+
"acknowledgements": "Acknowledgements",
2021
"faq": "FAQ",
2122
"glossary": {
2223
"title": "Glossary",

docs/pages/repo/docs/telemetry.mdx

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Turborepo Telemetry
3+
description: Anonomous telemetry for Turborepo
4+
---
5+
6+
# Telemetry
7+
8+
Vercel Inc. (Vercel) may collect telemetry data about your use of Turborepo as explained below.
9+
Telemetry data allows us to monitor and improve Turborepo and the Vercel platform by
10+
collecting anonymous data about its usage and host information. The data may be used to broadly identify,
11+
troubleshoot, or respond to issues that impact users.
12+
13+
Collection of telemetry data is optional. If you do not want telemetry data collected, you may [opt-out](#how-do-i-opt-out).
14+
15+
## Why
16+
17+
Telemetry allows us to accurately gauge Turborepo feature usage, pain points, and customization across all users.
18+
This data enables us to better tailor Turborepo to the masses, ensuring its continued growth, relevance, and best-in-class developer experience.
19+
Furthermore, this data allows us to verify if improvements are improving the baseline of all applications.
20+
21+
## What is collected
22+
23+
We track general usage information, specifically, we track the following with anonymized telemetry data using random identifiers:
24+
25+
- Command invoked ([turbo run](/repo/docs/reference/command-line-reference/run), [turbo prune](/repo/docs/reference/command-line-reference/prune), [turbo gen](/repo/docs/reference/command-line-reference/gen), etc.)
26+
- Version of `turbo`
27+
- General machine information (e.g. number of CPUs, macOS/Windows/Linux, whether or not the command was run within CI)
28+
- Size of application (total number of workspaces)
29+
- We **DO NOT** collect any metrics which may contain sensitive data. This includes, but is not limited to: task names, package names, sensitive argument or flag values, environment variables, file paths, or contents of files.
30+
31+
**Note**: This list is regularly audited to ensure its accuracy.
32+
33+
You can view exactly what is being collected by setting the following environment variable: `TURBO_TELEMETRY_DEBUG=1`.
34+
35+
Additionally, all possible events can be viewed by browsing the [events](https://github.com/vercel/turbo/blob/main/crates/turborepo-telemetry/src/events.rs) file directly.
36+
37+
## How do I opt out?
38+
39+
### Disable
40+
41+
You may opt out-by running:
42+
43+
```sh
44+
turbo telemetry disable
45+
```
46+
47+
You can also opt out by setting any of the following environment variables:
48+
49+
- `TURBO_TELEMETRY_DISABLED=1`
50+
- `DO_NOT_TRACK=1` (Learn more about [Console Do Not Track (DNT)](https://consoledonottrack.com/))
51+
52+
### Status
53+
54+
You may check the status of telemetry collection at any time by running:
55+
56+
```sh
57+
turbo telemetry status
58+
```
59+
60+
### Enable
61+
62+
You may re-enable telemetry if you'd like to re-join the program by running the following:
63+
64+
```sh
65+
turbo telemetry enable
66+
```

0 commit comments

Comments
 (0)