API 参照

GetFeatures()

enum MeasureFeatures: uint

プロファイラーで現在有効な機能のセットを返します。 MeasureFeatures の値のビットフラグが現在のプロファイラーの状態を完全に表します。 各ビットは、対応する機能が現在利用可能かどうかを示します：

• Ready = 0x1 ：プロファイラーが動作可能かどうかを示します。 プロファイラーを現在のプロセスにアタッチした場合のみ、このフラグを確認してください。プロファイラーがコマンドを受け付ける準備ができると、フラグが設定されます。 プロファイリング下でプロセスを開始すると、このフラグは常に設定されます。 プロファイラーをプロセスからデタッチした後、このフラグはクリアされます。

• Detach = 0x2: MeasureProfiler.Detach() を使用できるかどうかを示します。
  0: プロファイラーは MeasureProfiler.Detach() を無視します。
  1: MeasureProfiler.Detach() はプロファイラーをプロファイリングされたプロセスから切り離します。

StartCollectingData()

プロファイリングデータの収集を開始します。
アプリケーションがプロファイリングを無効にして実行されている場合でも、エラーはスローされません。

StartCollectingData(string groupName)

[Internal use only]
プロファイリングデータの収集を開始します。
プロファイリングを無効にしてアプリケーションを実行しても、エラーは発生しません。
groupName は、収集されたデータブロックの名前です。

StopCollectingData()

プロファイリングデータの収集を停止します。 現在のデータはメモリに保持されるため、次に StartCollectingData() で測定を開始すると、新しいデータが現在のデータに追加されます。
この方法では、収集されたデータブロックはディスクに保存されません。
アプリケーションがプロファイリング無効で実行されている場合でも、エラーは発生しません。
重要 ! この方法は タイムラインプロファイリングタイプには適用されず、プロファイラーによって無視されます。

SaveData()

必要に応じてデータの収集を停止し、収集したすべてのデータブロックをディスクに保存します。
スナップショットを保存した後、収集されたデータはリセットされます。
プロファイリングを無効にしてアプリケーションを実行しても、エラーは発生しません。

SaveData(string name)

[Internal use only]
必要に応じてデータの収集を停止し、収集したすべてのデータブロックをディスクに保存します。
スナップショットを保存した後、収集されたデータはリセットされます。
アプリケーションがプロファイリング無効で実行されている場合でも、エラーは発生しません。
name は、収集されたデータブロックの名前です。 ファイル名ではありません。

Detach()

プロファイリングされたプロセスからプロファイラーを切り離します。 プロファイラーでデタッチが無効になっている場合は何もしません。 デタッチが有効になっているかどうかを確認するには、 MeasureProfiler.GetFeatures() と MeasureFeatures.Detach フラグを使用します。 プロファイリングを無効にしてアプリケーションを実行しても、エラーはスローされません。

DropData()

必要に応じてデータの収集を停止し、収集されたすべてのデータブロックを削除します。
アプリケーションがプロファイリングを無効にして実行されている場合でも、エラーはスローされません。

Init(Uri nugetUrl = null, NuGetApi nugetApi = NuGetApi.V3, string downloadTo = null)

プロファイラーを初期化します。 このメソッドは、 InitAsync() メソッドを呼び出す簡単な方法です。 これは、プロファイラーの初期化に推奨される方法です。

InitAsync( CancellationToken cancellationToken, IProgress<double> progress = null, Uri nugetUrl = null, NuGetApi nugetApi = NuGetApi.V3, string downloadTo = null)

Task

（代わりに Init() を使用することをお勧めします）
プロファイラーを初期化します。 初期化中に、API は実行中のアセンブリと同じフォルダーにコマンドラインプロファイラーが存在するかどうかを確認します。 プロファイラーが見つからない場合は、互換性のある JetBrains.dotTrace.CommandLineTools NuGet パッケージ（Windows(英語)、 Linux(英語)、 macOS(英語) ）を downloadTo フォルダーにダウンロードします。 互換性のあるパッケージバージョンは、 NupkgVersion 定数によって設定されます。 progress コールバック変数を使ってダウンロードの進捗をトラックし、 cancellationToken でダウンロードをキャンセルできます。

Attach()

デフォルトのプロファイリング構成を使用して、プロファイラーを現在のプロセスに接続します。

Attach(DotTrace.Config config)

指定されたプロファイリング config を使用して、プロファイラーを現在のプロセスに接続します。

StartCollectingData()

パフォーマンスデータの収集を開始します。 プロファイラーの状態は「停止」から「開始」に変わります。 プロファイラーがすでに「開始」状態の場合、コマンドは無視されます。

SaveData()

現在のプロセスのパフォーマンススナップショットを取得します。 収集されたすべてのデータは、構成で指定されたファイルに保存されます。 データを保存した後、プロファイラーは「停止」状態になることに注意してください。 データの収集を再開するには、 StartCollectingData() を呼び出します。

DropData()

収集されたデータを破棄するには、このメソッドを実行します。 データを破棄すると、プロファイラーは「停止」状態になることに注意してください。 データの収集を再開するには、 StartCollectingData() を呼び出します。

StopCollectingData()

パフォーマンスデータの収集を停止します。 プロファイラーの状態が「開始」から「停止」に変わります。 プロファイラーがすでに「停止」状態の場合、コマンドは無視されます。 スナップショットを取得する前にこのメソッドを呼び出す必要はありません。 注: このコマンドは、 プロファイラー API を使用してセッションを制御する場合にのみサポートされます。 それ以外の場合、コマンドは無視されます。

GetCollectedSnapshotIndexFiles()

String[]

収集されたスナップショットインデックスファイルへのパスを返します。 収集されたスナップショットごとに、個別のインデックスファイルが返されます。 注: スナップショットを共有するには、インデックスファイルだけでなくすべてのファイルをコピーする必要があります。 このような場合は、 GetCollectedSnapshotFilesArchive() を使用する方が便利です。

GetCollectedSnapshotFiles()

String[]

収集されたすべてのスナップショットファイルへのパスを返します。 収集されたスナップショットごとに、複数のファイルが返されます。

GetCollectedSnapshotFilesArchive(bool deleteUnpackedFiles)

String

収集されたすべてのスナップショットファイル (インデックスファイルを含む) を含む zip ファイルへのパスを返します。 データがまだ収集されていない場合は null を返します。 deleteUnpackedFiles は、解凍されたスナップショットファイルを削除する必要があるかどうかを指定します。

Detach()

現在のプロセスからプロファイラーを切り離します。 プロファイリングが終了したら、それを呼び出します。

SaveToFile(string snapshotFile, bool overwrite = false)

DotTrace.Config

スナップショットインデックスファイルへのパスを指定します。 複数のスナップショットを作成する場合、最初のスナップショットは指定されたファイル名を取得します。 他の人はさらに接尾辞 -[snapshot-number] を取得します。 パスで指定されたディレクトリはすでに存在している必要があります。

SaveToDir(string dirPath)

DotTrace.Config

スナップショットファイルを保存する必要があるディレクトリへのパスを指定します（名前は自動生成されます）。 ディレクトリはすでに存在している必要があります。 SaveToDir と SaveToFile は相互に排他的です。

UseTimelineProfilingType()

DotTrace.Config

セッションのタイムラインプロファイリングタイプを指定します。