Node.jsエージェントAPI

New Relic は、Node.js アプリケーションに関する有用なメトリクスを提供するために必要な情報を取得するためのツールをいくつか提供しています。これらには次のようなものがあります。

• ExpressとRestifyのルーターからルート名（使用されている場合）を読み込む
• APIを使用して、現在のリクエストに名前を付ける。単純な名前や、アクションを持つコントローラのグループを使用する。
• リクエストの生のURLに対してマッチした正規表現に基づいて、リクエストをリネームまたは無視するようマークすることができる、エージェントの設定に保存されたルールをサポート（APIコールとしても利用可能）

New Relic が追跡する名前の数は、ユーザー・エクスペリエンスが堅牢であるように十分小さくする必要があります。また、アプリケーションの問題点をより簡単に特定できるように、（データに圧倒されることなく）適切な量の情報を提供するのに十分な規模である必要があります。

詳細については、 Node.js エージェント設定ドキュメント、 Github の Node.js エージェントAPIドキュメント、およびNode.js エージェント サンプル アプリケーションを参照してください。

リクエスト名

Node.js エージェントは、潜在的にパラメーター化されたパス ( /user/:idなど) または正規表現 ( /^/user/([-0-9a-f]+)$/など) とともに HTTP メソッドをキャプチャします。これらの情報は、リクエスト名の一部になります。

低速トランザクション トレースをサポートしていて、構成ファイルのattributes.includeに'request.parameters.*'を追加している場合、トランザクション トレースにもリクエストのパラメータとその値が添付されます。Node.js エージェントが使用する要求名が気に入らない場合は、API 呼び出しを使用して、よりわかりやすい名前を作成できます。

要件

New Relic では、多くのチャートやテーブルでリクエストをグループ化するためにリクエスト名を使用しています。異なるリクエスト名の数が増えると、これらのビジュアライゼーションの価値は下がります。

例えば、作成するリクエスト名にGUID、数値ID、タイムスタンプのような潜在的に動的なデータを含まないようにします。リクエストがトランザクショントレースを生成するほど遅い場合、そのトレースにはオリジナルのURLが含まれます。パラメータキャプチャを有効にした場合、パラメータもトレースに添付されます。

メトリクスのグループ化問題を回避する

"" New Relic では、このような問題に対処するためにいくつかの方法を用意しています。最も厳しい方法は、問題のあるアプリケーションを拒否リストに追加することです。

これらのリクエスト名付けツールの使用に注意する主な理由は、アプリケーションにこのような事態が発生するのを防ぐためです。詳細については、 Metric grouping issues をご覧ください。

ガイドライン

設定ルールは、最も具体的なものから最も一般的なものまで定義してください。設定ファイルに記載された最初のルール、または Node.js transaction naming API で追加されたルールが最初に適用されるため、対象を絞る必要があります。より一般的な"fall-through" のルールは、リストの最後の方に追加してください。なぜなら、これらのルールは、Node.js トランザクション ネーミング API を使用して設定または追加された順に評価されるからです。

/user/customers/all/prospects
/user/customers/all/current
/user/customers/all/returning
/user/customers/John
/user/customers/Jane

// newrelic.js
exports.config={
  //other configuration
  rules:{
    name:[
      { pattern: "/user/customers/all/prospects/", name: "/user/customers/all/prospects" },
      { pattern: "/user/customers/all/.*", name: "/user/customers/all" },
      { pattern: "/user/customers/.*", name: "/user/customers/:customer" }
    ]
  }
};

APIをロードする

アプリケーションの他の部分がロードされる前に、New Relic モジュールがブートストラップする必要があるため、New Relic モジュールのロードがアプリケーションの最初に行われるようにしてください。

const newrelic = require('newrelic');

これは New Relic Node.js API を返します。 モジュールは一度だけ初期化されるため、アプリケーション内の複数のモジュールからモジュールを安全に要求できます。

APIコールのリクエスト

New Relic の Node.js エージェントの Request API コールをまとめました。

• トランザクション名の設定
• コントローラー名の設定

カスタムインストルメントAPIコール

これらのAPIコールを使用して、 カスタムインストルメントでインストルメントを拡張することができます.

カスタムメトリクスのAPIコール

これらのAPIコールを使用して、追加の任意のメトリクスを記録します。

カスタムイベントのAPIコール

これらのAPIコールを使用して、追加のイベントを記録します。

• recordCustomEvent
• 記録ログイベント

トランザクション処理方法

これらのAPIコールを使用して、現在の段階と対話します。

リクエストの命名と無視のルール

New Relic モジュールへの呼び出しをアプリケーションコードに直接記述したくない場合は、パターンベースのルールを使ってリクエストに名前を付けることができます。ルールには、リクエストの名前を変更するためのものと、New Relic のインスツルメンテーションによって無視されるリクエストをマークするためのものの 2 種類があります。

ここでは、New Relic の Node.js エージェントにおけるルールの構造について説明します。

NEW_RELIC_NAMING_RULES='{"pattern":"^t","name":"u"},{"pattern":"^u","name":"t"}'

pattern:     '[0-9]+',
replace_all: true

$
node node_modules/.bin/newrelic-naming-rules

pattern: '^/items/[0-9]+$',
name:    '/items/:id'

/items/123   =>  /items/:id
/orders/123  =>  /orders/123   (not replaced since the rule is a full match)

pattern: '[0-9]+',
name:    ':id'

/orders/123            =>  /orders/:id
/items/123             =>  /items/:id
/orders/123/items/123  =>  /orders/:id/items/123

pattern:     '[0-9]+',
name:        ':id',
replace_all: true

/orders/123/items/123  =>  /orders/:id/items/:id

pattern: '^/(items|orders)/[0-9]+$',
name:    '/\\1/:id'

/orders/123  =>  /orders/:id
/items/123   =>  /items/:id

NEW_RELIC_IGNORING_RULES='^/socket\.io/\*/xhr-polling,ignore_me'

ここでは、設定ファイルに含まれるルールの全例をご紹介します。

// newrelic.js
exports.config = {
  // other configuration
  rules : {
    name : [
      { pattern: "/tables/name-here", name: "/name-hererule1" }
    ]
  }
};

// newrelic.js
exports.config = {
  // other configuration
  rules : {
    ignore : [
      '^\/socket\.io\/.*\/xhr-polling'
    ]
  }
};

ルールのAPIコール

ここでは、New Relic の Node.js エージェントでルールを命名したり無視したりするための API コールを紹介します。

• addNamingRule
• addIgnoringRule