ここでは、属性 を有効または無効にするプロパティと、New Relic が宛先 に含める属性または除外する属性を決定するときに使用するルールについて説明します。 これには、New Relic エージェント属性のリリースで廃止または削除された Ruby エージェント プロパティの概要も含まれます。
プロパティ 以下のプロパティを使用して、属性を有効または無効にします。
attributes.enabled タイプ
ブール値
デフォルト
true
環境変数
NEW_RELIC_ATTRIBUTES_ENABLED
trueの場合、すべての宛先の属性のキャプチャを有効にします。
transaction_tracer.attributes.enabled タイプ
ブール値
デフォルト
(ダイナミック)
環境変数
NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_ENABLED
trueの場合、エージェントはトランザクショントレースから属性をキャプチャします。
transaction_events.attributes.enabled タイプ
ブール値
デフォルト
(ダイナミック)
環境変数
NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_ENABLED
trueの場合、エージェントはトランザクションイベントから属性をキャプチャします。
error_collector.attributes.enabled タイプ
ブール値
デフォルト
(ダイナミック)
環境変数
NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_ENABLED
trueの場合、エージェントはエラー収集から属性をキャプチャします。
browser_monitoring.attributes.enabled タイプ
ブール値
デフォルト
(ダイナミック)
環境変数
NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_ENABLED
trueの場合、エージェントはブラウザ監視 から属性を取得します。
span_events.attributes.enabled タイプ
ブール値
デフォルト
(ダイナミック)
環境変数
NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_ENABLED
trueの場合、エージェントはスパンイベントの属性をキャプチャします。
transaction_segments.attributes.enabled タイプ
ブール値
デフォルト
(ダイナミック)
環境変数
NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_ENABLED
trueの場合、エージェントはトランザクションセグメントの属性をキャプチャします。
attributes.exclude タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_ATTRIBUTES_EXCLUDE
すべての宛先から除外する属性のプレフィックス。最後にワイルドカードとして*を許可します。
transaction_tracer.attributes.exclude タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_EXCLUDE
トランザクショントレースから除外する属性のプレフィックス。最後にワイルドカードとして*を許可します。
transaction_events.attributes.exclude タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_EXCLUDE
トランザクションイベントから除外する属性のプレフィックス。最後にワイルドカードとして*を許可します。
error_collector.attributes.exclude browser_monitoring.attributes.exclude タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_EXCLUDE
ブラウザ監視 から除外する属性のプレフィックス。 最後にワイルドカードとして*使用できます。
span_events.attributes.exclude タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_EXCLUDE
スパンイベントから除外する属性のプレフィックス。最後にワイルドカードとして*を許可します。
transaction_segments.attributes.exclude タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_EXCLUDE
トランザクションセグメントから除外する属性のプレフィックス。最後にワイルドカードとして*を許可します。
attributes.include タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_ATTRIBUTES_INCLUDE
すべての宛先に含める属性のプレフィックス。最後にワイルドカードとして*を許可します。
transaction_tracer.attributes.include タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_INCLUDE
トランザクショントレースに含める属性のプレフィックス。最後にワイルドカードとして*を許可します。
transaction_events.attributes.include タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_INCLUDE
トランザクションイベントに含める属性のプレフィックス。最後にワイルドカードとして*を許可します。
error_collector.attributes.include タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_INCLUDE
エラー収集に含める属性のプレフィックス。最後にワイルドカードとして*を許可します。
browser_monitoring.attributes.include タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_INCLUDE
ブラウザの監視に含める属性のプレフィックス。最後にワイルドカードとして*を許可します。
span_events.attributes.include タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_INCLUDE
スパン イベントに含める属性のプレフィックス。最後に*をワイルドカードとして使用できます。
transaction_segments.attributes.include タイプ
配列
デフォルト
[]
環境変数
NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_INCLUDE
トランザクション セグメントに含める属性のプレフィックス。最後に*をワイルドカードとして使用できます。
アトリビュートルール New Relic は、デスティネーションにどの属性を含めるか、または除外するかを決定する際に、これらのルールに従います。
Rootレベルが優先されて有効になります。 attributes.enabledフィールドは、他のすべての設定より優先されます。falseの場合、属性は New Relic に報告されません。
設定例
attributes.enabled : false
attributes.include : foo , bar
transaction_tracer.attributes.enabled : true
出力例。
Keys passed in: foo, bar, baz
Keys included for all destinations:
Keys excluded for all destinations: foo, bar, baz
Destination enabledはincludeやexcludeよりも優先されます。 YOUR_DESTINATION.attributes.enabledフラグは、包含キーおよび除外キーよりも優先されます。
設定例
transaction_tracer.attributes.enabled : false
attributes.include : one , two
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
属性は、デスティネーションが有効な場合に含まれます。 デスティネーションが有効な場合、すべてのユーザー属性はデフォルトでそのデスティネーションに送信されます。
Note: すべてのユーザー属性はデフォルトで trueに設定されます。ただし、デフォルトでは、リクエスト パラメータはすべての宛先に対して無効になっています。
設定例
出力例。
Keys passed in: foo, bar, baz
Excludeは常にIncludeに優先します。 includeリストとexcludeリストに同じキーが記載されている場合は、指定されたキーを持つ属性は除外されます。
設定例
attributes.include : foo , bar
attributes.exclude : nerd , bar
出力例。
Keys passed in: foo, bar, nerd
キーは大文字と小文字を区別します。 キーは大文字と小文字を区別します。
設定例
attributes.exclude : username , UsErNaMe
出力例。
Keys passed in: username, Username, USERNAME, UsErNaMe, userNAME
Keys included: Username, USERNAME, userNAME
Keys excluded: username, UsErNaMe
ワイルドカードには\*を使用してください。 キーの末尾にあるアスタリスク*をワイルドカードとして使用できます。これは、同じプレフィックスを持つ属性のセットと一致します。
設定例
attributes.include : custom*
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属性が同じキーに影響を与える場合は、最も具体的な設定が優先されます。
設定例
attributes.include : request.parameters.foo
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属性が指定されている場合、そのデスティネーションにのみ影響を与えます。
設定例
transaction_events.attributes.exclude : foo
出力例。
Keys included for transaction events:
Keys included for other destinations: foo
Keys excluded for transaction events: foo
URI関連のプロパティ デフォルトでは、Ruby エージェントは次の宛先を含むいくつかの異なる場所で、Uniform Resource Identifier (URI) を New Relic に報告します。
New Relic では、これらの URI には有用なデバッグ情報が含まれている可能性があるため、報告することをお勧めします。URI に電子メール アドレスやアカウント ID など、報告したくない機密データが含まれている場合は、URI レポートを無効にすることができます。URI レポートを無効にするには、上記の属性名のいずれかをattributes.excludeリストに追加します。
たとえば、次のキーを構成ファイルに追加すると、エージェントは URI 関連のプロパティを報告しなくなります。
非推奨および削除されたプロパティ 次のプロパティは非推奨または削除されました。Ruby エージェントをアップグレードするときに、これらのプロパティの新しい属性構成に切り替えます。
Deprecated property
New property
Removed Version
capture_params
attributes.include: request.parameters.*
該当なし
resque.capture_params
attributes.include: job.resque.args.*
9.0.0
sidekiq.capture_params
attributes.include: job.sidekiq.args.*
9.0.0
transaction_tracer.capture_attributes
transaction_tracer.attributes.enabled
9.0.0
error_collector.capture_attributes
error_collector.attributes.enabled
9.0.0
browser_monitoring.capture_attributes
browser_monitoring.attributes.enabled
9.0.0
analytics_events.capture_attributes
transaction_events.attributes.enabled
9.0.0