Node.js 言語メトリクス (パブリックベータ)

この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。

最終更新日 2022年01月26日(水)

Node.js 言語メトリクス機能により、アプリケーション関連のメトリクス​内で表示される言語固有の時系列メトリクスが追加され、Node.js ランタイムの可視性が向上します。Node.js メトリクスには、Aggregate Time Spent in Garbage Collection (ガベジコレクションに費やされた合計時間)、Aggregate Garbage Collections (合計ガベジコレクション数)、Event Loop Latency (イベントループのレイテンシー)、Event Loop Usage (イベントループの使用状況) が含まれます。

この機能は現在、パブリックベータです。 フィードバックは、heroku-metrics-feedback@salesforce.com​ までメールでお送りください。

Node.js 言語メトリクスは、すべての有料 dyno (Hobby 以上) および Private Space で利用可能です。

全般的な情報

メトリクスの表示設定に関する全般的な情報は、言語ランタイムメトリクスの親ドキュメント​を参照してください。

はじめに

最初に、アプリケーションで Language Metrics (言語関連のメトリクス) フラグを有効にします​。これは、ダッシュボードまたは CLI を使用して実行できます。ダッシュボードから有効にするには、メトリクスの環境設定パネルを開き、Enhanced Language Metrics (詳細な言語関連のメトリクス) トグルと Node Language Metrics (Node 言語メトリクス) トグルの両方をオンにします。

言語メトリクスのトグル

Heroku CLI から有効にするには、次のようにします。

$ heroku labs:enable "runtime-heroku-metrics" -a "my-app-name"
$ heroku labs:enable "nodejs-language-metrics" -a "my-app-name"

Node.js のバージョンを確認する

Node.js メトリクスを使用するためには、Node v8.0.0 以降を実行している必要があります。ローカルマシンで使用しているバージョンは、次のように実行して確認できます。

$ node --version
v10.13.0

Heroku の Node buildpack によってインストールされるバージョンと異なる独自バージョンの Node.js をインストールしている場合、Node.js 言語メトリクスは動作しません。

再デプロイ

Enhanced Language Metrics 機能を有効にしたら、空のコミットを使用してアプリケーションを再デプロイします。

$ git commit --allow-empty -m "Enable Node.js Language Metrics"
$ git push heroku master

数分後、Application Metrics​ (アプリケーション関連のメトリクス) タブから表示できるメトリクスを受信し始めます。

使用可能なメトリクス

上記の手順が完了した後、これらのメトリクスが使用可能になるまでに数分かかることがあります。

Aggregate Time Spent in Garbage Collection (ガベージコレクションに費やされた合計時間)

このプロットは、現在のプロセスタイプのすべての dyno にわたる各ロールアップでガベージコレクションを実行するための (アプリの実行が停止される) 合計一時停止時間を追跡します。また、ガベージコレクターの実行中に費やされた、ロールアップ中の時間の割合 (%) も表示されます。 gcstop

Aggregate Garbage Collections (合計ガベージコレクション)

このプロットには、すべての dyno にわたって集計された GC コレクションの数が表示されます。 gcagg

Event Loop Latency (イベントループのレイテンシー)

Node の非同期モデルの中心にあるのがイベントループ​です。Node.js アプリはシングルスレッドであり、同時に 1 つのリクエストしか処理できませんが、データベースクエリのように非同期リクエストを実行するときは、スレッドがイベントループに戻されます。イベントループのレイテンシーは、イベントループに戻される前にコードが実行される時間を指します。イベントループのレイテンシーが大きいと、トラフィックが増加したときにアプリケーションをスケーリングすることが困難になる場合があります。

このプロットには、すべての dyno にわたって集計されたイベントループのレイテンシーが、中央値、95 パーセンタイル、99 パーセンタイル、最大レイテンシーとして表示されます。 イベントループのレイテンシーのグラフ

Event Loop Usage (イベントループの使用状況)

イベントループが作業によってブロックされている時間の割合 (%)。大きな割合は、アプリが高い負荷の下にあり、アンダープロビジョニングされる可能性があることを示している場合があります。

イベントループの使用状況のプロットには、イベントループの割合の使用状況に関連した、現在のプロセスタイプのすべての dyno にわたる各ロールアップ中に取得された観察値の最小、最大、平均が表示されます。 イベントループの使用状況のグラフ

メトリクス収集の無効化

Node.js メトリクスの収集を無効にするには、単純に Metrics Preferences パネルまたは次の CLI コマンドを使用して Enhanced Language Metrics トグルをオフに切り替えます。

$ heroku labs:disable "runtime-heroku-metrics" -a "my-app-name"