dotTrace

https://www.jetbrains.com/help/profiler
Admin
dotTrace is a .NET performance profiling tool that helps find bottlenecks in various .NET...
Tokens:33,938
Snippets:624
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Profile Windows Applications via Command Line

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Examples for starting, attaching, and listing options for dotTrace on Windows.

```bash
dotTrace.exe start --save-to=c:\Snapshots\snapshot.dtt
--profiling-type=Timeline c:\MyApp\App.exe
```

```bash
dotTrace.exe start --save-to=c:\Snapshots\snapshot.dtp
c:\MyApp\App.exe --use-api
```

```bash
dotTrace.exe attach 1234 --save-to=c:\Snapshots\snapshot.dtp
```

```bash
dotTrace.exe
```

--------------------------------

### Download and Install dotTrace CLI

Source: https://www.jetbrains.com/help/profiler/Profile_Application_in_Docker_Container.html

Install the dotTrace command-line tools within the container environment.

```bash
apt-get update -y && apt-get install -y wget && \
wget -O dotTraceclt.zip https://www.nuget.org/api/v2/package/JetBrains.dotTrace.CommandLineTools.linux-x64 && \
apt-get install -y unzip && \
unzip dotTraceclt.zip -d ./dotTrace && \
chmod +x -R dotTrace/*
```

--------------------------------

### Install dotTrace as a .NET Core tool

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Commands to install the dotTrace command-line tool as either a global or local .NET Core tool.

```bash
dotnet tool install --global JetBrains.dotTrace.GlobalTools
```

```bash
dotnet new tool-manifest
dotnet tool install JetBrains.dotTrace.GlobalTools
```

--------------------------------

### Profile macOS and Linux Applications via Command Line

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Examples for profiling Mono and .NET Core applications, attaching to processes, and listing options on Unix-based systems.

```bash
./dotTrace.sh start --framework=Mono /usr/bin/mono /home/Projects/MyMonoApp/myMonoApp
    --profiling-type=Timeline --timeout=10s --save-to=./snapshots/snapshot.dtt
```

```bash
./dotTrace.sh start --framework=NetCore /usr/bin/dotnet /home/Projects/MyNetCoreApp/MyNetCoreApp.dll
    --timeout=10s --save-to=./snapshots/snapshot.dtp
```

```bash
./dotTrace.sh start --framework=NetCore /usr/bin/dotnet /home/Projects/MyNetCoreApp/MyNetCoreApp.dll
    --support-earlier-net-core --timeout=10s --save-to=./snapshots/snapshot.dtp
```

```bash
./dotTrace.sh attach 1234 --save-to=./snapshots/snapshot.dtp
```

```bash
./dotTrace.sh
```

--------------------------------

### Profile .NET Core application via command line

Source: https://www.jetbrains.com/help/profiler/Profile_.NET_Core_Application.html

Use the dotTrace command-line profiler to start a profiling session and save the snapshot to a specified path.

```bash
dotTrace.exe start --save-to=C:\snapshots\snapshot.dtp C:\Projects\MyNetCoreApp\MyApp
```

--------------------------------

### Start dotTrace profiling via stdin or file

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Commands to initiate a profiling session for an executable using either stdin or a text file for control.

```bash
dotTrace.exe start --service-input=stdin c:\MyApp\MyApp.exe
```

```bash
dotTrace.exe start --service-input=file.txt c:\MyApp\MyApp.exe
```

```bash
./dotTrace.sh start --framework=NetCore --service-input=stdin ~/MyApp/myApp
```

```bash
./dotTrace.sh start --framework=NetCore --service-input=file.txt ~/MyApp/myApp
```

--------------------------------

### Run profiling with the dotTrace command-line tool

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Starts a timeline profiling session for a specific executable using the dottrace command.

```bash
dottrace start --profiling-type=Timeline .\MyApp\bin\Release\MyApp.exe
```

--------------------------------

### Enable Diagnostics for MAUI on macOS

Source: https://www.jetbrains.com/help/profiler/Profile-MAUI-application.html

Add this property to your project file if profiling does not start on macOS.

```xml
<PropertyGroup>
    <EnableDiagnostics>true</EnableDiagnostics>
</PropertyGroup>
```

--------------------------------

### Example dotTrace console output

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Sample output showing service messages sent by the profiler to stdout during a session.

```text
D:\dotTrace> .\dotTrace.exe start --service-input=stdin C:\MyApp\MyApp.exe
dotTrace Console Profiler 2020.2 Copyright (C) 2020 JetBrains s.r.o.
Profiling in progress...
##dotTrace["ready"]
You can control profiling by sending command messages to stdin. For details, type ##dotTrace["help"]
Executable='C:\MyApp\MyApp.exe' (non-child) is being passed for filtering
Passed filter executable='C:\MyApp\MyApp.exe'
##dotTrace["connected",{"pid":19016,"path":"C:\\MyApp\\MyApp.exe"}]
##dotTrace["started",{"pid":19016,"path":"C:\\MyApp\\MyApp.exe"}]
##dotTrace["get-snapshot"]
##dotTrace["stopped",{"pid":19016,"path":"C:\\MyApp\\MyApp.exe"}]
##dotTrace["snapshot-saved",{"pid":19016,"filename":"D:\\dotTrace\\Zupifix.dtp"}]
```

```text
./dotTrace.sh start --framework=NetCore --service-input=stdin ~/MyApp/myApp
dotTrace Console Profiler 2020.2 Copyright (C) 2020 JetBrains s.r.o.
Profiling in progress...
##dotTrace["ready"]
You can control profiling by sending command messages to stdin.
For details, type ##dotTrace["help"]
Executable='~/MyApp/myApp' (non-child) is being passed for filtering
Passed filter executable='~/MyApp/myApp'
##dotTrace["connected",{"pid":19016,"path":"~/MyApp/myApp"}]
##dotTrace["started",{"pid":19016,"path":"~/MyApp/myApp"}]
##dotTrace["get-snapshot"]
##dotTrace["stopped",{"pid":19016,"path":"~/MyApp/myApp"}]
##dotTrace["snapshot-saved",{"pid":19016,"filename":"~/dotTrace/Zupifix.dtp"}]
```

--------------------------------

### Start Shell Session in Container

Source: https://www.jetbrains.com/help/profiler/Profile_Application_in_Docker_Container.html

Open a shell session inside the target Docker container.

```bash
docker exec -it {container_ID_or_name} sh
```

```bash
docker exec -it my-aspnet-app-container sh
```

--------------------------------

### Generate Performance Report via Command Line

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Execute the Reporter.exe tool to generate a report from a snapshot file based on a provided pattern file.

```bash
Reporter.exe report <path_to_snapshot> --pattern=<path_to_pattern>
                    --save-to=<path_to_report>
```

```bash
Reporter.exe report c:\Snapshots\snapshot.dtp --pattern=pattern.xml --save-to=c:\Reports\report.xml
```

--------------------------------

### Report Instance Call Stack Data

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Example of a report node containing call stack information when the PrintCallstacks attribute is enabled.

```xml
<Function Id="0x0020000C" FQN="MyApplication.MainWindow.GetFileNames" TotalTime="12520" OwnTime="0" Calls="1740" Instances="1">
   <Instance CallStack="Main/Run/Run/RunInternal/RunDispatcher/PushFrame/PushFrameImpl/OnClick/RaiseEvent/RaiseEventImpl/InvokeHandlersImpl/InvokeHandler/btnSelectFiles_Click/GetFileNames" TotalTime="12520" OwnTime="0" Calls="1740" />
</Function>
```

--------------------------------

### Run a profiling session using an XML configuration

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Executes a profiling session based on a pre-configured XML file and saves the resulting snapshot to a specified path.

```bash
dotTrace.exe xmlfile <path_to_config> --save-to=<path_to_snapshot>
```

```bash
dotTrace.exe xmlfile config.xml
                            --save-to=c:\Snapshots\snapshot.dtp
```

--------------------------------

### Profile .NET Core 3.1+ Application via Command Line

Source: https://www.jetbrains.com/help/profiler/Profile_.NET_Core_Application.html

Use this command to profile applications targeting .NET Core 3.1 or later on Linux or macOS.

```bash
./dotTrace.sh start --framework=NetCore --save-to=~/snapshots/snapshot.dtp
~/Projects/MyNetCoreApp/MyApp
```

--------------------------------

### Performance Report XML Structure

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Example of the XML output generated by the Reporter.exe tool, detailing method execution times and call counts.

```xml
<Report>
   <Info>
      <Snapshot IndexFile="C:\snapshot1.dtp" Executable="C:\Temp\ConsoleAppTest.exe"
        CommandLine="C:\Temp\ConsoleAppTest.exe" />
   </Info>

   <Function FQN="Tests.Method1" TotalTime="500" OwnTime="100" Calls="1" />
   <Function FQN="Tests.Method2" TotalTime="400" OwnTime="200" Calls="10" />
</Report>
```

--------------------------------

### Profile .NET Core 3.0 or Earlier Application via Command Line

Source: https://www.jetbrains.com/help/profiler/Profile_.NET_Core_Application.html

Use this command with the --support-earlier-net-core flag for applications targeting .NET Core 3.0 or earlier.

```bash
./dotTrace.sh start --framework=NetCore --save-to=~/snapshots/snapshot.dtp --support-earlier-net-core
~/Projects/MyNetCoreApp/MyApp
```

--------------------------------

### Define Method Patterns in XML

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Create an XML file to specify which methods to include in the performance report using regular expressions.

```xml
<Patterns>
   <Pattern PrintCallstacks = "MethodNameOnly">Method1</Pattern>
   <Pattern>Method2</Pattern>
</Patterns>
```

--------------------------------

### Compare snapshots via command line

Source: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html

Use this command to generate a report highlighting the differences between two snapshot files based on a provided XML pattern.

```bash
Reporter.exe compare <path_to_snapshot1> <path_to_snapshot2>
                --pattern=<path_to_pattern> --save-to=<path_to_report>
```

```bash
Reporter.exe compare c:\Snapshots\base_snapshot.dtp c:\Snapshots\snapshot.dtp
        --pattern=pattern.xml --save-to=c:\Reports\report.xml
```
Tokens:
Raw