構文
newrelic_add_custom_parameter(string $key, scalar $value)カスタム属性（キーと値のペア）を現在のトランザクションと現在のスパン（有効な場合）に付けます。
要件
エージェントのバージョン 4.4.5.35 以上。
説明
カスタム属性 (キーと値のデータ ペア) を現在の Web トランザクションに追加します。(「カスタム属性」は以前は「カスタム パラメータ」と呼ばれていたため、呼び出し名は newrelic_add_custom_parameter です。)たとえば、顧客データベースから顧客のフルネームを追加できます。この属性は、このトランザクションから生じるトランザクション追跡に表示されます。カスタム属性の トランザクション イベントをクエリすることもできます。
重要
セキュリティに関する推奨事項：Transaction属性の設定を確認してください。トランザクション・イベントに特化した属性の包含・除外設定は、Span属性設定またはGlobal属性設定に適用する必要があります。
重要
カスタム属性を使用したい場合は、NRQLで使用されている 予約語の使用を避けてください 。
パラメーター
パラメータ | 説明 |
|---|---|
ストリング | 必須項目です。カスタム属性の名前です。最初の255文字のみが保持されます。 |
スカラー | 必須。このカスタム属性に関連付ける値です。 指定された値が NaN、Infinity、非正規化数、または負のゼロの値を持つfloatである場合、この関数の動作は未定義になります。 その他の浮動小数点値の場合、エージェントは指定された値から 1 ビット以上の精度 (ULP) を破棄する場合があります。 |
戻り値
パラメータの追加に成功した場合はtrueを返します。
例
変数の値を報告する
if (extension_loaded('newrelic')) { // Ensure PHP agent is available // Record custom data about this web transaction newrelic_add_custom_parameter('user_email', $user_email);}複数の通話
同じウェブ トランザクション内で、 $keyパラメータに同じ値を指定してnewrelic_add_custom_parameter複数回呼び出すと、最後の呼び出しの$valueが優先されます。最後の呼び出しの値は、Web トランザクションのカスタム属性として記録されます。
たとえば、コードが次のようになったとします。
if (extension_loaded('newrelic')) { // Ensure PHP agent is available // Record custom data about this web transaction newrelic_add_custom_parameter('user_email', billy@newrelic.com); newrelic_add_custom_parameter('user_email', samantha@newrelic.com);}値samantha@newrelic.comは Web トランザクションのuser_emailカスタム属性として記録され、前の呼び出しのbilly@newrelic.comが上書きされます。