.NET アプリケーションで CPU 時間を使っている箇所を dotnet trace を使って計測する

プロローグ

C# などを使った .NET アプリケーション開発における話。

先日、以前にリリースした .NET アプリケーションが、ある特定の環境 (OS は Windows) で処理が非常に遅くなる、という事態が発生した。

その処理が遅くなる現象を自分の手元の開発環境でも再現できる場合は、自分は開発環境に Visual Studio を使っているため、当該 .NET アプリケーションのソースコード/プロジェクトを Visual Studio で開いてデバッグ実行すれば、Visual Studio のデバッガ機能により、どこのメソッドがどの程度の割合、CPU 時間を消費しているのかを記録・測定、グラフィカルユーザーインターフェースで探索することができる。

ところが今回の件は、どうにも自分の手元で再現ができず、どうも実行時の環境で発生している様子。しかも自分はその現象が発生している現地・現場には行けず、かつ、なんらかの PC 画面共有ツールを活用してのリモート保守も不可能、という制約付き。

ただし代わりに、その問題現象に遭遇しているユーザーにお願いすれば、こちらから送ったデバッグビルドした版の .NET アプリケーションをインストール・実行してくれたり、スクリーンショットを撮って送ってくれたりなど、ターミナル (PowerShell) での作業を含めて、それなりの PC 操作は実施してくれる。

以上のような制約があったので、実は正直なところ、自分は経験もなく不慣れだったのだが、dotnet trace コマンドラインツールを使った、.NET アプリケーション実行時のパフォーマンス情報収集に挑戦することにした。

dotnet trace コマンドラインツール

以前にどこかで見聞きした覚えで、dotnet trace コマンドラインツールを使えば、対象とする .NET アプリケーションの実行中のパフォーマンス情報を、拡張子 .nettrace のファイルとして保存してくれるという。どうやら .NET SDK のインストールが必要となるらしいのだが、本番環境 PC に「Visual Studio 入れてください」などとお願いするのに比べれば (ライセンス的にも容量的にも手順的にもネットワーク資源的にも時間的にも) はるかに敷居が低い。

そして現場で dotnet trace コマンドを使うことができてひとたび .nettrace ファイルにパフォーマンス情報を保存成功したならば、その .nettrace ファイルをこちらに返送してもらえば、その .nettrace ファイルを Visual Studio で開くことで、どこのメソッドでどの程度の割合、CPU 時間を消費しているのかをグラフィカルユーザーインターフェースで探索できるようになるらしいのだ。

ということで現場のユーザーの支援のもと、実際に作業を進めてみた。

インストールと実行

まずは手始めに、現場のユーザーに、現象が発生している当該 PC 上に、.NET SDK をインストールしてもらった。OS は Windows (x64) だったので、公式のダウンロードサイトからしかるべきバージョンの .NET SDK のインストーラーファイルをダウンロードして実行してもらうだけだ。

.NET SDK がインストール完了し、ターミナル上で dotnet コマンドが使えるようになったら次は、本命の dotnet-trace コマンドをグローバルツールとしてインストールする。具体的には下記コマンドをターミナル上で実行すればよい。

dotnet tool install --global dotnet-trace

無事インストールが完了すると、"dotnet trace" サブコマンドが使えるようになる。そうしたらいよいよパフォーマンス情報の収集・.nettrace ファイルへの保存だ。

まずは対象となる .NET アプリケーションを実行開始する。

次にターミナル上で

dotnet trace collect -n {プロセス名}

を実行する。すると、-n オプションで指定したプロセス名の .NET アプリケーションプロセスに対し、パフォーマンス情報の収集・記録が始まる。この状態で問題現象を再現してもらい、再現も済んで充分パフォーマンス情報を記録できたと思ったら、dotnet trace collect コマンドが実行中のターミナル上でキーボードから Ctrl + C を入力して停止させる。

すると、dotnet trace コマンドを実行したカレントフォルダーに、.nettrace ファイルが生成されているのだ。

あとはこのパフォーマンス情報が保存されている .nettrace をこちらに何らかの手段で送信してもらえば OK だ。

解決できた

こうして .nettrace を手に入れたら、Visual Studio をインストール済みの開発環境 Windows PC 上で適当な作業フォルダに保存し、この .nettrace ファイルをエクスプローラー上でダブルクリックする。すると、拡張子関連付けにより Visual Studio が起動してこの .nettrace ファイルを開いてくれる。あとは Visual Studio のグラフィカルユーザーインターフェースを介して、どこのメソッドでどれだけ CPU 時間を消費しているのかを探索することができる。

こうしてどうにかこうにか CPU 時間を消費しているソースコード上の箇所を特定することができ、そこから「ああー、そういうこと!?」という環境依存であった問題原因を特定、対処して改善された新バージョンをリリースしてお届けすることができた。

ということで、自分もなかなか利用する機会がなかった dotnet trace コマンドであるが、こんな使い方・活用もできる、という共有までに。