dotprof 1.0.0-rc.3

<div align="center">

dotprof

Inject trace logs for AI Coding Agents

</div>

dotprof is a tracing and profiling tool optimized for AI coding agents.

There are similar tools such as dotnet-trace[^dnt], dotnet-stack[^dns], strace, dotTrace, dntrace, etc, but the existing tools are too sophisticated in AI era.

[^dnt]: dotnet-trace diagnostic tool - .NET CLI - .NET | Microsoft Learn — https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-trace

[^dns]: dotnet-stack diagnostic tool - .NET CLI - .NET | Microsoft Learn — https://learn.microsoft.com/dotnet/core/diagnostics/dotnet-stack

Sample Output

Without having to read the AI-generated code, you can easily understand the execution flow correctness, bottlenecks, etc.

Then you just paste the output, add your review comments, and say "do it".

├─┬ Sandbox.<Main>
│ │   + System.String[]
│ ├─┬ Sandbox.Main
│ │ │   + System.String[]
│ │ ├─┬ <Main>d__0..ctor
│ │ │ └ <Main>d__0..ctor
│ │ │     0.3804ms, 0.00s total, alloc ~= 0 B
│ │ ├─┬ <Main>d__0.MoveNext
│ │ │ ├─┬ Sandbox.NoArgs
│ │ │ │ └ Sandbox.NoArgs
│ │ │ │     0.0095ms, 0.01s total, alloc ~= 0 B
│ │ │ ├─┬ Foo..cctor
│ │ │ │ └ Foo..cctor
│ │ │ │     0.0006ms, 0.01s total, alloc ~= 0 B
│ │ │ ├─┬ Foo.Alloc1KiB
│ │ │ │ └ Foo.Alloc1KiB
│ │ │ │     0.0002ms, 0.01s total, alloc ~= 0 B
│ │ │ ├─┬ Foo.Alloc1KiB
│ │ │ │ └ Foo.Alloc1KiB
│ │ │ │     0.0001ms, 0.01s total, alloc ~= 0 B
│ │ │ ├─┬ Foo.Alloc1KiB
│ │ │ │ └ Foo.Alloc1KiB
│ │ │ │     0.0002ms, 0.01s total, alloc ~= 0 B
│ │ │ ├─┬ Foo.Alloc1KiB
│ │ │ │ └ Foo.Alloc1KiB
│ │ │ │     0.0001ms, 0.01s total, alloc ~= 0 B
│ │ │ ├─┬ Sandbox.Branch_WithoutReturn
│ │ │ │ │   + True
│ │ │ │ ├─┬ Sandbox.<Branch_WithoutReturn>g__true_branch|6_0
│ │ │ │ │ └ Sandbox.<Branch_WithoutReturn>g__true_branch|6_0
│ │ │ │ │     0.0005ms, 0.01s total, alloc ~= 0 B
│ │ │ │ └ Sandbox.Branch_WithoutReturn
│ │ │ │     0.071ms, 0.01s total, alloc ~= 0 B
│ │ │ ├─┬ Sandbox.Branch_WithoutReturn
│ │ │ │ │   + False
│ │ │ │ ├─┬ Sandbox.<Branch_WithoutReturn>g__false_branch|6_1
│ │ │ │ │ └ Sandbox.<Branch_WithoutReturn>g__false_branch|6_1
│ │ │ │ │     0.0004ms, 0.01s total, alloc ~= 0 B
│ │ │ │ └ Sandbox.Branch_WithoutReturn
│ │ │ │     0.0588ms, 0.01s total, alloc ~= 0 B
│ │ │ ├─┬ Sandbox.Branch_WithReturn
│ │ │ │ │   + True
│ │ │ │ ├─┬ Sandbox.<Branch_WithReturn>g__true_branch|7_0
│ │ │ │ │ └ Sandbox.<Branch_WithReturn>g__true_branch|7_0
│ │ │ │ │     0.0004ms, 0.01s total, alloc ~= 0 B
│ │ │ │ └ Sandbox.Branch_WithReturn
│ │ │ │     0.0613ms, 0.01s total, alloc ~= 0 B
│ │ │ ├─┬ Sandbox.Branch_WithReturn
│ │ │ │ │   + False
│ │ │ │ ├─┬ Sandbox.<Branch_WithReturn>g__false_branch|7_1
│ │ │ │ │ └ Sandbox.<Branch_WithReturn>g__false_branch|7_1
│ │ │ │ │     0.0004ms, 0.01s total, alloc ~= 0 B
│ │ │ │ └ Sandbox.Branch_WithReturn
│ │ │ │     0.062ms, 0.01s total, alloc ~= 8224 B
│ │ │ ├─┬ Sandbox.CI_fails_if_stdout_doesnt_include_this__2255201d_4e66_4fb0_b0c0_f1ee1c005c61
│ │ │ │ └ Sandbox.CI_fails_if_stdout_doesnt_include_this__2255201d_4e66_4fb0_b0c0_f1ee1c005c61
│ │ │ │     0.0004ms, 0.01s total, alloc ~= 0 B
│ │ │ └ <Main>d__0.MoveNext
│ │ │     0.8416ms, 0.01s total, alloc ~= 16448 B
│ │ └ Sandbox.Main
│ │     3.8051ms, 0.01s total, alloc ~= 16448 B
│ └ Sandbox.<Main>
│     4.095ms, 0.01s total, alloc ~= 24672 B

Arguments and Performance Metrics

• +: Method arguments. Override ToString to customize string representation.
• Milliseconds: Method, property or constructor execution duration.
• Total seconds: Elapsed time from app start (technically, it's from static field initialization).
• Allocation: Delta value of GC.GetTotalMemory from method start.
  • It's a total, not per-method allocation - new byte[1024] takes 8,224 bytes at once.

Basic Usage

# Install as a global tool
dotnet tool install -g dotprof

# Or, use with dnx
dnx -y dotprof -- [args]

# Inject traces to current repo
dotprof --framework net10.0

# Inject traces to only members whose full name has Foo or Bar
dotprof --targets Foo,Bar

Test Mode

Inject and view traces using dotnet test without complicated setups.

# Usage ('-' is a delimiter)
dotprof test [options] - [args]

# Example
dotprof test -p ./Foo - --filter Name~Foo

    # Automatically run the following commands
    dotprof -p ./Foo
    dotnet test --filter Name~Foo

CLI Mode

Build and inject traces and then run resulting .dll with dotnet <dll> [args].

# Usage: Inject options and CLI arguments are separated by '-'
dotprof [options] - [args]

# Example: Build ./src and run with args 'foo --bar=baz'
dotprof -p ./src - foo --bar=baz

Unity Integration

You can inject traces with custom logger such as UnityEngine.Debug.Log.

dotprof --logger UnityEngine.Debug.Log -p foo.dll

Technical Note

Console.OutputEncoding

Injected traces force set OutputEncoding to Encoding.UTF8.

Troubleshooting

Traces not appear in console

Try run dotprof once again.

First-time execution may not work as expected (help wanted).

Failed to read environment variable [DOTNET_STARTUP_HOOKS], HRESULT: 0x80070002

If this error occurs even if you didn't set, run:

set DOTNET_STARTUP_HOOKS=

NOTE: It is not set in this tool. Not sure why this happens.