Node.js アプリケーションのプロファイリング

このページでは、プロファイリング データを収集し、そのデータを Google Cloud プロジェクトに送信するように Node.js アプリケーションを変更する方法について説明します。プロファイリングの全般的な情報については、プロファイリングのコンセプトをご覧ください。

Node.js のプロファイル タイプ:

  • ヒープ
  • 経過時間

サポートされる Node.js 言語バージョン:

  • 10.4.1 以降(10.x バージョン ブランチ)
  • 12.0.0 以降(12.x バージョン ブランチ)
  • 14.0.0 以降(14.x バージョン ブランチ)
  • Node.js のリリース ポリシーについては、リリースをご覧ください。

サポートされているプロファイリング エージェントのバージョン:

  • エージェントの最新リリースがサポートされています。一般に、1 年を超える期間が経過したリリースはサポートされません。エージェントの最新リリース バージョンを使用することをおすすめします。

サポートされているオペレーティング システム:

  • Linux。Node.js アプリケーションのプロファイリングは、標準 C ライブラリが glibc または musl で実装されている Linux カーネルでサポートされています。Linux Alpine カーネルに固有の構成情報については、Linux Alpine で実行するをご覧ください。

サポートされる環境:

Profiler API を有効にする

プロファイリング エージェントを使用する前に、基盤となる Profiler API が有効になっている必要があります。Google Cloud CLI または Google Cloud Console のいずれかを使用して、API のステータスを確認し、必要に応じて有効にできます。

gcloud CLI

  1. ワークステーションに Google Cloud CLI がまだインストールされていない場合は、Google Cloud CLI のドキュメントをご覧ください。

  2. 次のコマンドを実行します。

    gcloud services enable cloudprofiler.googleapis.com
    

詳細については、gcloud services をご覧ください。

Cloud Console

  1. [API とサービス] ダッシュボードに移動します。

    [API とサービス] に移動

  2. API へのアクセスで使用するプロジェクトを選択します。

  3. [API とサービスを有効化] ボタンをクリックします。

    API とサービスの追加

  4. Profiler API を検索します。

  5. 検索結果で、[Cloud Profiler API] を選択します。

    [Cloud Profiler API] が表示されない場合は、[Stackdriver Profiler API] を選択します。

  6. [API が有効です] が表示されている場合、API はすでに有効になっています。そうでない場合は、[有効にする] ボタンをクリックします。

Cloud Profiler の使用

サポートされているすべての環境で Profiler を使用するには、パッケージ @google-cloud/profiler をインストールし、アプリケーションに require ステートメントを追加してから、通常の方法でアプリケーションをデプロイします。

@google-cloud/profiler をインストールする前に

パッケージ @google-cloud/profiler はネイティブ モジュールに依存しています。このネイティブ モジュールのビルド済みバイナリは、サポートされているすべての言語とプラットフォームの組み合わせで使用できます。どのビルド済みバイナリをインストールするかを決定するのに、@google-cloud/profilernode-pre-gyp を使用します。

インストール

Cloud Profiler の最新バージョンをインストールするには、次の操作を行います。

    npm install --save @google-cloud/profiler

Trace エージェントも使用している場合は、アプリケーションを変更するときに、Trace エージェント パッケージ(@google-cloud/trace-agent)の後に Profiler パッケージをインポートします。詳細については、Node.js 用の Cloud Trace の設定をご覧ください。

Compute Engine

Compute Engine の場合は、次の操作を行います。

  1. Cloud Profiler の最新バージョンをインストールします。

    npm install --save @google-cloud/profiler
    
  2. アプリケーションの require コードを変更して、serviceContext オブジェクトを作成します。このオブジェクトにより、プロファイリングされるサービスの名前を service に割り当てます。必要に応じて、プロファイリングするサービスのバージョンを version に割り当てることができます。これらの構成オプションの詳細については、サービス名とバージョンの引数をご覧ください。

    require('@google-cloud/profiler').start({
      serviceContext: {
        service: 'your-service',
        version: '1.0.0',
      },
    });

GKE

GKE の場合は、次の操作を行います。

  1. Dockerfile を変更して Profiler パッケージをインストールします。

    FROM node:10
    ...
    RUN npm install @google-cloud/profiler
    
  2. アプリケーションの require コードを変更して、serviceContext オブジェクトを作成します。このオブジェクトにより、プロファイリングされるサービスの名前を service に割り当てます。必要に応じて、プロファイリングするサービスのバージョンを version に割り当てることができます。これらの構成オプションの詳細については、サービス名とバージョンの引数をご覧ください。

    require('@google-cloud/profiler').start({
      serviceContext: {
        service: 'your-service',
        version: '1.0.0',
      },
    });

App Engine

App Engine フレキシブル環境と App Engine スタンダード環境の場合、require コードは次のようになります。

require('@google-cloud/profiler').start();

App Engine では、service パラメータと version パラメータは環境から取得されるため、これらを指定する必要はありません。したがって、serviceContext オブジェクトを作成する必要はありません。

データの分析

Profiler が収集したデータを Profiler のインターフェースに表示し、分析できます。このインターフェースの開始方法については、Profiler インターフェースを開くをご覧ください。

サービス名とバージョンの引数

Profiler エージェントを読み込むときに、service-name 引数とオプションの service-version 引数を指定して構成します。

Profiler は、サービス名で指定されたサービスのすべてのレプリカからプロファイリング データを収集します。Profiler サービスは、サービス バージョンとゾーンの組み合わせに対して、1 つのサービス名について平均で 1 分あたり 1 個のプロファイルを作成します。

たとえば、1 つのサービスの 2 つのバージョンが 3 つのゾーンのレプリカで実行されている場合、Profiler はそのサービスについて 1 分あたり平均で 6 個のプロファイルを作成します。

レプリカで異なるサービス名を使用している場合、サービスが必要以上にプロファイリングされるため、オーバーヘッドが大きくなります。

サービス名を選択する場合は、次の点に注意してください。

  • アプリケーション アーキテクチャでサービスを明確に識別できる名前を選択してください。1 つのサービスまたはアプリケーションしか実行していない場合、どのようなサービス名を選択するかはさほど問題になりません。しかし、アプリケーションが一連のマイクロサービスとして実行されている場合は、名前の選択が重要になります。

  • service-name 文字列で、プロセス ID などのプロセス固有の値を使用しないでください。

  • service-name 文字列は次の正規表現と一致する必要があります。

    ^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$

サービス名として imageproc-service のような静的な文字列を使用することをおすすめします。

サービス バージョンは省略可能です。サービス バージョンを指定すると、複数のインスタンスからプロファイリング情報が集約され、バージョンごとに表示されます。これは、複数のバージョンがデプロイされているときの識別に役立ちます。Profiler UI では、データをサービス バージョンでフィルタできます。これにより、コードの新旧バージョンのパフォーマンスを比較できます。

service-version 引数には、自由形式の文字列を指定できますが、通常は、バージョン番号のような値を使用します(例: 1.0.02.1.2)。

エージェント ロギング

プロファイリング エージェントには、ロギング情報を出力する機能があります。ロギングを有効にするには、エージェントの起動時に logLevel オプションを設定します。サポートされている logLevel 値は次の通りです。

  • 0: すべてのエージェント ロギングを無効にします。
  • 1: エラーロギングを有効にします。
  • 2: 警告ロギングを有効にします(デフォルト)。
  • 3: 情報ロギングを有効にします。
  • 4: デバッグ ロギングを有効にします。

サービス コンテキストを提供する同じオブジェクトに logLevel 値を設定します。

require('@google-cloud/profiler').start({
    serviceContext: { ... }
    logLevel:       3
});

Linux Alpine で実行する

Linux Alpine 用の Node.js プロファイリング エージェントは、Google Kubernetes Engine の構成でのみサポートされています。

Linux Alpine で Docker イメージ(golang:alpinealpine など)を使用すると、次の認証エラーが表示されることがあります。

connection error: desc = "transport: authentication handshake failed: x509: failed to load system roots and no roots provided"

エラーの詳細を確認するには、エージェント ロギングを有効にする必要があります。

上記のエラーは、Linux Alpine の Docker イメージに、デフォルトでインストールされているはずのルート SSL 証明書がないことを示しています。これらの証明書は、プロファイリング エージェントが Profiler API と通信するために必要になります。このエラーを解決するには、次の apk コマンドを Dockerfile に追加します。

FROM alpine
...
RUN apk add --no-cache ca-certificates

その後、アプリケーションを再度ビルドし、デプロイする必要があります。

既知の問題

Node.js のプロファイリング エージェントが原因でプログラムが通常どおり終了しません。プログラムのすべてのタスクが完了してからプログラムが終了するまでに、最大で 1 時間ほどかかります。Ctrl-C などを使用して SIGINT を発行した場合は、プロセスが正常に終了します。

次のステップ

Cloud Profiler インターフェースの使用で Profiler のグラフとコントロールについて確認します。詳細については、以下をご覧ください。