Skip to content

Commit 95169ef

Browse files
thomhurstclaude
andauthored
docs: add telemetry documentation to extensions page (#4429)
- List all built-in extensions (Code Coverage, TRX Reports, Telemetry) - Add tip explaining how to opt out by using separate packages - Add Telemetry section with environment variable opt-out instructions - Link to Microsoft's telemetry documentation Closes #4424 Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 3fc4d2f commit 95169ef

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

docs/docs/extensions/extensions.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,21 @@ As TUnit is built on top of Microsoft.Testing.Platform, it can tap into generic
44

55
## Built-In Extensions
66

7-
The following extensions are **automatically included** when you install the **TUnit** meta package. You don't need to install them separately!
7+
The following extensions are **automatically included** when you install the **TUnit** meta package:
8+
9+
- **Code Coverage** - via `Microsoft.Testing.Extensions.CodeCoverage`
10+
- **TRX Test Reports** - via `Microsoft.Testing.Extensions.TrxReport`
11+
- **Telemetry** - via `Microsoft.Testing.Extensions.Telemetry`
12+
13+
:::tip Opting Out of Built-In Extensions
14+
If you don't want these extensions, you can reference `TUnit.Engine` and `TUnit.Assertions` packages separately instead of the `TUnit` meta package.
15+
16+
```xml
17+
<!-- Instead of the TUnit meta package -->
18+
<PackageReference Include="TUnit.Engine" Version="x.x.x" />
19+
<PackageReference Include="TUnit.Assertions" Version="x.x.x" />
20+
```
21+
:::
822

923
### Code Coverage
1024

@@ -116,6 +130,33 @@ dotnet run --configuration Release --results-directory ./reports --report-trx --
116130

117131
---
118132

133+
### Telemetry
134+
135+
Telemetry is provided via the `Microsoft.Testing.Extensions.Telemetry` NuGet package.
136+
137+
**✅ Included automatically with the TUnit package**
138+
139+
This extension enables Microsoft to collect anonymous usage metrics to help improve the testing platform. No personal data or source code is collected.
140+
141+
#### Opting Out
142+
143+
You can disable telemetry by setting an environment variable:
144+
145+
```bash
146+
# Linux/macOS
147+
export TESTINGPLATFORM_TELEMETRY_OPTOUT=1
148+
149+
# Windows
150+
set TESTINGPLATFORM_TELEMETRY_OPTOUT=1
151+
```
152+
153+
Alternatively, you can use `DOTNET_CLI_TELEMETRY_OPTOUT=1` which also disables .NET SDK telemetry.
154+
155+
**📚 More Resources:**
156+
- [Microsoft.Testing.Platform Telemetry Documentation](https://learn.microsoft.com/en-us/dotnet/core/testing/microsoft-testing-platform-telemetry)
157+
158+
---
159+
119160
## Optional Extensions
120161

121162
These extensions are **not** included with the TUnit package and must be installed manually if needed.

0 commit comments

Comments
 (0)