ES モジュール アプリケーションでの Node.js エージェントの使用

ES モジュールを使用して Node.js アプリケーションのコードを管理している場合、Node.js エージェントを使用してそれらのアプリケーションを監視できるようになりました。

概要

v12.0.0 より前は、Node.js は、CommonJS モジュールを使用したコードの管理のみを公式にサポートしていました。CommonJS モジュールは、次の例のように、 module.exports } ステートメントとrequire()ステートメントを使用してコードを管理します。

'use strict'

const bar = require('./bar')

function echoBar() {
  console.log('this is bar:', bar)
}

module.exports = {
  echoBar
}

Node.js v12.0.0 以降、ECMAScript モジュール (ES モジュール/「ESM」) のサポートが追加されました。

require()とmodule.exportsの代わりに、ES モジュールはimportとexportステートメントを次のように使用します。

'use strict'

import bar from './bar.js'

export function echoBar() {
  console.log('this is bar:', bar)
}

ES モジュールは、コード管理のための ECMAScript の公式標準であり、ブラウザーやその他の JS ランタイムがパッケージを管理する標準的な方法です。進化する Node.js エコシステムを現在および将来的にサポートするために、エージェントは、エージェントのバージョン 9.1.0 の時点で、ES モジュールを使用して記述されたアプリケーションの計測をサポートします。Node.js APM エージェントは、CommonJS アプリケーションも引き続きサポートします。

エージェントのセットアップ

エージェントが ES モジュール アプリケーションを正常に計測するには、最初に Node.js エージェントをインストールする必要があります (インストール ドキュメントを参照)。エージェントをインストールしたら、以下のセクションの構成に進みます。

構成

アプリケーションで構成ファイルを使用してエージェントを構成する場合、構成ファイルの拡張子を.js } ではなく.cjsに更新する必要があります。

エージェントは CommonJS モジュールとして作成されます。 require()を使用して、起動時に構成ファイルを読み込みます。ファイル拡張子を変更することで、エージェントの構成ファイルを CommonJS モジュールとして明示的にラベル付けし、エージェントがそれを正常にロードできるようにします。

ファイル拡張子を更新しないと、エージェントの起動時に次のエラーが表示される場合があります。

New Relic for Node.js is disabled due to an error:
Error [ERR_REQUIRE_ESM]: require() of ES module /path/to/your/application/newrelic.js from /path/to/your/application/node_modules/newrelic/lib/config/index.js not supported.

ES モジュールローダーを追加する

エージェントが ES モジュール エコシステム内でインストルメンテーションを適切に適用するには、アプリケーションの呼び出しにエージェントとともにエージェントの ES モジュール ローダーを含める必要があります。Node.js --experimental-loader CLI 引数を使用してローダーをアプリケーションに追加できます。

$
node --experimental-loader newrelic/esm-loader.mjs -r newrelic your-program.js

カスタムインストゥルメンテーション

Node.js APMエージェントは、ES モジュール アプリケーションへのカスタムインストゥルメンテーションの追加をサポートします。 API上のほとんどのインストゥルメンテーション登録メソッドを使用して、ES モジュール アプリケーションでインストゥルメンテーションを作成できます。 ES モジュールのインポートの性質上、 newrelic.instrumentLoadedModuleをサポートすることはできません。 ES モジュール バインディングは割り当て可能ではないため、モジュールがロードされた後にエージェントがモジュールのエクスポートされたメンバーをインストゥルメンテーションに置き換えることができません。

ES モジュール アプリケーションでカスタムインストゥルメンテーションAPIを使用する方法のデモンストレーションを確認するには、GitHub の例を確認してください。

もっと詳しく知る

• Node.js ES モジュールのドキュメント
• Node.js パッケージのドキュメント
• ECMAScript 標準ドキュメント
• デモ ES モジュール アプリケーション