JetBrains.Profiler.SelfApi Self-profiling configuration Helpers for self-profiling configuration By default self-api profiles the same process it was run in. With this option it is possible to profile another process by its pid [Advanced use only] Prohibits using `JetBrains.Profiler.Api` to control the profiling session in case was used.> By default, `JetBrains.Profiler.Api` is used to control the session. Otherwise, the self-profiling API uses command-line profiler service messages to control the session. Specifies path to log file. Appends an arbitrary argument to the command line as is (without any quoting, and so on). Closes the session if the profiler doesn't respond in the specified timeout, for example, when attaching to or detaching from the process The API lets you initiate and control profiling sessions right from the code of your application. For example, this can be helpful for profiling the application on end-user desktops or production servers. The API uses the dotMemory command-line profiler (the tool is downloaded automatically) Use case 1: ad-hoc profiling
* install the JetBrains.Profiler.SelfApi package to your project
* to initialize the API, call DotMemory.Init()
* to get just one memory snapshot, call DotMemory.GetSnapshotOnce
* or in case you need several snapshots, call Attach/GetSnapshot*/Detach
* deploy your application
* reproduce the issue
* investigate the generated workspace with snapshots using JetBrains dotMemory

Use case 2: self-profiling as a part of troubleshooting on a production server
* install the JetBrains.Profiler.SelfApi package to your project
* in handler of awesome `Gather trouble report` action call DotMemory.Init()
* to get a memory snapshot, call DotMemory.GetSnapshotOnce
* include the generated workspace with snapshots into the report
 Self-profiling configuration Specifies the path to the workspace file (snapshots storage). Specifies the path to the workspace directory (filename will be auto-generated). Specifies whether to open the generated workspace in JetBrains dotMemory. Sets the TRACE logging level. Sets the VERBOSE logging level. The self-profiling API requires the dotMemory command-line profiler for its work.
This method:
1. Checks whether the new command-line profiler version is available at the online NuGet registry.
2. If necessary, downloads the `JetBrains.dotMemory.Console` NuGet package to the folder.
3. Initializes the profiler.
You should call this or another Init method before any other method of the self-profiling API. This method requires access to the internet. In isolated environments, use . Cancellation token Download progress callback from 0.0 to 100.0. If null, progress is not reported. URL of NuGet mirror. If null, www.nuget.org is used. NuGet API version. NuGet download destination folder. If null, %LocalAppData% is used. The self-profiling API requires the dotMemory command-line profiler for its work.
This method checks that the profiler is located at and initializes the profiler.
You should call this or another Init method before any other method of the self-profiling API.
 Use this method only if your computer doesn't have access to the internet, and you want to use the locally installed command-line profiler.
Otherwise, use or . Folder with the command-line profiler It's the shortcut for InitAsync(CancellationToken.None, progress: null, nugetUrl, prerequisitePath).Wait() It's the shortcut for InitAsync(CancellationToken.None, progress, nugetUrl, prerequisitePath) This method is obsolete, use or instead
It makes sure that the dotMemory command-line profiler is downloaded and is ready to use. 1. Looks for command-line profiler in the folder (if specified). Uses it if it's found.
2. Looks for command-line profiler in the same folder with the running assembly. Uses it if it's found.
3. Downloads the latest `JetBrains.dotMemory.Console` NuGet package into the folder and uses the command-line profiler from this package. The basic package version is defined by . The command-line profiler is saved to `{downloadTo}/dotMemory/{Version}/dotMemory.exe` If the file exists, a new one is not downloaded. Cancellation token Download progress callback from 0.0 to 100.0. If null, progress is not reported. URL of NuGet mirror. If null, www.nuget.org is used. NuGet API version. NuGet download destination folder. If null, %LocalAppData% is used. This method is obsolete, use or instead
It's the shortcut for EnsurePrerequisiteAsync(CancellationToken.None, progress, nugetUrl, prerequisitePath) This method is obsolete, use or instead
It's the shortcut for EnsurePrerequisiteAsync(CancellationToken.None, progress: null, nugetUrl, prerequisitePath).Wait() The shortcut for ; ; ; Saved workspace file path. The shortcut for ; ; ; Saved workspace file path. Attaches dotMemory to the current process using the default API configuration. Attaches dotMemory to the current process using the specified API configuration. Detaches dotMemory from the current process. Saved workspace file path. Collect memory snapshot of the current process and save it to the disk. This method forces full GC. The name of the memory snapshot. This is not a file name. Currently not used. The API lets you initiate and control profiling sessions right from the code of your application. For example, you can use it to profile the application on end-user desktops or production servers. The API uses the dotTrace command-line profiler (the tool is downloaded automatically) Use case: ad-hoc profiling
* Install the JetBrains.Profiler.SelfApi package to your project
* To initialize the API, call DotTrace.Init()
* To start collecting data, call DotTrace.StartCollectingData() * To save collected data into snapshot, call DotTrace.SaveData
* In case you need several snapshots, call DotTrace.StartCollectingData and DotTrace.SaveData once more
* To pack collected data into a single zip file call DotTrace.GetCollectedSnapshotFilesArchive
* Investigate the generated snapshots using JetBrains dotTrace

 Self-profiling configuration Specifies the path to the snapshot index file. If you take more than one snapshot, the first snapshot will get the specified file name. Others will additionally get the suffix "-[snapshot-number]". The directory specified in the path must already exist. Path to the file Overwrite the file if it exists Specifies the path to the directory where snapshots files must be saved (names will be auto-generated). The directory must already exist. Path to the directory (Windows only) Use the Timeline profiling type. If not specified, the Sampling type is used. If false and a profiling session requires administrative privileges, the method throws an exception. If true, dotTrace will ask for UAC elevation and continue the session. The self-profiling API requires the dotTrace command-line profiler for its work.
This method:
1. Checks whether the new command-line profiler version is available at the online NuGet registry.
2. If necessary, downloads the `JetBrains.dotTrace.CommandLineTools` NuGet package to the folder.
3. Initializes the profiler.
You should call this or another Init method before any other method of the self-profiling API. This method requires access to the internet. In isolated environments, use . Cancellation token Download progress callback from 0.0 to 100.0. If null, progress is not reported. URL of NuGet mirror. If null, www.nuget.org is used. NuGet API version. NuGet download destination folder. If null, %LocalAppData% is used. The self-profiling API requires the dotTrace command-line profiler for its work.
This method checks that the profiler is located at and initializes the profiler.
You should call this or another Init method before any other method of the self-profiling API.
 Use this method only if your computer doesn't have access to the internet, and you want to use the locally installed command-line profiler.
Otherwise, use or . Folder with the command-line profiler It's the shortcut for InitAsync(CancellationToken.None, progress: null, nugetUrl, prerequisitePath).Wait() It's the shortcut for InitAsync(CancellationToken.None, progress, nugetUrl, prerequisitePath) This method is obsolete, use or instead
It makes sure that the dotTrace command-line profiler is downloaded and is ready to use. 1. Looks for dotTrace executable in the same directory with the running assembly. Uses it if it's found.
2. Downloads `JetBrains.dotTrace.CommandLineTools` NuGet package into the directory and uses the dotTrace command-line profiler from this package. The package version is defined by . The command-line profiler is saved to `{downloadTo}/dotTrace.{NupkgVersion}` Cancellation token Download progress callback from 0.0 to 100.0. If null, progress is not reported. URL of NuGet mirror. If null, www.nuget.org is used. NuGet API version. NuGet download destination directory. If null, %LocalAppData% is used. This method is obsolete, use or instead
It's the shortcut for EnsurePrerequisiteAsync(CancellationToken.None, progress, nugetUrl, prerequisitePath) This method is obsolete, use or instead
It's the shortcut for EnsurePrerequisiteAsync(CancellationToken.None, progress: null, nugetUrl, prerequisitePath).Wait() Attaches dotTrace to the current process using the default API configuration. Note: After attaching, the profiler goes to "Stopped" state. To start collecting data, call Attaches dotTrace to the current process using the specified API configuration. Note: After attaching, the profiler goes to "Stopped" state. To start collecting data, call Profiler configuration Detaches dotTrace from the current process Call it after you finish profiling Starts collecting performance data Profiler changes state from "Stopped" to "Started" If profiler is already in "Started" state, the command is ignored Takes a snapshot of the current process All collected data is saved to files specified in the configuration Note: After saving the data, profiler goes to "Stopped" state To start collecting data again, call Drops collected data Run this method to discard collected data. Note: After discarding the data, profiler goes to "Stopped" state To start collecting data again, call Stops collecting performance data Profiler changes state from "Started" to "Stopped". If profiler is already in "Stopped" state, the command is ignored. It is not necessary to call this method before taking snapshot. Note: The command is supported only if profiler API is used to control session. Otherwise, the command is ignored. Note: Ignored while profiling external process Returns collected snapshot index files For each collected snapshot, a separate index file is returned. Note: To share a snapshot, you must copy not only the index file but all files. In such cases, it's more convenient to use or Paths to index files Returns all collected snapshot files (including index files) For each collected snapshot, more than one file is returned Paths to snapshot files Returns all collected snapshot files (including index files) packed into a single zip file Path to the zip file. Returns null if data is not yet collected. 2023.1 The minimal stuff to support NuGet package downloading for API v2/v3 Simplified support for semantic version. Set user ID on execution Set group ID on execution Save swapped text after use (sticky). Read by owner Write by owner Execute by owner Read by group Write by group Execute by group Read by other Write by other Execute by other Read, write, execute by group Read, write, execute by user Read, write, execute by other 0777 07777 0666 Bits which determine file type Directory Character device Block device Regular file FIFO Symbolic link Socket Alias for 0644 Alias for 0755 NuGet API version NuGet API v2 NuGet API v3 The entry point for all logging related to self-profiling. The current instance of used for all logging inside self-profiling API. You can control trace output via App.config or via programatically added listeners, see examples below. Redirect to console using App.config: <system.diagnostics> <sources> <source name="JetBrains.Profiler.SelfApi" switchName="SourceSwitch" switchType="System.Diagnostics.SourceSwitch" > <listeners> <add name="Console" /> </listeners> </source> </sources> <switches> <add name="SourceSwitch" value="Verbose" /> </switches> <sharedListeners> <add name="Console" type="System.Diagnostics.ConsoleTraceListener" initializeData="false"/> </sharedListeners> <trace autoflush="true" indentsize="4"> <listeners> <add name="Console" /> </listeners> </trace> </system.diagnostics>
Redirect to console using programatically added listener: Trace.Source.Switch = new SourceSwitch("SourceSwitch", "Verbose"); Trace.Source.Listeners.Add(new ConsoleTraceListener()); Writes message with VERBOSE level. Writes message with VERBOSE level. Writes message with INFO level. Writes message with INFO level. Writes message with ERROR level. Writes message with ERROR level.