カスタム属性の収集

一部の New Relic ソリューションでは、カスタムデータを New Relic に報告する方法のひとつとして、カスタム属性を使用します。例えば、New Relic のブラウザモニタリングでは、カスタム属性を作成して、遅いリクエストや失敗したリクエストに関連するユーザー名を追跡することができます。

要件

カスタム属性は、これらのNew Relicソリューションで利用できます。

APM
ブラウザのモニタリング
モバイルのモニタリング
インフラストラクチャのモニタリング

その他のカスタムデータソリューションについては、 Intro to custom data をご覧ください。

APM:カスタム属性の記録

重要

NRQL で使用されている予約語のリストを確認してください。予約語を使用すると問題が発生する可能性があります。

APMのカスタムアトリビュートを有効にして使用するには、ご使用のAPMエージェントの手順に従ってください。

カスタム属性の収集は、Javaではデフォルトで有効になっています。カスタム属性の収集は、XML と Java エージェント API を使用して行うことができます。この2つの方法は、互いに併用することができます。

メソッド	設定方法
XMLでの属性指定	XMLは、ソースコードを変更することなく、カスタム属性を指定することができます。カスタム属性用に複数のXMLファイルを用意し、論理的なファセットでグループ化することができます。 XMLを使ってJavaアプリのカスタム属性を設定する。 New Relic Java エージェントの XML ファイル形式、メソッドとクラス、例に関するドキュメントを確認してください。 New Relic Java エージェント内の `Extensions` ディレクトリから、単一の XML ファイルを作成します。 XMLファイルを直接編集して、New Relicにモニターさせたいメソッドを定義します。 New Relic UI を使用して、XML インスツルメンテーションファイルを定義します。これには、 `common:` newrelic.yml のブロックに追加の設定が必要になる場合があります。詳細については、 Report custom attributes under Instrumentation options を参照してください。
エージェントのAPIを呼び出す	例 1: トランザクションにカスタム属性を追加するエージェントのAPIを使用してカスタム属性を収集するには、関連するメソッドを呼び出します。属性を記録したい各メソッドに対して、 `NewRelic.addCustomParameter(...)` を呼び出してください。 Optional: 特定の属性を含める、または除外する `attributes.include` and `attributes.exclude` . 例えば、 `userId` という変数を記録するには、親メソッドに以下のコードを記述します。 `NewRelic.addCustomParameter("userId", userId);` 例2：分散型トレースのスパンにカスタム属性を追加するエージェントのAPIを使用してカスタム属性を収集するには、関連するメソッドを呼び出します。属性を記録したい各スパン（現在実行中のメソッド）について、 `NewRelic.getAgent().getTracedMethod().addCustomAttribute(...)` を呼び出します。オプション：特定の属性を含める、または除外する `span_events.attributes.include` and `span_events.attributes.exclude` . 例えば、現在のスパンに `userId` という変数を記録するには、関連するメソッドに以下のコードを記述します。 `NewRelic.getAgent().getTracedMethod().addCustomAttribute("userId", userId);`
ユーザー属性の収集	また、Javaエージェントには、ユーザー属性を有効にして、 `HttpServletRequest.getUserPrincipal()` からユーザー情報をカスタム属性として収集する仕組みが組み込まれています。

メソッド

設定方法

XMLでの属性指定

XMLは、ソースコードを変更することなく、カスタム属性を指定することができます。カスタム属性用に複数のXMLファイルを用意し、論理的なファセットでグループ化することができます。

XMLを使ってJavaアプリのカスタム属性を設定する。

New Relic Java エージェントの XML ファイル形式、メソッドとクラス、例に関するドキュメントを確認してください。
New Relic Java エージェント内の Extensions ディレクトリから、単一の XML ファイルを作成します。
XMLファイルを直接編集して、New Relicにモニターさせたいメソッドを定義します。
New Relic UI を使用して、XML インスツルメンテーションファイルを定義します。これには、 common: newrelic.yml のブロックに追加の設定が必要になる場合があります。詳細については、 Report custom attributes under Instrumentation options を参照してください。

エージェントのAPIを呼び出す

例 1: トランザクションにカスタム属性を追加する

エージェントのAPIを使用してカスタム属性を収集するには、関連するメソッドを呼び出します。

属性を記録したい各メソッドに対して、 NewRelic.addCustomParameter(...) を呼び出してください。
Optional: 特定の属性を含める、または除外する attributes.include and attributes.exclude .
例えば、 userId という変数を記録するには、親メソッドに以下のコードを記述します。
```
NewRelic.addCustomParameter("userId", userId);
```
例2：分散型トレースのスパンにカスタム属性を追加する
エージェントのAPIを使用してカスタム属性を収集するには、関連するメソッドを呼び出します。
属性を記録したい各スパン（現在実行中のメソッド）について、 NewRelic.getAgent().getTracedMethod().addCustomAttribute(...) を呼び出します。
オプション：特定の属性を含める、または除外する span_events.attributes.include and span_events.attributes.exclude .
例えば、現在のスパンに userId という変数を記録するには、関連するメソッドに以下のコードを記述します。
```
NewRelic.getAgent().getTracedMethod().addCustomAttribute("userId", userId);
```

ユーザー属性の収集

また、Javaエージェントには、ユーザー属性を有効にして、 HttpServletRequest.getUserPrincipal() からユーザー情報をカスタム属性として収集する仕組みが組み込まれています。

カスタム属性の収集は、.NETではデフォルトで有効になっています。カスタム属性を収集するには、関連するAPIメソッドを呼び出します。

属性を記録したい各メソッドについて、 AddCustomAttribute を呼び出します。
オプション： include and exclude 設定オプションで属性を含めたり、除外したりします。
例えば、クーポンコード（文字列）とアイテムIDコード（数字）の属性を記録するには、親メソッドにこのコードを記述します。
```
IAgent agent = NewRelic.Api.Agent.NewRelic.GetAgent();
ITransaction transaction = agent.CurrentTransaction;

transaction
    .AddCustomAttribute("Discount Code", "Summer Super Sale")
    .AddCustomAttribute("Item Code", 31456);
```

カスタム属性の収集は、Node.jsではデフォルトで有効になっています。カスタム属性を収集するには、関連するAPIメソッドを呼び出します。

記録したい属性ごとに、 newrelic.addCustomAttribute を呼び出します。
1回の呼び出しで複数の属性を記録するには、 newrelic.addCustomAttributes .
例えば、クーポンコードとアイテムIDコードの属性を記録するには、これを親メソッドに含めます。
```
newrelic.addCustomAttributes({
  "Discount Code": "Summer Super Sale",
  "Item Code": 31456
});
```

カスタム属性の収集は、PHPではデフォルトで有効になっています。カスタム属性を収集するには、属性を記録したい各メソッドの関連するAPIメソッドを呼び出します。

newrelic_add_custom_parameter for transaction events and spans
newrelic_add_custom_span_parameter スパンのみの場合。
例えば、 $userId という変数を記録するには、親メソッドに以下のコードを記述します。
```
newrelic_add_custom_parameter ('userID', $userId)
```

カスタム属性の収集は、Pythonではデフォルトで有効になっています。カスタム属性を収集するには、属性を記録したいメソッドごとに add_custom_parameter を呼び出してください。

例えば、 user_id という変数を記録するには、親メソッドに以下のコードを記述します。

newrelic.agent.add_custom_parameter('user_id', user_id)

カスタム属性の収集は、Rubyではデフォルトで有効になっています。カスタム属性を収集するには、関連するAPIメソッドを呼び出します。

Ruby エージェントのバージョン 3.12.0 以降では， add_custom_attributes メソッドを使用します。例えば， @user_id という変数を記録するには，親メソッドに以下のコードを記述します。
```
::NewRelic::Agent.add_custom_attributes({ user_id: @user.id })
```
Ruby エージェントのバージョン 3.11.2 以下では， add_custom_parameters メソッドを使用します。例えば， @user_id という変数を記録するには，親メソッドに以下のコードを記述します。
```
::NewRelic::Agent.add_custom_parameters({ user_id: @user.id })
```

ブラウザモニタリング。カスタム属性の記録

ブラウザエージェントは、ページビューやブラウザのインタラクションに関連する追加の詳細を指定するためのAPIを提供しています。APMからブラウザモニタリングに属性を転送するまたは、JavaScriptでカスタム属性を指定するのいずれかの方法で行います。APMエージェントから転送された値は、ブラウザエージェントによってエンコードされ、ブラウザの属性に注入されます。

インフラストラクチャのモニタリング。カスタム属性の記録

当社のインフラストラクチャモニタリングでは、インフラストラクチャエージェントからのデータに注釈を付けるために使用されるカスタム属性を作成することができます。このメタデータを使用して、フィルタセットの構築、結果のグループ化、データの注釈付けを行うことができます。

モバイルモニタリング。カスタム属性の記録

モバイルエージェントには、カスタム属性を記録するためのAPIコールが含まれています。

モバイルモニタリングのカスタムデータの概要については、カスタムイベントと属性の挿入をご覧ください。
Android メソッド： setAttribute
iOSメソッド： setAttribute

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

要件

APM:カスタム属性の記録

重要

C SDK

Go

Java

.NET

Node.js

PHP

Python

Ruby

ブラウザモニタリング。カスタム属性の記録

インフラストラクチャのモニタリング。カスタム属性の記録

モバイルモニタリング。カスタム属性の記録