.NET agent設定1
.NET agent設定1

.NET agent設定1

このドキュメントには、New Relicの.NET agentの設定オプションが全て含まれています。このエージェントはnewrelic.configファイルから設定を読み込みます。デフォルトではエージェントにあるのはグローバルnewrelic.configファイルのみですが、マルチアプリケーションシステムにローカルのnewrelic.configファイルを作成することもできます。

newrelic.configまたはapp’s configファイルを変更した後は、必ず管理コマンドプロンプトからIISRESETを実行してください。ただし、newrelic.configでログレベルを調整する場合は、IISRESETは不要です。

構成設定の優先順位

.NET agentはデフォルトでnewrelic.configというグローバル設定ファイルのみが含まれています。このグローバルファイルは、常にNew Relicエージェントの以下のいずれかのホームディレクトリにあります。

  • デフォルト:『 %ALLUSERSPROFILE%\New Relic\.NET Agent』
  • Windows 2003:『 %ALLUSERSPROFILE%\Application Data\New Relic\.NET Agent』

また、アプリケーションのローカルファイルnewrelic.configを作成して、マルチアプリシステムで個別にアプリケーションの設定も可能です。これらのローカル設定ファイルは、グローバルファイルnewrelic.config設定よりも優先されます。エージェントは、この順序で以下のディレクトリのローカル設定ファイルを探します。

  • プロパティが『NewRelic.ConfigFile』の、app.configまたはweb.configファイル内の特定のディレクトリ。
  • Webアプリケーションのルートディレクトリ。
  • アプリケーション実行ファイルを含むディレクトリ。

サーバー側からでも設定が可能です。サーバー設定がローカル設定よりも優先される場合がありますが、それ以外は、ローカル設定がサーバー設定よりも優先されます。

diagram-dotnet-config-cascade.png

New Relicの.NET agentでは、web.configまたはapp.configの設定が ローカルファイルnewrelic.configよりも優先されます。ローカルファイルnewrelic.configは、グローバルnewrelic.configファイルよりも優先されます。

設定オプション

これらのオプションを使用して、エージェントの設定・構成を行います。New Relicは、次のカテゴリーの設定オプションに対応しています。

  • マルチ・アプリケーション
  • 設定要素
  • サービス要素
  • プロキシ要素
  • ログ要素
  • アプリケーション要素(設定)
  • データ転送要素

設定要素

設定文書のルート要素は『configuration』要素です。

この『configuration』要素は、以下の属性に対応しています。

agentEnabled
タイプ Boolean
デフォルト true

New Relicエージェントを有効/無効にします。

maxStackTraceLines
タイプ Integer
デフォルト 80

スタックダンプでトレースするスタックフレームの最大数。

timingPrecision
タイプ String
デフォルト low

 タイマーの精度を制御します。精度が高いほどデータは向上しますが、実行速度は遅くなります。可能な値は『高』と『低』です。

サービス要素

『configuration』要素の最初の子要素は『service』要素です。このサービス要素は、エージェントのNew Relicサービスへの接続を設定します。

『service』要素は次の属性に対応しています:

licenseKey (必須)
タイプ String
デフォルト (none)

New Relicのlicense keyです。ライセンスキーは、アプリケーションのデータをUIの正しいアカウントに合わせるために使用します。

ssl
タイプ Boolean
デフォルト 『true』

デフォルトでは、エージェントはSSLを使用してNew Relicと通信します。SSLを無効にするには、falseに設定します。

sendEnvironmentInfo
タイプ Boolean
デフォルト 『true』

実行環境の情報の記録をエージェントに指示します。環境の情報には、オペレーティングシステム、エージェントのバージョン、使用可能なアセンブリが含まれます。

syncStartup
タイプ Boolean
デフォルト 『false』

エージェントがNew Relicに接続するまで、アプリケーションの起動をブロックします。「true」に設定すると、New Relicへの接続が終了するまでずっとブロックされるため、最初のトランザクションの完了まで長時間かかることがあります。

sendDataOnExit
タイプ Boolean
デフォルト 『false』

エージェントが、最新のハーベスティング・サイクルから全データを送信するまで、アプリケーションのシャットダウンをブロックします。

sendDataOnExitThreshold
タイプ Integer
デフォルト 『60000』
ユニット ミリ秒

エージェントがシャットダウンをブロックする前に必要な、プロセス実行の最小時間。この設定は、『sendDataOnExit』が『true』の場合のみ適用されます。

requestTimeout
タイプ Integer
デフォルト 《2000》 (sendDataOnExit 有効)
《120000》 (sendDataOnExit 無効)
ユニット ミリ秒

New Relicとの通信中のエージェントの要求タイムアウト。

autoStart
タイプ Boolean
デフォルト True

初回計測メソッドのヒット時に、.NETエージェントを自動的に開始します。

プロキシ要素

『proxy』要素は、『service』要素のオプションの子要素です。エージェントがプロキシを介してNew Relicサービスと通信するには、このプロキシ要素を使用します。

この『proxy』要素は以下の属性に対応しています。

host
タイプ String
デフォルト  (なし)

プロキシのホストを定義します。

port
タイプ Integer
デフォルト 8080

プロキシのポートを定義します。

domain
タイプ String
デフォルト  (なし)

プロキシサーバーの認証に使用するドメインを定義します。(任意)

user
タイプ String
デフォルト  (なし)

認証のためのユーザー名を定義します。(任意)

password
タイプ String
デフォルト  (なし)

認証のためのパスワードを定義します。(任意)

ログ要素

『log』要素は、『configuration』要素の子要素です。この『log』要素はNew Relicのロギングを設定します。エージェントは独自のログファイルを生成し、ロギング情報をアプリケーションのログとは別に保持します。

この『log』要素は以下の属性に対応しています。

level
タイプ String
デフォルト  『info』

ログファイルに記録される詳細のレベルを定義します。可能な値は以下のとおりです(詳細の昇順)。

  • 『off』
  • 『emergency』
  • 『fatal』
  • 『alert』
  • 『critical』
  • 『severe』
  • 『error』
  • 『warn』
  • 『notice』
  • 『info』
  • 『debug』
  • 『fine』
  • 『trace』
  • 『finer』
  • 『verbose』
  • 『finest』
  • 『all』

ロギングレベルが上がると、New Relicのパフォーマンスの影響が大きくなります。

auditLog
タイプ Boolean
デフォルト 『false』

New Relicと送受信される全データを、監査ログファイルと標準ログファイルの両方に記録します。

console
タイプ Boolean
デフォルト 『false』

ログファイルに加えて、ログメッセージをコンソールに送信します。

directory
タイプ String
デフォルト 『 %PROGRAMDATA%\New Relic\.NET Agent\Logs』

エージェントが生成したログファイルの保存先ディレクトリ。これを省略した場合、デフォルトでは、New Relic Agentのインストール領域の【logs】というディレクトリを使用します。

fileName
タイプ String
デフォルト (なし)

ログファイル名を定義します。『fileName』を定義しない場合は、監視対象プロセス名に基づいた名前になります。

アプリケーション要素(設定)(必須)

『アプリケーション』要素は『設定』要素の子要素です。この要素はアプリケーション名を定義し、サンプリングを無効または有効にします。この要素は必須です。

name
タイプ String
デフォルト 『My Application』

.NETアプリケーション名はアプリケーション要素の子要素です。New Relicは、この名前に従ってデータを集計します。例えば、『AppA』と『AppB』という2つの実行中のアプリケーションがある場合、New RelicインターフェイスにAppAとAppBの2つのアプリケーションが表示されます。

更に、アプリケーションに複数の名前の指定も可能です。最初の名前がプライマリ名です。例:

disableSamplers
タイプ Boolean
デフォルト 『false』

サンプラーは、メモリとCPUの消費に関する情報を収集します。サンプリングを無効にするには『true』に設定します。

データ転送要素

『dataTransmission』要素は、『configuration』要素の子要素です。この要素は、データのNew Relicへの転送方法に影響し、特定のデータ転送要件がある場合に使用できます。

 

『dataTransmission』要件は次の属性に対応しています。

putForDataSend
タイプ Boolean
デフォルト 『false』

New Relicへのデータ送信に使用するHTTPメソッドを定義します。『true』に設定すると、データ送信時にPUTメソッドを使用可能にします。 POSTメソッドはデフォルトで使用されます。

compressedContentEncoding
タイプ String
デフォルト 『deflate』

New Relicへのデータ送信時のデータ圧縮方式を定義します。可能な値は次のとおりです。

  • 『deflate』
  • 『gzip』

 

計装オプション

これらのオプションを使用して、計装の環境やアプリケーション要素の設定を行います。.NETのNew Relicは、次のカテゴリーの計測オプションをサポートしています。

  • 計装要素
  • アプリケーション要素(計装)
  • 属性要素

計装要素

『instrumentation』要素は、『configuration』要素の子要素です。デフォルトでは、.NETエージェントはIIS aspワーカープロセスとAzure Webおよびワーカーロールを計測します。他のプロセスの計測は、カスタムアプリケーションをインストールするをご覧ください。

アプリケーション要素(計装)

『applications』要素は、計装要素の子要素です。このアプリケーション要素は、計測する非ウェブアプリケーションを指定します。それには『name』属性が含まれます。

これはアプリケーション(設定)要素(設定要素の子要素)と同一ではありません。

属性要素

属性は、イベントまたはトランザクションのプロパティを決定するキーと値のペアの事です。各『attribute』は、APMトランザクショントレース、APMエラートレース、Insightsトランザクションイベント、またはInsights PageViewイベントに送られます。第一属性要素は、.NETエージェントの属性収集を有効/無効にし、特定の属性の収集または除外を定義します。また、次のような目的に基づく属性設定も可能です。エラー収集、トレースのトランザクション、ページのロードタイミング、およびイベントのトランザクション

この例では、エージェントはmyApiKey(myApiKey.bar、myApiKey.value)で始まるキーの全属性を除外しますが、カスタム属性myApiKey.fooは収集します。

また、エージェントのAPIコール『AddCustomParameter』でも、カスタム属性を定義できます。

enabled
タイプ Boolean
デフォルト 『true』

属性の収集を有効/無効にします。第一属性要素の設定が『false』の場合、この設定が個々の目的地の全ての属性設定よりも優先されます。

include
タイプ String
デフォルト  (なし)

属性が有効な場合、エージェントはこのリストで指定されたすべての属性キーを収集します。複数の属性キーを指定するには、それぞれ個別に指定します。また、キーの末尾にワイルドカード文字「*」を使用して、複数の属性の照合も可能です(例『myApiKey.*』)。詳細は、属性のルールを参照してください。

exclude
タイプ String
デフォルト  (なし)

属性が有効の場合、エージェントはこのリストで指定されたどのアトリビュートキーも収集しません。複数の属性キーを指定するには、それぞれ個別に指定します。また、キーの末尾にワイルドカード文字「*」を使用して、複数の属性の照合も可能です(例『myApiKey.*』)。詳細は、属性のルールを参照してください。

 

PROプランのすべての機能を
14日間無料でお試し

新規無料登録いただくとPROプランのすべての機能を
14日間無料でお試しいただけます。
クレジットカードなど決済情報の登録は不要です。

各プランの詳細はこちらからご確認ください。