JetBrains Rider 2021.2 Help

Profile applications

Regardless of what application type you are going to profile, the workflow is always the same and consists of:

  1. Configuring a profiling session

  2. Running the session and getting snapshots

  3. Analyzing the collected snapshots

Step 1. Configuring a profiling session

Profiling configurations in Rider

Before starting a profiling session, you must select a profiling configuration:

  • The profiling configuration specifies profiling session settings like which profiling type will be used, whether child processes must be profiled, and so on.

  • The profiling target is always an executable* which is specified in the currently selected run configuration.

  • Currently, you are able to profile the following run configuration types:

    If you select a run configuration of some other type, this will disable the profiling controls on the toolbar.

Select a profiling configuration

  • In the toolbar, in the list of profiling configurations, select:

Create a profiling configuration

  1. On the toolbar, in the list of profiling configurations, select Edit Configurations...

  2. In the opened Profiling Configurations window, click Add profiling configuration to add a new profiling configuration.

  3. In the list, select one of the profiling types:
    SamplingAccurate time measurement, number of calls is not measured.

    Recommended for most cases. Ideal when you look for performance issues in your app for the first time.

    On macOS and Linux, if you want to profile an application targeting .NET Core 3.0 or earlier, select Sampling (.NET Core 3.0 or earlier). Note that because of .NET Core limitations, you might have issues: the profiled application may hang or crash. Projects targeting .NET Core 3.1 (or later) can be profiled without any issues.

    TracingAccurate calls count measurement, time measurement may be inaccurate due to profiling overhead.When sampling data is not enough. For example, for analyzing algorithm complexity (when info about number of calls is more valuable than call time values).

    Each line of code is measured, call time values are inaccurate due to huge profiler overhead.

    For advanced use cases only. For example, when you already know what function causes issues and want to analyze each line of it.
    TimelineCollects temporal data about thread states, application events, and other multi-threading data. Based on Event Tracing for Windows (ETW). Supports native profiling.

    Recommended for most cases. Especially, for analyzing multithreaded apps. Use it, for example, to determine the cause of UI freezes, excessive garbage collections, uneven workload distribution, insufficient I/O, and so on.

    If you want to create a configuration for profiling Mono or Unity applications, select Timeline (Mono) or Timeline (Unity) correspondingly.

  4. Specify configuration Name and other profiling options:

    • Control profiling manually
      Enables you to control profiling manually via the profiler controls. For example, to take a snapshot, you will have to click Get Snapshot.

    • Control profiling via API
      Enables you to control profiling directly from the code of the profiled application. For example, to take a snapshot in the exact point of your code. Learn more about using the API in the dotTrace documentation.

    • Profile child processes
      If selected, dotTrace will profile not only the main app process but the processes it runs as well.

    • Time measurement (Sampling, Tracing, Line-by-line)

      This option defines how dotTrace must calculate calls time. Typically, this is a choice between whether dotTrace should calculate time when a thread is not working or should not. For more details, refer to dotTrace documentation.

      Real time (performance counter)Recommended. dotTrace calculates the overall real time passed between method entry and exit. This time does not depend on app threads states. Time is calculated using system performance counter.
      Real time (CPU instruction)dotTrace calculates the overall real time passed between method entry and exit. This time does not depend on app threads states. Time is calculated using the CPU register.
      Thread timedotTrace calculates only the time when a certain thread is running. The time when the thread is waiting or sleeping is not included in calculation.
      Thread cycle timedotTrace calculates only the time when a certain thread is running. The time when the thread is waiting or sleeping is not included in calculation. Time is calculated using the CPU register.

      The table next in this section will help you to choose a time measurement method better suitable for your case.

    • Enable inlining (Tracing, Line-by-line)

      Clear this option if you want dotTrace to turn off JIT-inlining and get call stacks that closely resemble the structure of application's source code.

    • High accuracy (Tracing, Line-by-line)

      If selected, dotTrace will take into account time spent in profiler itself by taking more time samples.

    • Enable native profiling (Timeline, Unity/Mono on Windows)

      If selected, dotTrace will collect native call stack data. The resulting snapshot will contain both managed and native call stacks. This profiling option may be helpful for finding performance issues in Unity games.

    • Collect native allocations (Timeline)

      If selected, dotTrace will collect information about all memory allocations the profiled application does in the native (unmanaged) heap. To be able to select this option, you must have Windows Performance Toolkit installed on your computer.

    • Collect TPL events (Timeline)

      If selected, profiling performance may be affected but dotTrace will collect Task Parallel Library (TPL) data. If cleared, there will be no Task nodes in Call Tree and async call nodes will be shown without their await and continuations parts.

      Clear this option in case your application does not use multitasking or you do not need this info.

    • Collect debug output (Timeline)

      If selected, dotTrace will collect information about all messages the profiled application sends to the debug output.

    • Download symbol files (Timeline)

      PDB files (or symbol files) let you see native functions in the call tree. This is relevant for native applications and managed applications that call native code. If you select Download symbol files, JetBrains Rider will try downloading PDB files from remote servers right after you get a snapshot. Note that this may take a significant amount of time depending on file size.

      By default, JetBrains Rider looks for PDB files in the locations specified in the _NT_SYMBOL_PATH environment variable. Alternatively, you can specify custom local or remote locations using the configure symbol servers link.

Step 2. Running the session and getting snapshots

Start a session and get snapshots

  1. On the toolbar, select the run configuration you want to profile.

  2. Either select Run | Profile 'run_config_name' Using 'profiling_config_name' or click the corresponding button on the toolbar.

    Start profiling session

    Once the profiling is started, you will see the Performance Profiler tool window opened on the Profiling tab with the profiling controller inside.

  3. If you disabled Collect profiling data from start in the profiling configuration, click Start Recording Start Recording to start recording profiling data.
    Basically, now all you need is reproduce the performance issue you are looking for or, if you just evaluate the overall app performance, go through the desired usage scenarios in your application.

  4. Click Get Performance Snapshot Rider Get Snapshot. The collected snapshot will be added to the list of snapshots inside the Performance Profiler window. To start collecting profiling data again, click Start Recording Start Recording one more time.

  5. After you collect a snapshot(s), you can finish the profiling session. Normally, you do it either by closing the profiled application or by detaching the profiler via the Detach profiler Detach button (Kill processes Kill forcibly terminates the profiled app and the session, so, use it only in emergency cases).

Step 3. Analyzing collected snapshots

For more details on how to analyze performance snapshots, refer to Analyze profiling results.

Analyze a snapshot

  1. On the All Snapshots tab of the Performance Profiler tool window, select the snapshot you want to analyze.

  2. Analyze the collected data using one of the views:

    • Call Tree: a "classic" call tree that shows you all method calls in all threads. Each top-level node represents a top-level function which was executed by a certain thread. Use this view to quickly get down to actual application activity. Learn more

    • Top Methods: the best place to start when analyzing application performance. It is a simple plain list of methods with the highest execution time. Note that you can reduce the system functions "noise" by excluding them from the list using the Hide system functions toggle: if enabled, method's execution time is calculated as a sum of method's own time and the time of all child system methods (down to the next user method in the stack). Learn more

  3. Once the suspicious method is found, press F4 or select Jump to Source from the context menu. Rider will navigate you right to the method's source code.

Last modified: 19 August 2021