【Node.js24.x】PerformanceMeasure::PerformanceMeasure()関数の使い方
PerformanceMeasure関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
PerformanceMeasure関数は、Node.jsの組み込みパフォーマンスAPIの一部として、特定の処理区間の実行時間を計測し、その計測結果を表すPerformanceMeasureオブジェクトを生成する関数です。この関数は、主にアプリケーションのパフォーマンス分析やボトルネックの特定を目的として使用されます。
PerformanceMeasure関数は、計測の名前、そして計測の開始点と終了点を示す引数を受け取ります。引数には、開始マークの名前と終了マークの名前を個別に指定する方法や、これらをまとめたオプションオブジェクトを渡す方法があります。例えば、new PerformanceMeasure(name, startMark, endMark)のように呼び出すことで、指定された名前の計測オブジェクトを作成できます。
生成されたPerformanceMeasureオブジェクトは、計測の名前 (name)、処理の開始時刻 (startTime)、終了時刻 (endTime)、そして処理にかかった時間 (duration) などの詳細な情報を含んでいます。これらの情報は、performance.mark()で設定されたマーク間の時間を効率的に測定し、ログ出力やデバッグに活用することが可能です。システムエンジニアを目指す方々にとって、アプリケーションの性能を客観的に評価し改善する上で非常に重要なツールとなります。
構文(syntax)
1new PerformanceMeasure('my-measurement', { start: 'my-start-mark', end: 'my-end-mark' });
引数(parameters)
skipThrowSymbol=undefined, name=undefined, type=undefined, start=undefined, duration=undefined
- skipThrowSymbol: boolean = undefined: true を指定すると、エラー発生時に例外をスローしません。
- name: string = undefined: パフォーマンス測定の識別子となる名前を指定します。
- type: string = undefined: パフォーマンス測定のタイプを指定します。
- start: number = undefined: パフォーマンス測定の開始時間をミリ秒単位で指定します。
- duration: number = undefined: パフォーマンス測定の所要時間をミリ秒単位で指定します。
戻り値(return)
PerformanceMeasure
PerformanceMeasureオブジェクトを生成し、パフォーマンス測定の開始を記録するために使用します。このオブジェクト自体が戻り値となります。