Merge pull request #14006 from Mikejo5000/mikejo-br26

Add usage details for BenchmarkDotNet, add links

Author: v-regandowner

docs/profiling/choose-performance-tool.md

@@ -33,11 +33,12 @@ The following table lists the different tools Visual Studio offers and provides
 |[Memory Usage](../profiling/memory-usage.md)|Shows your app’s memory to find issues such as memory leaks.|&#x2022; Optimize memory usage</br>&#x2022; Investigate UI freeze</br>&#x2022; Investigate suspected memory leak (native code)|
 |[.NET Object Allocation](../profiling/dotnet-alloc-tool.md)|Shows where .NET Objects are allocated and information about garbage collection.|&#x2022; Optimize .NET memory usage</br>&#x2022; Analyze garbage collection|
 |[Instrumentation](../profiling/instrumentation-overview.md)|Shows exact call counts and call times.|&#x2022; You need a tool like CPU Usage, but you want exact call counts and time spent in functions based on wall clock time.</br>&#x2022; You want to see blocked time, such as time spent waiting for locks.</br>&#x2022; Note: This tool requires extra overhead.|
+|[.NET Counters](../profiling/dotnet-counters-tool.md)|Live report for .NET counters.|&#x2022; Begin an investigation for general performance issues.</br>&#x2022; You want a trace for .NET counter-based metrics such as exceptions per second, garbage collection, and CPU utilization.|
+|[BenchmarkDotNet](../profiling/profiling-with-benchmark-dotnet.md)|Report for benchmarks based on BenchmarkDotNet.|&#x2022; Get different visualizations of BenchmarkDotNet collected data, such as CPU usage or memory allocations, based on the diagnoser in use.|
 |[File I/O](../profiling/use-file-io.md)|Shows your File I/O operations and how long they take and how much data they process.|Investigate UI freeze|
 |[PerfTips](../profiling/perftips.md)|Shows a quick measurement of performance information while interacting with your code.|While debugging, you want to see the elapsed time between the previous step operation (or breakpoint) to the current step or breakpoint.|
 |[Events viewer](../profiling/events-viewer.md)|Shows HTTP requests, log messages, and exceptions.|&#x2022; Investigate latency in API calls</br>&#x2022; Investigate slow application running on a remote web server|
 |[.NET Async](../profiling/analyze-async.md)|Shows async/await usage in .NET apps.|Investigate suspected performance issue with asynchronous code.|
-|[.NET Counters](../profiling/dotnet-counters-tool.md)|Live report for .NET counters.|&#x2022; Begin an investigation for general performance issues.</br>&#x2022; You want a trace for .NET counter-based metrics such as exceptions per second, garbage collection, and CPU utilization.|
 |[Database](../profiling/analyze-database.md)|Shows performance of your database queries.|Investigate performance for database queries that use either ADO.NET or Entity Framework Core.|
 |[GPU Usage](./gpu-usage.md)|Shows high-level hardware usage of your Direct3D app.|Check whether the performance of your app is CPU-bound or GPU-bound.|
 |[Application Timeline](../profiling/application-timeline.md)|Shows UI performance for XAML apps.|Investigate UI performance in XAML apps, such as time spent rendering frames.|
@@ -53,11 +54,12 @@ The following table lists the different tools Visual Studio offers and the diffe
 |[Memory Usage](../profiling/memory-usage.md)|yes|yes|yes|yes|
 |[.NET Object Allocation](../profiling/dotnet-alloc-tool.md)|yes|no|yes|yes|
 |[Instrumentation](../profiling/instrumentation-overview.md)|yes|yes|yes|yes|
+|[.NET Counters](../profiling/dotnet-counters-tool.md)|yes (.NET Core/5+ only)|no|no|yes (ASP.NET Core only)|
+|[BenchmarkDotNet](../profiling/profiling-with-benchmark-dotnet.md)|yes|no|no|partial|
 |[File I/O](../profiling/use-file-io.md)|yes|yes|yes|yes|
 |[PerfTips](../profiling/perftips.md)|yes|yes|yes|yes|
 |[Events viewer](../profiling/events-viewer.md)|yes|yes|yes|yes|
 |[.NET Async](../profiling/analyze-async.md)|yes|no|yes|yes|
-|[.NET Counters](../profiling/dotnet-counters-tool.md)|yes (.NET Core/5+ only)|no|no|yes (ASP.NET Core only)|
 |[Database](../profiling/analyze-database.md)|yes (.NET Core/5+ only)|no|no|yes (ASP.NET Core only)|
 |[GPU Usage](./gpu-usage.md)|yes|yes|yes|no|
 |[Application Timeline](../profiling/application-timeline.md)|yes (XAML)|no|yes|no|
@@ -74,6 +76,7 @@ The following tools are supported with Linux or WSL as the target platform as we
 - .NET Object Allocation Tracking
 - .NET Async
 - .NET Counters
+- BenchmarkDotNet
 - Events Viewer
 - Database
 

docs/profiling/index.yml

@@ -67,12 +67,12 @@ landingContent:
             url: instrumentation-overview.md
           - text: .NET Counters
             url: dotnet-counters-tool.md  
+          - text: Benchmark.NET
+            url: profiling-with-benchmark-dotnet.md
           - text: File I/O
             url: use-file-io.md
           - text: Database
             url: analyze-database.md
-          - text: Benchmark.NET
-            url: profiling-with-benchmark-dotnet.md
           - text: Events Viewer
             url: events-viewer.md
           - text: .NET Async

docs/profiling/profiling-feature-tour.md

@@ -274,6 +274,14 @@ The tool shows live values for each counter in a list view.
 :::image type="content" source="../profiling/media/dotnet-counters-tool-collecting.png" alt-text=".NET Counter tool collecting.":::
 
 This tool is supported for For .NET Core and .NET 5+ apps.
+
+## Visualize BenchmarkDotNet data
+
+Starting in Visual Studio 2022 version 17.9, you can view data collected using BenchmarkDotNet in the Visual Studio profiling tools. By adding benchmark attributes to your code, you can use specific diagnosers to analyze memory allocations, CPU usage, counters, and other performance data.
+
+For more information, see [Analyze BenchmarkDotNet data in Visual Studio](../profiling/profiling-with-benchmark-dotnet.md).
+
+:::image type="content" source="../profiling/media/vs-2022/benchmark-dotnet-diagsession.png" alt-text="BenchmarkDotNet data in the profiler.":::
 ::: zone-end
 
 ## Examine application events

docs/profiling/profiling-with-benchmark-dotnet.md

@@ -107,15 +107,28 @@ Each diagnoser generates performance data related to that diagnoser. For example
    Exported diagsession file: *.diagsession
    ```
 
-## View Benchmark .NET data
+## View BenchmarkDotNet data
 
 1. In Visual Studio, select **File > Open > File** and navigate to the location of the *.diagsession* file, and then select and open the file.
 
-1. Select the **Benchmark** tab to view BenchmarkDotNet data.
+1. Select the **Benchmarks** tab to view data for the BenchmarkDotNet benchmarks.
 
    ![Screenshot of BenchmarkDotNet data in Visual Studio.](../profiling/media/vs-2022/benchmark-dotnet-diagsession.png)
 
-For more information about the results, see [BenchmarkDotNet](https://benchmarkdotnet.org/articles/overview.html) documentation.
+   For more information about the results in the **Benchmarks** tab, see [BenchmarkDotNet](https://benchmarkdotnet.org/articles/overview.html) documentation.
+
+1. Right-click a row in the results and choose **Select time range** to sync the timeline graph with the benchmark.
+
+1. Select one of the available tabs such as **CPU Usage** or **Allocations**.
+
+   Depending on the diagnoser you used to collect data, you can gain insights related to memory allocation, CPU usage, counters, and other performance data. To analyze memory allocations, use the built-in [MemoryDiagnoser](https://benchmarkdotnet.org/articles/overview.html#diagnostics) by adding the \[MemoryDiagnoser\] attribute. For more information, see [Diagnosers](https://benchmarkdotnet.org/articles/configs/diagnosers.html).
+
+   > [!NOTE]
+   > The profiler supports only the \[MemoryDiagnoser\] and the diagnosers listed previously in this article.
+
+   For an example of using the profiler to analyze memory allocations, see the blog post [Benchmarking with Visual Studio Profiler](https://devblogs.microsoft.com/visualstudio/benchmarking-with-visual-studio-profiler/).
+
+   To analyze data related to other tabs such as **CPU Usage**, see the corresponding articles in the profiling documentation.
 
 ## Related content
 

docs/profiling/toc.yml

@@ -102,6 +102,8 @@
       href: instrumentation.md
   - name: .NET Counters
     href: dotnet-counters-tool.md
+  - name: BenchmarkDotNet
+    href: profiling-with-benchmark-dotnet.md
   - name: File IO
     href: use-file-io.md
   - name: PerfTips
@@ -116,8 +118,6 @@
     href: application-timeline.md
   - name: Add user marks to timeline
     href: add-timeline-graph-user-marks.md
-  - name: BenchmarkDotNet
-    href: profiling-with-benchmark-dotnet.md
   - name: Analyze GPU usage
     href: gpu-usage.md
   - name: Measure performance from the command-line