История

Luke Bordonaro 78158c2120 Add documentation for column variants (#380 ) * Checkpoint * Checkpoint * Checkpoint * Typo * Fix awkward sentence * Rename Time (UTC) * Whitespace * Grammar * Wording * CHeckpoint * Add engine docs * Edits * Add global varaints example code * Fix glossary TOC * Fix glossary TOC again * Wording * Add ASCII diagrams * Address comments * Typos * Remove runtime section		2024-10-30 16:40:16 -07:00
..
Architecture	fix url of markdown (#362 )	2024-10-16 15:31:55 -07:00
Known-SDK-Driver-Compatibility	Update docs for choosing SDK version guidance (#358 )	2024-05-01 14:03:56 -07:00
Migration	Update docs for 1.0 (#191 )	2022-02-04 16:12:16 -08:00
Plugins-System-Preview-Only	Add template plugin manifest (#323 )	2023-09-14 11:31:25 -07:00
Using-the-SDK	Add documentation for column variants (#380 )	2024-10-30 16:40:16 -07:00
Videos	Take develop to main (#68 )	2021-04-06 14:35:23 -07:00
Glossary.md	Add documentation for column variants (#380 )	2024-10-30 16:40:16 -07:00
README.md	Update docs for 1.0 (#191 )	2022-02-04 16:12:16 -08:00
Troubleshooting.md	Revamp documentation (#188 )	2022-02-01 16:06:56 -08:00

README.md

Overview

The Microsoft Performance Toolkit SDK allows developers to create "SDK plugins" that process and interpret data. These plugins can be used by performance analysis applications that use the SDK runtime - such as Windows Performance Analyzer - to process data sources into structured, tabular data. Plugins may use the SDK's data-processing pipeline to both facilitate the creation of these tables and expose data that can be programmatically accessed by concurrently loaded plugins (even those without access to the originating plugin's source code).

This folder contains instructions for developing SDK plugins and utilizing the SDK's various features.

Quick Start

Refer to Creating your first plugin to jump in quickly.

⚠️ Note: We recommend following the Recommended Reading Order.

Glossary

For quick definitions/examples of terms and concepts, refer to the Glossary.

Requirements

The following are required in order to develop an SDK plugin:

NuGet
.NET Standard 2.0 or a compatible version
A text editor (for editing your source code)

It is recommended to use Visual Studio to develop an SDK plugin since it satisfies all three requirements. Future documentation assumes the use of Visual Studio, but the instructions may be adapted for other editors/IDEs.

Getting the SDK

The SDK is published as a NuGet package under the name Microsoft.Performance.SDK. Since it is hosted on NuGet.org, it can be added to a csproj with no additional configuration by using the Visual Studio NuGet Package Manager, dotnet.exe, or nuget.exe.