ToolTelemetry

The Tool Telemetry library is a centralized and flexible C# solution built to support tracking of telemetry events, exceptions, metrics, and logs from tools. It includes extensions to Application Insights, providing implementations of telemetry initializers and processors to enable seamless integration in any .NET tool. If you have any questions, feature suggestions, or simply need additional assistance with anything outlined in this document, you can contact sqtechsupport@microsoft.com.

Installing the NuGet package

To begin tracking telemetry, users must first download and install a NuGet package located in the SQTech feed.

Add the SQTech Repository

First time users will need to add the SQTech NuGet repository to their NuGet Package Manager. In Visual Studio:

1. Right click on your project
2. Select Manage NuGet Packages
3. Click on the gear icon located next to the Package source drop down menu
4. Add the following package source: https://sqgns.pkgs.visualstudio.com/_packaging/SQTech/nuget/v3/index.json

Install Telemetry Package

Once the SQTech NuGet repository is added to the list of package sources:

1. Select it from the Package source drop down menu in the NuGet Package Manager
2. Search for “Microsoft.XboxStudios.SQTech.Telemetry”
3. Decide which version you want to install
   • For v2, only Microsoft.XboxStudios.SQTech.Telemetry is needed
   • For v3, Microsoft.XboxStudios.SQTech.Telemetry is available for backwards compatibility with v2, and new functionality was added to the “Extensions”, “Initializers”, and “Metrics” packages. Only the “Extensions” package is needed for now, and in the future it will become part of the main package.

Reference Documentation

If you’re trying to upgrade to ToolTelemetry version 3+, proceed to the Upgrade Guide for more information. If you’re not ready to upgrade, documentation for the previous versions can be found in the Git repo here.