dotTrace 2020.1ヘルプ

API 参照

MeasureProfilerクラスのメソッド

項目

戻り値

説明

GetFeatures()enum MeasureFeatures: uint

プロファイラで現在アクティブな機能のセットを返します。MeasureFeatures 値のビットフラグは、現在のプロファイラの状態を完全に記述しています。各ビットは、対応する機能が現在利用可能かどうかを示します。

  • Ready = 0x1 : プロファイラーが動作する準備ができているかどうかを示します。このフラグは、プロファイラーを現在のプロセスにアタッチする場合にのみチェックする必要があります。プロファイラーがコマンドを受け入れる準備ができると、フラグが設定されます。プロファイリング中にプロセスを開始すると、このフラグは常に設定されます。プロファイラーをプロセスからデタッチすると、フラグはクリアされます。

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

StartCollectingData()

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

StartCollectingData(string groupName)

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

StopCollectingData()

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

SaveData()

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

SaveData(string name)

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

Detach()

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

DropData()

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

プロファイリングAPI

自己プロファイリングAPI

SelfAttachクラスのプロパティ

項目

タイプ

説明

Stateenum SelfApiState {None, Inactive, Active}

プロファイラーの状態を示します。

  • None : プロファイラは利用できません。

  • Inactive : プロファイラは利用可能です。プロファイリング制御は利用できません。

  • Active : プロファイラは利用可能です。プロファイリングは、APIまたはコントローラーウィンドウを介して制御できます。

SelfAttachクラスのメソッド

項目

説明

Attach(BaseProfilingConfig baseConfig)

提供された構成 baseConfigでプロファイラーを呼び出し側アプリケーションに接続します。

Show()

プロファイリングコントローラーをユーザに表示します。

BaseProfilingConfigクラスのpublicフィールド

項目

タイプ

説明

ProfilingControlKindenum ProfilingControlKind {None, Manual, Api}

プロファイリング制御方法を定義します。

  • None : 制御できません。

  • Manual : コントローラーウィンドウを介して制御します。

  • Api : APIによる制御

ProfilingTypeenum ProfilingType {Performance, Memory, Timeline}

プロファイリング方法を定義します。

  • Performance : パフォーマンスプロファイリング

  • Memory : メモリプロファイリング(dotMemoryプロファイラによって使用される)。

  • Timeline : タイムラインプロファイリング

PerformaceMeterKindenum PerformaceMeterKind {Rdtsc, PerformanceCounter, ThreadTime, ThreadCycleTime}

時間測定方法を定義します。

  • Rdtsc : リアルタイム(CPU命令)。

  • PerformanceCounter : リアルタイム(パフォーマンスカウンタ)

  • ThreadTime : スレッド時間

  • ThreadCycleTime : スレッドサイクルタイム

RedistDirstring

dotTrace SDK再配布可能ファイルの場所を定義します。デフォルトでは、それらは JetBrains.Profiler.Windows.Api.dll と同じフォルダー内で検索されます。

BaseSnapshotProfilingConfigクラスのpublicフィールド

項目

タイプ

説明

SaveDirstring

結果のスナップショットのパスとベースファイル名を定義します。この構成に必要です。

SnapshotFormatenum {Compressed, Uncompressed}

スナップショットのファイル形式を圧縮または非圧縮のいずれかで定義します。デフォルトでは、圧縮されています。

SaveSnapshotProfilingConfigクラスのpublicフィールド

項目

タイプ

説明

ListFilestring

プロファイリング中に収集されたスナップショットをリストするファイルのファイル名を定義します。この構成に必要です。
このファイルを手動で作成しないでください。プロファイリング中に自動的に作成されます!
SelfAttach.StateNone 状態になるまで、このファイルを開かないでください!

ExecutableSnapshotProfilingConfigクラスのpublicフィールド

項目

タイプ

説明

Executablestring

プロファイリングが完了した後に実行する実行可能ファイルへのパスを定義します。スナップショットのパスは、この実行可能ファイルにパラメータとして渡されます。この構成には必須です。

最終更新日: 2020年5月14日