属性を有効または無効にするためのプロパティや、New Relic が 配信先 に対してどの属性を含めるか、または除外するかを決定する際に使用するルールについて説明します。また、New Relic エージェント属性のリリースに伴い、廃止された PHP エージェントのプロパティについてもまとめています。
プロパティ
以下のデスティネーションプロパティを使用して、任意の属性コレクションに対してデスティネーションを開いたり閉じたりします。
すべてのデスティネーションのすべてのアトリビュートをオンまたはオフにします。
のすべての属性をオンまたはオフにします。 これはページ ビュー イベントに添付されるデータです。 newrelic.attributes.enabled
がfalse
の場合、このプロパティの設定に関係なく、属性はブラウザ監視に送信されません。
トレースされたエラーのすべての属性をオンまたはオフにします。 newrelic.attributes.enabled
false
の場合、このプロパティがどのように設定されているかに関係なく、トレースされたエラーに属性は送信されません。
トランザクション イベントのすべての属性をオンまたはオフにします。 newrelic.attributes.enabled
が false
の場合、このプロパティがどのように設定されているかに関係なく、属性はトランザクション イベントに送信されません。
トランザクション追跡のすべての属性をオンまたはオフにします。 newrelic.attributes.enabled
false
の場合、このプロパティがどのように設定されているかに関係なく、属性はトランザクション追跡に送信されません。
Span
データのすべての属性をオンまたはオフにします。 newrelic.attributes.enabled
が false
の場合、このプロパティがどのように設定されているかに関係なく、属性はスパンに送信されません。
特定の宛先で特定の属性を追加または削除するには、次の属性/宛先固有の .include
または .exclude
プロパティを使用します。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
属性が有効な場合、このリストにあるすべての属性キーがNew Relicに送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
このリストのすべての属性キーは not New Relic に送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
browser_monitoring
に対して属性が有効になっている場合、このリスト内のすべての属性キーがページ ビュー データで送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
このリストで見つかったすべての属性キーは、 not ページビューでNew Relicに送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
エラーのトレースに属性が有効な場合、このリストのすべての属性キーがエラーのトレースで New Relic に送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
このリストに含まれるすべての属性キーは、 not トレースされたエラーで New Relic に送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
トランザクションイベントで属性を有効にすると、このリストにあるすべての属性キーがトランザクションイベントでNew Relicに送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
このリストのすべての属性キーは not トランザクションイベントで New Relic に送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
トランザクショントレースで属性を有効にすると、このリストのすべての属性キーがトランザクショントレースでNew Relicに送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
このリストのすべての属性キーは not トランザクショントレースで New Relic に送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
spanイベントで属性が有効になっている場合、このリストにあるすべての属性キーがspanイベントでNew Relicに送信されます。
タイプ: | コンマで区切られた文字列のリスト |
---|
デフォルト: | エンプティ |
---|
このリストに含まれるすべての属性キーは、 not spanイベントでNew Relicに送信されます。
アトリビュートルール
New Relic は、デスティネーションにどの属性を含めるか、または除外するかを決定する際に、これらのルールに従います。
newrelic.attributes.enabled
フィールドは、他のすべての設定より優先されます。false
の場合、属性は New Relic に報告されません。
設定例
newrelic.attributes.enabled = false
newrelic.attributes.include = foo,bar
newrelic.transaction_tracer.attributes.enabled = true
出力例。
Keys passed in: password, foo, bar, bat
Keys included for all destinations:
Keys excluded for all destinations: password, foo, bar, bat
newrelic.{destination}.attributes.enabled
フラグは、包含キーおよび除外キーよりも優先されます。
設定例
newrelic.transaction_tracer.attributes.enabled = false
newrelic.attributes.include = one,two
newrelic.transaction_tracer.attributes.include = three,four
出力例。
Keys passed in: one, two, three, four
Keys included for transaction traces:
Keys excluded for transaction traces: one, two, three, four
デスティネーションが有効な場合、すべてのユーザー属性はデフォルトでそのデスティネーションに送信されます。
すべてのユーザー属性のデフォルトはtrue
です。ただし、デフォルトでは、リクエスト属性とメッセージパラメータはすべての宛先で無効になっています。
設定例
newrelic.attributes.enabled = true
newrelic.attributes.exclude = myAttKey
出力例。
Keys passed in: foo, bar, myAttKey
includeリストとexcludeリストに同じキーが記載されている場合は、指定されたキーを持つ属性は除外されます。
設定例
newrelic.attributes.enabled = true
newrelic.attributes.include = foo,myCustomAtt
newrelic.attributes.exclude = password,myCustomAtt
出力例。
Keys passed in: foo, myCustomAtt, password
Keys excluded: password, myCustomAtt
キーは大文字と小文字を区別します。
設定例
newrelic.attributes.enabled = true
newrelic.attributes.exclude = password,PaSsWoRd
出力例。
Keys passed in: password, Password, PASSWORD, PaSsWoRd, PassWORD
Keys included: Password, PASSWORD, PassWORD
Keys excluded: password, PaSsWoRd
キーの末尾にアスタリスクまたはスター (*
) をワイルドカードとして使用できます。これは、同じプレフィックスを持つ一連の属性と一致します。
設定例
newrelic.attributes.enabled = true
newrelic.attributes.include = custom*
newrelic.attributes.exclude = request.parameters.*
出力例。
Keys passed in: custom, custom.key1, custom.key2, request.parameters., request.parameters.foo, request.parameters.bar
Keys included: custom, custom.key1, custom.key2
Keys excluded: request.parameters., request.parameters.foo, request.parameters.bar
複数のincludeまたはexclude属性が同じキーに影響を与える場合は、最も具体的な設定が優先されます。
設定例
newrelic.attributes.enabled = true
newrelic.attributes.include = request.parameters.foo
newrelic.attributes.exclude = request.parameters.*
出力例。
Keys passed in: request.parameters., request.parameters.foo, request.parameters.bar
Keys included: request.parameters.foo
Keys excluded: request.parameters., request.parameters.bar
デスティネーションにincludeまたはexclude属性が指定されている場合、そのデスティネーションにのみ影響を与えます。
設定例
newrelic.attributes.include = foo
newrelic.transaction_events.attributes.exclude = foo
出力例。
Keys included for transaction events:
Keys included for other destinations: foo
Keys excluded for transaction events: foo
非推奨のプロパティ
以下のプロパティは非推奨となりました。PHP エージェントをアップグレードする際には、これらのプロパティの属性設定を新しいものに切り替えてください。
Deprecated property | New property |
---|
newrelic.capture_params
| newrelic.attributes.include = request.parameters.*
デフォルトでは、リクエストパラメータは New Relic に送信されません。すべてのリクエスト パラメータをオンにするには、 request.parameters.* を newrelic.attributes.include リストに追加します。 newrelic.capture_params プロパティは非推奨になりました。 |
newrelic.ignored_params
| newrelic.attributes.exclude = request.parameters.{name}
各リクエスト パラメータ キーをカンマで区切って newrelic.attributes.exclude リストに追加します。キーの前に必ず request.parameters を付けてください。 newrelic.ignored_params プロパティは非推奨になりました。 |
newrelic.{destination}.capture_attributes
| newrelic.{destination}.attributes.enabled
古い newrelic.{destination}.capture_attributes フラグでは、ユーザー属性の収集がオフになります。これは廃止されました。代わりに newrelic.{destination}.attributes.enabled を使用してください。 |