process.memoryUsage

関数の概要

process.memoryUsageはNode.jsにおいて現在のメモリ使用量を取得するための関数です。この関数を使用することで、プログラムのメモリ使用状況を把握し、メモリリークやパフォーマンスの問題を特定することができます。

パラメータの説明

パラメータ 用途
heapTotal Number ヒープ全体の割り当てメモリ量を示す
heapUsed Number ヒープセグメントに割り当てられたメモリ量を示す
rss Number Resident Set Size(RSS)メモリの使用量を示す

戻り値

戻り値はオブジェクト型で、各プロパティにメモリ使用量がキーバリュー形式で格納されています。同期的に処理されるため、即座に値を取得できます。

使用例

以下に、process.memoryUsageの使用例を示します。


const memUsage = process.memoryUsage();
console.log(memUsage);

非同期処理中にメモリ使用量を確認する例:


setInterval(() => {
  console.log(process.memoryUsage());
}, 1000);

関連する関数

  • process.cpuUsage: CPU使用量を取得する関数
  • os.totalmem: システム全体のメモリ量を取得する関数

まとめ

process.memoryUsageは現在のメモリ使用量を取得し、プログラムのメモリ管理を助けるための便利な関数です。定期的に使用量を監視することで、メモリ関連の問題を事前に発見し、パフォーマンスを向上させることができます。