Node.jsエージェントの更新

New Relic エージェントはセマンティックバージョニングに従って、メジャーバージョンリリースに重大な変更が含まれていることを示します。メジャーバージョンでは、メンテナーの規定によりサポート終了となった言語ランタイムのサポートが中止される場合があります。さらに、メジャーバージョンではサポートが終了し、特定の計装が削除される場合があります。

New Relic の最新の機能、拡張機能、重要なセキュリティパッチを最大限に活用するために、Node.js エージェントを最新バージョンにアップデートすることをお勧めします。特定のエージェントのアップデートに関する詳細については、 Node.js エージェントのリリースノートを参照してください。リリースノートには、該当する場合にはダウンロードリンクと、最新バージョンをダウンロードしてインストールするための手順が記載されています。

newrelicモジュールがpackage.jsonにリストされている場合は、 npm installを実行します。
newrelicモジュールのみをターゲットにする場合は、 npm update newrelicを実行します。

推奨事項: 更新されたバージョンを本番環境に移行する前にテストしてください。問題が発生した場合は、Node.js エージェントのトラブルシューティング手順に従ってください。

エージェントをアンインストールして特定のバージョンのエージェントをインストールする必要がある場合は、このアンインストールガイドに従ってから、 npm install newrelic@LIST_VERSION_HEREを使用して特定のバージョンのエージェントを再インストールするか、package.json でバージョンを更新してnpm installを実行します。

Node.jsエージェントバージョン14へのアップグレード

Node.jsバージョン14にアップグレードする前に、主な変更点についてこの情報を確認してください。

Major changes with Node.js agent v14	Comments
BREAKING: Node.js 20のサポートを終了しました。	詳細については、当社のサポートポリシーをご覧ください。
BREAKING：`@apollo/server`の計装をプラグイン`@newrelic/apollo-server-plugin`から従来の計装に移行しました。	Apollo serverユーザーは、`@newrelic/apollo-server-plugin`をインストールして使用する必要がなくなります。計装は、すべてのapollo serverインスタンスに自動的に適用されます。詳細については、Apollo Server移行ガイドを参照してください。
BREAKING：`koa-router`および`koa-route`の計装は削除。
BREAKING：ライセンス、アプリケーション、およびセキュリティポリシーのサポートを削除しました（`LASP`）。	この機能は非推奨となり、`config.security_policies_token`で設定可能でした。
BREAKING: クロスアプリケーショントレース（`CAT`）機能のサポートを削除しました。	CATはエージェントv8.4.0で非推奨となり、サービス間でコンテキストを伝播するためにディストリビューティッド（分散）トレーシングに置き換えられました。
BREAKING: デフォルトで`config.distributed_tracing.exclude_newrelic_header`が`true`に設定されるように更新されました。	これはデフォルトでW3Cヘッダーに置き換えられました。
BREAKING：rest パラメーターを採用するため、`shim.argsToArray`APIメソッドを削除しました。
BREAKING：`shim.prefixRouteParameters`APIメソッドを削除しました。	Fastify計装はトレースチャネル診断を使用するように更新されたため、このメソッドは不要になりました。
BREAKING: `mysql`および`mysql2`の静的`MySQL` `Pool#query`セグメントをドロップしました。	`Database/*`セグメントの方が有用であるため、これにより不要なセグメントが作成されました。
BREAKING: 以下のライブラリのサポートされる最小バージョンを更新しました：	`@nestjc/cli` および`@nestjs/core`を10.0.0に `bluebird` 3.0.0へ `mysql2` 3.0.0へ `next` 14.0.0へ `cassandra-driver` ～4.0.0 `fastify` ～4.0.0
専有時間とトレースの合計時間の計算方法を更新しました。

Apollo Server移行ガイド

エージェントの14.0.0以降、apollo serverの顧客は@newrelic/apollo-server-pluginをインストールして使用する必要がなくなります。計装はすべてのapollo serverインスタンスに自動的に適用されます。ただし、顧客がプラグインを設定した場合、移行計画の詳細が記載されます。

プラグイン設定

const createPlugin = require('@newrelic/apollo-server-plugin')
const plugin = createPlugin({
  captureScalars: true,
  captureIntrospectionQueries: true,
  captureServiceDefinitionQueries: true,
  captureHealthCheckQueries: true,
  captureFieldMetrics: true,
  customResolverAttributes: () => { return { exampleAttribute: 'exampleValue' }},
  customOperationAttributes: () => { return { exampleAttribute: 'exampleValue' }}
})

エージェントの設定

captureScalars 現在はconfig.apollo_server.scalarsまたは NEW_RELIC_APOLLO_SERVER_SCALARS
captureIntrospectionQueries 現在はconfig.apollo_server.introspection_queriesまたは NEW_RELIC_APOLLO_SERVER_INTROSPECTION_QUERIES
captureServiceDefinitionQueries 現在はconfig.apollo_server.service_definition_queriesまたは NEW_RELIC_APOLLO_SERVER_SERVICE_DEFINITION_QUERIES
captureHealthCheckQueries 現在はconfig.apollo_server.health_check_queriesまたは NEW_RELIC_APOLLO_SERVER_HEALTH_CHECK_QUERIES
captureFieldMetrics 現在はconfig.apollo_server.field_metricsまたは NEW_RELIC_APOLLO_SERVER_FIELD_METRICS

APIコール

オペレーションセグメントまたはリゾルバセグメントのいずれかにキーの値をカスタムアトリビュートとして追加するために呼び出される関数を登録する、以前の2つの設定がありました。エージェントは、顧客がAPIメソッドを介してコールバックを登録できるパターンに従っており、これら2つのユースケースはそれに当てはまります。

customOperationAttributes

現在はnewrelic.setApolloOperationAttributesCallbackです。コールバックを受け取り、存在する場合、コールバックには以前と同じ引数が渡されます。 requestContext

前:

createPlugin({
  customOperationAttributes: (requestContext) => { 
    return {
      clientName: requestContext.request.http.headers.get('graphql-client-name')
    }
  }
})

現在:

function operationAttributes(requestContext) {
  return {
    clientName: requestContext.request.http.headers.get('graphql-client-name')
  }
}
newrelic.setApolloOperationAttributesCallback(operationAttributes)

customResolverAttributes

現在はnewrelic.setApolloResolverAttributesCallbackです。コールバックを受け取り、存在する場合、コールバックには以前と同じ引数が渡されます。 { source, args, contextValue, info }

前:

createPlugin({
  customResolverAttributes: ({ source, args, context, info }) => { 
    return {
      allArgs: Object.keys(args).join(','),
      returnType: info.returnType.name,
      sourceBranch: source?.branch
      stage: context.event.requestContext.stage
    }
  }
})

現在:

function customResolverAttributes({ source, args, contextValue, info }) {
  return {
    allArgs: Object.keys(args).join(','),
    returnType: info.returnType.name,
    sourceBranch: source?.branch
    stage: contextValue.event.requestContext.stage
  }
}
newrelic.setApolloResolverAttributesCallback(customResolverAttributes)

Node.jsエージェントバージョン 13 にアップグレードする

Node.js バージョン 13 にアップグレードする前に、主な変更点についてこの情報を確認してください。

Major changes with Node.js agent v13	Comments
BREAKING: Node.js 18 のサポートを廃止しました。	詳細については、当社のサポートポリシーをご覧ください。
BREAKING: `fastify`の最小サポートバージョンを 3.0.0 に更新しました。`pino`を 8.0.0 に、 `koa-router`を 12.0.0 にアップグレードします。
新しいAWS Bedrock API を使用して AI モニタリングの互換性ドキュメントを更新しました

Node.jsエージェントバージョン 12 にアップグレードする

Node.js バージョン 12 にアップグレードする前に、主な変更点についてこの情報を確認してください。

kafkajs 計装にプロデューサーとコンシューマーのメトリクスを追加しました

MySQL``host:portメトリクスが記録されていることを確認しました

Major changes with Node.js agent v12	Comments
BREAKING: Node.js 16 のサポートを廃止しました。	詳細については、当社のサポートポリシーをご覧ください。
BREAKING: レガシーコンテキストマネージャーを削除しました。
BREAKING: `redis <2.6.0`のサポートが削除されました。
BREAKING: `director`の計装を削除しました。
BREAKING: バージョン 2 と 3 のサポートを終了するために`mongodb`計装を更新しました。
amqplib スパンに server.address を追加しました。
次の計装をエージェントに移行しました。	`@newrelic/next`経由でNext.js計装をロードする必要はなくなりました。代わりに、 `NODE_OPTIONS='-r newrelic' next start`経由でエージェントをロードする必要があります。
`@newrelic/native-metrics`を 11.0.0 に更新しました

Node.js エージェントバージョン 11 へのアップグレード

Node.js バージョン 11 にアップグレードする前に、大きな変更点がないかこの情報を確認してください。

Major changes with Node.js agent v11	Comments
Node.js 20 の公式パリティサポートを追加しました。
BREAKING: Node.js 14 のサポートを廃止しました。	詳細については、当社のサポートポリシーをご覧ください。
BREAKING: ESM ローダーを更新して Node.js 20 をサポートしました。	アプリケーションを実行するときは、 `--experimental-loader` 引数と `-r` 引数の両方を使用する必要があります。 `node --experimental-loader newrelic/esm-loader.mjs -r newrelic path/to/app.js`
BREAKING: デフォルトのコンテキストマネージャーを AsyncLocalContextManager に更新しました。	以前のデフォルトの LegacyContextManager は、 `config.feature_flag.legacy_context_manager` の機能フラグを `true`に設定することで復元できます。環境変数を使用したい場合は、 `NEW_RELIC_FEATURE_FLAG_LEGACY_CONTEXT_MANAGER` を `true`に設定できます。このコンテキストマネージャーは将来のバージョンでは削除される予定であることに注意してください。この従来のコンテキストマネージャーの使用に戻す必要がある場合は、 New Relic サポートまたは GitHub の問題に報告してください。
BREAKING: `shim.handleCATHeaders`の名前を`shim.handleMqTracingHeaders`に変更しました。
New Relic の依存関係を、Node.js バージョンのサポートが更新されたバージョンに更新する	@newrelic/aws-sdk v7.0.0 @newrelic/koa v8.0.0 @newrelic/native-metrics v10.0.0 @newrelic/スーパーエージェント v7.0.0 @newrelic/test-utilities v8.0.0

Node.jsバージョンのサポート

Node.js 16 は、New Relic Node.js v11 エージェントでサポートされる最も古いバージョンです。Node.js 14 および 15 は v11 ではサポートされていません。Node.js 15 以前を実行しているお客様には、次の 2 つのオプションがあります。

サポートされているバージョンの Node.js にアップグレードし、New Relic Node.js v11 エージェントの新機能を活用してください。
New Relic Node.js v10 エージェントを使用し続けますが、エージェントバージョンの更新でのみ利用できる新機能は使用できません。

ヒント

できるだけ早く Node.js の新しいバージョンにアップグレードしてください。New Relic Node.js エージェントの次のメジャーバージョンでは、Node.js 16 のサポートが削除される可能性があります。

Node.js エージェントバージョン 10 へのアップグレード

Node.js バージョン 10 にアップグレードする前に、大きな変更点がないかこの情報を確認してください。

Major changes with Node.js agent v11	Comments
同じ解決された moduleName に対して複数のインストルメンテーションフック (onRequire、onResolved) を登録する機能が追加されました。	これは最初からエージェントの制限でした。 API を使用して api.instrument、api.instrumentDatastore、api.instrumentWebframework、api.instrumentMessages、または api.instrumentConglomerate を計測した場合、既存の計測フックがオーバーライドされます。その結果、Node.js エージェントが設計どおりに機能しなくなります。
BREAKING: `config.transaction_tracer.record_sql`のデフォルトをオフから難読化に更新しました。つまり、SQL ステートメントはキャプチャされますが、難読化されます。
BREAKING: ルート (URL) 構造体は、トランザクション、ルートセグメント、およびスパンの`request.parameters.route.*`属性として保存されるようになりました。	クエリパラメーターは、request.parameters.* というプレフィックスが付いた属性として使用できます。トランザクションとスパンについて。ルートパラメーターは、request.parameters.route.* というプレフィックスが付いた属性として使用できます。トランザクションとスパンについて。ルートパラメーター (別名 URL パラメーター) はさまざまな Web フレームワークの共通機能であり、API ルート定義の一部としてプレースホルダーを作成できます。
BREAKING: WebFrameworkShim クラスから captureUrlParams を削除しました。
DEPRECATION NOTICE: 複数回ラップされたアイテムをアンラップしようとすると、shim.unwrap と shim.unwrapOnce は機能しなくなります。	これは、同じモジュールを複数回インストゥルメントできるようになったので、登録されているすべてのインスツルメンテーションを破壊せずに安全にラップを解除することができないためです。次のメジャーリリースでは shim.unwrap と shim.unwrapOnce を削除する予定です。
New Relic の依存関係を、Node.js バージョンのサポートが更新されたバージョンに更新する	@newrelic/aws-sdk v7.0.0 @newrelic/koa v8.0.0 @newrelic/native-metrics v10.0.0 @newrelic/スーパーエージェント v7.0.0 @newrelic/test-utilities v8.0.0

Node.jsバージョンのサポート

Node.js 14 は、New Relic Node.js v10 エージェントでサポートされる最も古いバージョンです。Node.js 12 および 13 は v10 ではサポートされていません。Node.js 13 以前を実行しているお客様には、次の 2 つのオプションがあります。

サポートされているバージョンの Node.js にアップグレードし、New Relic Node.js v10 エージェントの新機能を活用してください。
アップデートエージェントバージョンでのみ利用可能な新機能を使用する機能なしで、New Relic Node.js v8 エージェントにとどまります。

ヒント

できるだけ早く Node.js の新しいバージョンにアップグレードしてください。New Relic Node.js エージェントの次のメジャーバージョンでは、Node.js 14 のサポートが削除される可能性があります。

Node.js エージェントバージョン 9 にアップグレードする

Node.js バージョン 9 にアップグレードする前に、主な変更点についてこの情報を確認してください。

Major changes with Node.js agent v9	Comments
Node.js 18 の公式パリティサポートが追加されました。
BREAKING: Node.js 12 のサポートを廃止しました。	詳細については、当社のサポートポリシーをご覧ください。
BREAKING: エージェントは、「証明書」設定 (通常はプロキシを使用) を使用するときに、 New Relic証明書バンドルを自動的に含めなくなりました。	「証明書」構成 (通常はプロキシを使用) を使用する場合、エージェントには New Relic 証明書バンドルが含まれなくなりました。これにより現在の環境が破壊される場合は、Mozilla から提供されているような CA バンドルを入手することをお勧めします。
BREAKING: エージェントは、仕様およびその他のエージェントに準拠するために、ポート443への外部HTTPSリクエストを行う際にポートを除外するようになりました。	デフォルトの HTTPS ポートを使用する場合、以前の外部セグメントは`External/example.com:443`という名前になります。外部セグメントの名前は`External/example.com`になります。
BREAKING: `await_support`機能フラグを介して非同期フックベースの Promise コンテキスト追跡を無効にする機能が削除されました。これにより、レガシープロミスインストゥルメンテーションも削除されます。	`await_support`機能フラグをリリースしました。エージェントは、async_hooks に依存して async promise の伝播を追跡するようになりました。最終的な結果は、 `feature_flag.await_support`を false に設定した場合、レガシーインストルメンテーションは promise チェーン内のすべての関数を個別のセグメントとして追跡します。
BREAKING: 廃止されたoracle npm パッケージのインストゥルメンテーションを削除しました。
BREAKING: `pg`の最小バージョンを 8.2.x に更新しました。これは、Node.js 14 以降で実行される最も古いサポートバージョンです。
BREAKING: hapi の最小サポートバージョンを v20.0.0 に更新しました。	v20.0.0 より前のすべてのバージョンは、セキュリティ上の理由から、hapi によって非推奨になっています。サポートポリシーを参照してください。
New Relic の依存関係を、Node.js バージョンのサポートが更新されたバージョンに更新する	@newrelic/aws-sdk v5.0.0 @newrelic/koa v7.0.0 @newrelic/native-metrics v9.0.0 @newrelic/superagent v6.0.0 @newrelic/test-utilities v7.0.0

Node.jsバージョンのサポート

Node.js 14 は、New Relic Node.js v9 エージェントでサポートされている最も古いバージョンです。Node.js 12 および 13 は v9 ではサポートされていません。Node.js 13 以前を実行しているお客様には、次の 2 つのオプションがあります。

サポートされているバージョンの Node.js にアップグレードして、New Relic Node.js v9 エージェントの新機能を活用してください。
アップデートエージェントバージョンでのみ利用可能な新機能を使用する機能なしで、New Relic Node.js v8 エージェントにとどまります。

ヒント

Node.jsエージェントバージョン8へのアップグレード

Node.jsのバージョン8にアップグレードする前に、主要な変更点についてこの情報を確認してください。

Major changes with Node.js agent v8	Comments
Node.js 16 の公式パリティサポートが追加されました。
BREAKING: Node.js v10.x のサポートを廃止しました。	詳細については、当社のサポートポリシーをご覧ください。
BREAKING: 機能フラグとして`serverless_mode`を削除しました。	標準の`serverless_mode`構成はまだ存在します。
BREAKING: 'certificates' 設定 (通常はプロキシを使用) を使用する場合、エージェントにはNew Relic証明書バンドルが自動的に含まれなくなりました。	これにより現在の環境が壊れていることがわかった場合は、機能フラグを利用して、この機能を一時的に復元できます。構成例: `feature_flag: { certificate_bundle: true }` 。この場合、Mozilla などの環境用の証明書バンドルを取得することをお勧めします。New Relic バンドルと機能フラグは、次のメジャーリリースで完全に削除されます。 config.feature_flags.certificate_bundleのデフォルトをfalseに設定しました。
New Relic Dependencies を更新された Node.js バージョンのサポートを含むバージョンに更新する	@newrelic/aws-sdk v4.0.1 @newrelic/koa v6.0.1 @newrelic/native-metrics v7.0.1 newrelic/superagent v5.0.1 @newrelic/test-utilities v6.0.0

Node.jsバージョンのサポート

Node.js v12 は、New Relic Node.js v8 エージェントでサポートされている最も古いバージョンです。Node.js 10 および 11 は v8 ではサポートされていません。Node.js 11 以前を実行しているお客様には、次の 2 つのオプションがあります。

サポートされているバージョンの Node.js にアップグレードして、New Relic Node.js v8 エージェントの新機能を活用してください。
New Relic Node.js v7エージェントのままでは、エージェントのバージョンを更新した場合にのみ利用できる新機能を使用することができません。

ヒント

できるだけ早く Node.js の新しいバージョンにアップグレードしてください。New Relic Node.js エージェントの次のメジャーバージョンでは、Node.js 12 のサポートが削除される可能性があります。

Node.jsエージェントバージョン7へのアップグレード

Node.jsのバージョン7にアップグレードする前に、主要な変更点についてこの情報を確認してください。

Major changes with Node.js agent v7	Comments
BREAKING 非推奨の`httpResponseCode` 、 `response.status` 、 `httpResponseMessage` HTTP レスポンス属性を削除しました	v6.4.2-v6.14.0: エージェント v6.4.2 以降、これらの属性は非推奨としてマークされましたが、新しい属性への移行期間を設けるために残されました。 v7: http 応答属性レポートが有効になっている場合、 `http.statusCode`と`http.statusText`レポートされます。
BREAKING 非推奨の`setIgnoreTransaction` API メソッドを削除しました	v5 - v6: エージェント v5.0.0 以降、このメソッドは非推奨としてマークされましたが、新しいメソッドへの移行期間を設けるために残されました。 v7: アプリケーションは API メソッド`transactionHandle.ignore()`を使用する必要があります。
BREAKING `api.custom_parameters_enabled`設定項目と関連する環境変数`NEW_RELIC_API_CUSTOM_PARAMETERS`を削除しました。	`newrelic.addCustomAttribute`と`newrelic.addCustomAttributes`を有効にするには、アプリケーションは設定`api.custom_attributes_enabled`または関連する環境変数`NEW_RELIC_API_CUSTOM_ATTRIBUTES`を使用する必要があります。
BREAKING 非推奨のディストリビューティッド（分散）トレーシングAPIメソッド`createDistributedTracePayload()`と `acceptDistributedTracePayload()`	v6.4.0-v6.14.0: エージェント v6.4.0 以降、これらのメソッドは非推奨としてマークされましたが、新しいメソッドへの移行期間を設けるために残されました。 v7: アプリケーションは API メソッド`transactionHandle.insertDistributedTraceHeaders(headers)`と`transactionHandle.acceptDistributedTraceHeaders(transportType, headers)` を使用する必要があります。これらのメソッドを使用すると、Node.js エージェントは、`transactionHandle.acceptDistributedTraceHeaders(headers)` を呼び出すときに W3C の `traceparent` ヘッダーと `tracestate` ヘッダーを受け入れ、`transactionHandle.insertDistributedTraceHeaders(headers)` を呼び出すときにNew Relic （分散）トレーシングヘッダーとともに W3C ヘッダーを含めるようになります。ただし、 New Relicヘッダー形式が`distributed_tracing.exclude_newrelic_header:true` を使用して無効になっている場合を除きます。
New Relic Dependencies を更新された Node.js バージョンのサポートを含むバージョンに更新する	@newrelic/aws-sdk v3.0.0 @newrelic/koa v5.0.0 @newrelic/native-metrics v6.0.0 @newrelic/superagent v4.0.0 @newrelic/test-utilities v5.0.0

Node.jsバージョンのサポート

Node.js v10 は、New Relic Node.js v7 エージェントでサポートされている最も古いバージョンです。Node.js 8 および 9 は v7 ではサポートされていません。Node.js 9 以前を実行しているお客様には、次の 2 つのオプションがあります。

サポートされているバージョンの Node.js にアップグレードして、New Relic Node.js v7 エージェントの新機能を活用してください。
New Relic Node.js v6 エージェントのままでは、エージェントのバージョンを更新したときにのみ利用できる新機能を使用できません。

Node.js 10 は更新を受け取りません。できるだけ早く Node.js の新しいバージョンにアップグレードしてください。Node.js 10 のサポートは、New Relic Node.js エージェント v8 で廃止されました。

Node.jsエージェントバージョン6へのアップグレード

Node.jsエージェント・バージョン6にアップグレードする前に、主要な変更点についてこの情報を確認してください。

Major changes with Node.js agent v6	Comments
Koaフレームワークの公式計測モジュールをv3.0.0にアップグレードしました。	v6: @koa/router v8.0.2 までのサポートが追加されました。 @koa/router v8.0.3 以降は現在サポートされていません。 v6: Node.js v12 のサポートが追加され、Node.js v6、7、9 のサポートが削除されました。サポートされる最小バージョンは Node.js v8 です。また、GithubにあるNew Relicの Koa Release Notesもご覧ください。。
非推奨の`max_samples_per_minute`構成パラメーターを削除しました。これは`max_samples_stored`動作に置き換えられました	v1 - v5: `max_samples_per_minute` エージェントが 1 分間に収集するイベントの最大数を定義します。アプリケーションが以前に上限として`max_samples_per_minute`を使用していた場合、サーバー上でデータがドロップされないように、閾値を有効な最大値まで下げる必要がある場合があります。 10k未満をお勧めします。 v5: エージェント v5 以前では、 `max_samples_stored` 、エージェントがNew Relic コレクターと通信できない場合に保存するイベントの最大数を定義しました。 v6: `max_samples_stored`の新しい動作は、エージェントが 1 分あたりに収集するイベントの最大数を定義します。この数を超える場合、エージェントは統計サンプルを収集します。この設定の使用方法は、他のAPMエージェントと一致しています。 Troubleshooting tips: イベントデータが不足している場合は、 `max_samples_stored`の値を増やすか、デフォルト値に戻します。 `max_samples_stored`の値は 10,000 を超えてはなりません。

Major changes with Node.js agent v6

Comments

Koaフレームワークの公式計測モジュールをv3.0.0にアップグレードしました。

v6: @koa/router v8.0.2 までのサポートが追加されました。 @koa/router v8.0.3 以降は現在サポートされていません。
v6: Node.js v12 のサポートが追加され、Node.js v6、7、9 のサポートが削除されました。サポートされる最小バージョンは Node.js v8 です。
また、GithubにあるNew Relicの Koa Release Notesもご覧ください。。

非推奨のmax_samples_per_minute構成パラメーターを削除しました。これはmax_samples_stored動作に置き換えられました

v1 - v5: max_samples_per_minute エージェントが 1 分間に収集するイベントの最大数を定義します。アプリケーションが以前に上限としてmax_samples_per_minuteを使用していた場合、サーバー上でデータがドロップされないように、閾値を有効な最大値まで下げる必要がある場合があります。 10k未満をお勧めします。
v5: エージェント v5 以前では、 max_samples_stored 、エージェントがNew Relic コレクターと通信できない場合に保存するイベントの最大数を定義しました。
v6: max_samples_storedの新しい動作は、エージェントが 1 分あたりに収集するイベントの最大数を定義します。この数を超える場合、エージェントは統計サンプルを収集します。この設定の使用方法は、他のAPMエージェントと一致しています。
Troubleshooting tips: イベントデータが不足している場合は、 max_samples_storedの値を増やすか、デフォルト値に戻します。 max_samples_storedの値は 10,000 を超えてはなりません。

Node.jsバージョンのサポート

Node.js 8 は、New Relic Node.js v6 エージェントでサポートされている最も古いバージョンです。Node.js 6、7、9 は v6 ではサポートされていません。Node.js 6、7、および 9 を実行しているお客様には、次の 2 つのオプションがあります。

サポートされているバージョンの Node.js にアップグレードして、New Relic Node.js v6 エージェントの新機能を活用してください。
New Relic Node.js v5エージェントのままでは、エージェントのバージョンを更新したときにのみ利用できる新機能を使用できません。

Node.js 8 は更新を受け取らなくなりましたが、New Relic は当面の間、これらのバージョンの Node.js を引き続きサポートします。

ヒント

できるだけ早く Node.js の新しいバージョンにアップグレードしてください。New Relic Node.js エージェントの次のメジャーバージョンでは、Node.js 8 のサポートが削除される可能性があります。

Node.jsエージェントバージョン5へのアップグレード

Node.js agent v5 にアップグレードする前に、主要な変更点についてこの情報を確認してください。また、New Relic の Node.js v5 移行ガイド（GitHub ）もご覧ください。

Major changes with Node.js v5 agent	Comments
非推奨の`addCustomParameter`メソッドを削除しました。	v2 - v4: エージェント v2.7.0 以降、これらのメソッドは非推奨としてマークされましたが、新しいメソッドへの移行期間を設けるために残されました。 v5: アプリケーションは API メソッド`newrelic.addCustomAttribute()`と`newrelic.addCustomAttributes()`を使用する必要があります。これらは古い方法の代替品です。
非推奨の`create*Transaction`メソッドを削除しました。	v2 - v4: エージェント v2.0.2 以降、これらのメソッドは非推奨としてマークされましたが、新しいメソッドへの移行期間を設けるために残されました。 v5: アプリケーションは API メソッド`newrelic.startWebTransaction()`および`newrelic.startBackgroundTransaction()`に更新する必要があります。 Troubleshooting tips: これらの新しい方法は、古い方法に代わるものではありません。これらの新しい方法に移行する前に、カスタムインストゥルメンテーションガイドを確認してください。
非推奨の`createTracer`メソッドを削除しました。	v3 - v4: エージェント v3.3.0 以降では、このメソッドは非推奨となり、代わりに`newrelic.startSegment()`が使用されるようになりました。 v5: アプリケーションを`newrelic.startSegment()`に更新する必要があります。
`node-cassandra-cql`インストルメンテーションを削除しました。	v4: npm パッケージ`node-cassandra-cql`を使用するアプリケーションは、Cassandra のデータストアメトリックを取得します。 v5: Cassandra データストアメトリックを取得するには、アプリケーションを`cassandra-driver`パッケージに移行する必要があります。このモジュールは同じ開発者によって積極的に保守されています。 `node-cassandra-cql`パッケージは 2014 年 2 月に廃止され、代わりに`cassandra-driver`パッケージが導入されました。
非推奨の`capture_params`および`ignored_params`構成を削除しました。	v2 - v4: エージェント v2.7.0 以降では、これらの設定引数によって警告がログに記録され、値は新しい属性設定に自動的にアップグレードされるようになりました。 v5: 警告は引き続きログに記録されますが、設定は無視され、自動アップグレードは行われなくなります。 Troubleshooting tips: アプリケーションが`ignored_params`設定にリストされている場合は、それらを`attributes.exclude`に移動する必要があります。

Node.jsバージョンのサポート

Node.js 6 は、New Relic Node.js v5 エージェントでサポートされている最も古いバージョンです。Node.js 4 および 5 は v5 ではサポートされていません。Node.js 4 または 5 を実行しているお客様には、次の 2 つのオプションがあります。

サポートされているバージョンの Node.js にアップグレードして、New Relic Node.js v5 エージェントの新機能を活用してください。
New Relic Node.js v4 エージェントのままでは、エージェントのバージョンを更新したときにのみ利用できる新機能を使用できません。

Node.js 7 および 9 は更新を受け取らなくなりましたが、New Relic は当面の間、これらのバージョンの Node.js を引き続きサポートします。

ヒント

できるだけ早く Node.js の新しいバージョンにアップグレードしてください。New Relic Node.js エージェントの次のメジャーバージョンでは、Node.js 6 および 7 のサポートが削除される可能性があります。

v5での機能フラグ

New Relic for Node.js v5.の時点で。

custom_instrumentation: この機能は構成できなくなりました。
custom_metrics: この機能は構成できなくなりました。
synthetics: この機能は構成できなくなりました。
native_metrics: この機能は、 plugins.native_metrics.enabled構成値によって制御されるようになりました。

Node.jsエージェントバージョン4へのアップグレード

Node.js agent v4 にアップグレードする前に、主要な変更点についてこの情報を確認してください。また、New Relic の Node.js v4 移行ガイドを GitHub でご覧いただけます。

Node.js v4 エージェントの主な変更点には、 https-proxy-agentの v0 から v2 へのアップグレードが含まれます。この依存関係は、New Relic Node.js エージェントが使用したhttps-proxy-agentのセキュリティの問題により更新されました。https-proxy v2 はノード v0.10 および v0.12 と互換性がないため、New Relic は、これらのエージェントバージョンを廃止しました。New Relic の Node.js エージェントの v3 から v4 に移行するために必要なアクションはありません。

Node.js 4 は、New Relic Node.js v4 エージェントでサポートされている最も古いバージョンです。Node.js 0.10 および 0.12 は v4 ではサポートされていません。Node.js 0.10 または 0.12 を実行しているお客様には、次の 2 つのオプションがあります。

サポートされているバージョンの Node.js にアップグレードして、New Relic Node.js v4 エージェントの新機能を活用してください。
New Relic Node.js v3 エージェントのままでは、エージェントのバージョンが更新された場合にのみ利用できる新機能を利用することができません。
Node.js 4、5、および 7 も更新を受け取りませんが、New Relic は当面の間、これらのバージョンの Node.js を引き続きサポートします。
ヒント
できるだけ早く Node.js の新しいバージョンにアップグレードしてください。New Relic Node.js エージェントの次のメジャーバージョンでは、Node.js 4 および 5 のサポートが削除される可能性があります。

Node.jsエージェントバージョン3へのアップグレード

Node.js エージェント agent v3 にアップグレードする前に、主要な変更点についてこの情報を確認してください。また、New Relic の Node.js v3 移行ガイド（GitHub ）もご覧ください。

Major changes with Node.js v3 agent	Comments
SSL設定の削除	v2: v2 エージェントでは、暗号化なしで New Relic に接続するようにエージェントを構成することができました。 v3: Node.js エージェント v3 は、通信を保護するために常に TLS 暗号化を使用して New Relic サーバーに接続します。エージェントがこれを無効にするように構成されている場合、警告がログに記録され、設定は無視されます。
リクエストパラメータにプレフィックスが付きました `request.parameters.`	v2: v2 エージェントは、ルート引数 ( `/users/:userId` ) やクエリ引数 ( `/users?userId=123` ) などのリクエスト引数を引数名 ( `userId` ) として収集します。 v3: v3 エージェントは、すべてのリクエストの先頭に文字列`request.parameters.`を付加します。たとえば、 `userId` `request.parameters.userId`として表示されます。 Troubleshooting tips: ダッシュボード、アラートポリシー、またはリクエストフォーラムに基づくその他のNRQLクエリがある場合は、それらを新しいフォーラム名で更新します。

Major changes with Node.js v3 agent

Comments

SSL設定の削除

v2: v2 エージェントでは、暗号化なしで New Relic に接続するようにエージェントを構成することができました。
v3: Node.js エージェント v3 は、通信を保護するために常に TLS 暗号化を使用して New Relic サーバーに接続します。エージェントがこれを無効にするように構成されている場合、警告がログに記録され、設定は無視されます。

リクエストパラメータにプレフィックスが付きました request.parameters.

v2: v2 エージェントは、ルート引数 ( /users/:userId ) やクエリ引数 ( /users?userId=123 ) などのリクエスト引数を引数名 ( userId ) として収集します。
v3: v3 エージェントは、すべてのリクエストの先頭に文字列request.parameters.を付加します。たとえば、 userId request.parameters.userIdとして表示されます。
Troubleshooting tips: ダッシュボード、アラートポリシー、またはリクエストフォーラムに基づくその他のNRQLクエリがある場合は、それらを新しいフォーラム名で更新します。

Node.jsエージェントバージョン2へのアップグレード

Node.js agent v2 にアップグレードする前に、主要な変更点についてこの情報を確認してください。また、New Relic の Node.js v2 移行ガイドを GitHub でご覧いただけます。

Major changes with Node.js v2 agent	Comments
ネーミングと無視のルールが逆転	v1: v1 エージェントでは、構成プロパティ`rules.name`および`rules.ignore`で定義されたルールが逆の順序で適用され、リストの最初のルールが最後に適用されました。 v2: Node.js エージェント v2 は、定義された順序でルールを適用するため、リストの最初のルールが最初に適用されます。 Troubleshooting tips: v1 エージェントで命名規則を使用していて問題に気付いた場合は、設定で規則の順序を逆にしてください。
重複していないHTTPリクエストのトランザクション	v1: v1 エージェントは、HTTP サーバーの`request`イベントで各リスナーに対して新しいトランザクションを開始しました。 `request`イベントに複数のリスナーを持つアプリケーションでは、この結果、ほとんどの場合、正しく名前が付けられない余分なトランザクションが作成されました。 v2: v2 エージェントは、発行された`request`イベントごとに 1 つのトランザクションのみを作成します。 Troubleshooting tips: 複数の`request`イベントリスナーを使用し、余分なトランザクションを削除するために`newrelic.ignoreTransaction()`への呼び出しを追加した場合は、それらの呼び出しを削除します。
アウトバウンド・リクエスト・エラーの飲み込みが悪くなった	v1: v1 エージェントは、送信 HTTP 要求オブジェクトによって発行された未処理の`error`イベントを取り込みました。 v2: v2 エージェントではこの動作が削除されます。代わりに、v2 エージェントは通常の Node.js 実行を変更しません。つまり、 `error`イベントは常に発行されます。 Troubleshooting tips: 送信リクエストを行っており、現在`error`イベントをリッスンしていない場合は、リスナーを追加し、アプリケーションに応じてエラーを処理します。

newrelic.jsで、最新バージョンとの互換性のために使用するNode.js エージェント構成プロパティを編集します。

Deprecated property	New property
`capture_params`	`attributes.enabled: false` デフォルトでは、リクエスト属性は New Relic に送信されません。`attributes.enabled: true`を設定して、トレースにエージェント定義またはカスタムの属性を含めます。`capture_params`プロパティは廃止されました。
`ignored_params`	`attributes.exclude: []` 要求属性キーを`attributes.exclude`リストに追加します。現在、完全一致である必要はなく、ワイルドカード ( `*` ) を各項目に追加して、より広範なフィルタリングを行うことができます。`ignored_params`プロパティは廃止されました。

Deprecated property

New property

capture_params

attributes.enabled: false

デフォルトでは、リクエスト属性は New Relic に送信されません。attributes.enabled: trueを設定して、トレースにエージェント定義またはカスタムの属性を含めます。capture_paramsプロパティは廃止されました。

ignored_params

attributes.exclude: []

要求属性キーをattributes.excludeリストに追加します。現在、完全一致である必要はなく、ワイルドカード ( * ) を各項目に追加して、より広範なフィルタリングを行うことができます。ignored_paramsプロパティは廃止されました。

これらの Node.js エージェント設定プロパティには、以下のような特定の宛先に対するオーバーライドもあります。

transaction_tracer
transaction_events
error_collector
browser_monitoring
たとえば、ルートattributes.enabledがtrueでtransaction_tracer.attributes.enabled: falseを設定すると、属性がトランザクション追跡で収集されることは制限されますが、他のすべての属性は引き続き許可されます。

Node.jsエージェントの以下のメソッドは非推奨となっており、New Relicはエージェントのv5で削除しました。それぞれのメソッドには、より柔軟で信頼性の高い方法で同じタスクを達成する簡単な代替手段があります。

New Relic Node.js v2 エージェントでは、以下の API メソッドが新しくなりました。

これらのメソッドを使用して、 New Relic Node.js エージェントによってすでにインストゥルメントされたモジュールを含む、サードパーティモジュールのカスタムインストゥルメンテーションを追加します。詳細については、GitHub にあるNew RelicのNode.js インストゥルメンテーションサンプルアプリケーションを参照してください。

New Relic Node.js v2 エージェントでサポートされている Node.js の最も古いバージョンは 0.10 です。2014 年 7 月以降更新されていない Node.js 0.8 は、v2 ではサポートされていません。Node.js 0.8 を実行しているお客様には、次の 2 つのオプションがあります。

サポートされているバージョンの Node.js にアップグレードして、New Relic Node.js v2 エージェントの新機能を活用してください。
New Relic Node.js v1 エージェントのままでは、エージェントのバージョンが更新された場合にのみ利用できる新機能を使用することができません。
Node.js 0.10 も更新を受信しなくなりましたが、New Relic は当面の間、このバージョンの Node.js を引き続きサポートします。
推奨事項: できるだけ早く Node.js の新しいバージョンにアップグレードしてください。

New Relic Node.js エージェントには、npm バージョン 2.0.0 以降が必要になりました。このバージョンの npm は、Node.js 0.10.44 以降にパッケージ化されています。

以前のバージョンの Node.js 0.10 を使用している場合は、最初に npm 2.0.0 以降をインストールするか、新しいバージョンの Node.js にアップグレードする必要があります。npm バージョン 2 をインストールするには:

bash

$npm install --global npm@2

Module	V2 minimum	Minimum before v2
エクスプレス	4.6.0	2.0.0
mysql	2.0.0	0.9.0

この機械翻訳は、参考として提供されています。

Node.jsエージェントバージョン14へのアップグレード .css-21sua1{background:none;border:none;width:0;padding:0;}

Apollo Server移行ガイド

プラグイン設定

エージェントの設定

APIコール

customOperationAttributes

customResolverAttributes

Node.jsエージェント バージョン 13 にアップグレードする

Node.jsエージェント バージョン 12 にアップグレードする

Node.js エージェント バージョン 11 へのアップグレード

Node.jsバージョンのサポート

ヒント

Node.js エージェント バージョン 10 へのアップグレード

Node.jsバージョンのサポート

ヒント

Node.js エージェント バージョン 9 にアップグレードする

Node.jsバージョンのサポート

ヒント

Node.jsエージェントバージョン8へのアップグレード

Node.jsバージョンのサポート

ヒント

Node.jsエージェントバージョン7へのアップグレード

Node.jsバージョンのサポート

Node.jsエージェントバージョン6へのアップグレード

Node.jsバージョンのサポート

ヒント

Node.jsエージェントバージョン5へのアップグレード

Node.jsバージョンのサポート

ヒント

v5での機能フラグ

Node.jsエージェントバージョン4へのアップグレード

Node.jsバージョンのサポート

Node.jsエージェントバージョン3へのアップグレード

Node.js v3 agentの主な変更点

v3での機能フラグ

Node.jsエージェントバージョン2へのアップグレード

Node.js v2 agentの主な変更点

v2で更新された設定オプション

v2で非推奨となったAPIメソッド

新しいv2エージェントAPIメソッド

v2 の Node.js バージョンのサポート

v2時点でのnpmのバージョンサポート

v2での機能フラグ

v2時点でのフレームワークの最小バージョン

Node.jsエージェントバージョン14へのアップグレード

Node.jsエージェントバージョン 13 にアップグレードする

Node.jsエージェントバージョン 12 にアップグレードする

Node.js エージェントバージョン 11 へのアップグレード

Node.js エージェントバージョン 10 へのアップグレード

Node.js エージェントバージョン 9 にアップグレードする