os.loadavg

関数の概要

os.loadavgは、Node.jsのosモジュールに含まれる関数の一つです。この関数は、システムの平均ロードアベレージ(CPUの使用率)を取得するために使用されます。ロードアベレージは、システムがどれくらいの負荷を抱えているかを示す指標であり、システムのパフォーマンスを監視するために役立ちます。

パラメータの説明

引数 用途
なし ロードアベレージの取得

戻り値

os.loadavgは、配列を返します。配列の要素は、1分間、5分間、15分間の平均ロードアベレージを示します。非同期で実行されるわけではなく、同期的に結果を返します。

使用例

以下は、os.loadavgを使用して平均ロードアベレージを取得するコード例です。


const os = require('os');
const loadavg = os.loadavg();
console.log(loadavg);

別の例として、ロードアベレージが特定の閾値を超えた場合にメッセージを出力するコードを示します。


const os = require('os');
const loadavg = os.loadavg();
if (loadavg[0] > 1.0) {
  console.log('High CPU load detected!');
}

関連する関数

  • os.cpus(): システムのCPU情報を取得する関数
  • os.freemem(): 空きメモリ量を取得する関数

まとめ

os.loadavgは、システムの負荷状況を把握するための重要な関数です。定期的にこの関数を呼び出すことで、システムのパフォーマンスをモニタリングし、適切な対策を取ることができます。ただし、ロードアベレージの解釈には注意が必要であり、単純に高い値が悪いというわけではありません。