Pythonエージェントの構成

通常、Pythonエージェントは、エージェントのホストシステム上のローカル構成ファイルから構成します。次のいずれかの方法を使用して、起動時に構成ファイルへのパスを指定します。

• newrelic.agent.initialize()を呼び出すときは、最初の引数として構成ファイルへのパスを指定します。

  また

• NEW_RELIC_CONFIG_FILE環境変数を設定します。newrelic-adminラッパースクリプトを使用する場合、ラッパースクリプトはエージェントを自動的に呼び出すため、環境変数を使用する必要があります。

  構成ファイルは、MicrosoftWindows .iniファイルと同様の構造を使用します。詳細については、PythonConfigParserモジュールのファイル形式のドキュメントを参照してください。

  ヒント

  サンプル構成ファイルは、Pythonエージェントにnewrelic/newrelic.iniとして含まれています。generate-configコマンドを使用してnewrelic-adminスクリプトから生成することも、ダウンロードリポジトリからコピーをダウンロードすることもできます。

サーバー側の構成では、NewRelicUIで特定の設定を構成できます。これにより、複数のホストにまたがって実行されている場合でも、すべてのエージェントに変更が自動的に適用されます。利用可能な場合、このドキュメントには、サーバー側のラベルとして、個々の構成オプションの下にサーバー側の構成のUIラベルが含まれています。

環境変数を使用すると、特定のコア設定のデフォルトをオーバーライドできます。同等の設定がエージェント構成ファイルに明示的にリストされている場合、構成ファイルの設定は環境変数よりも優先されます。利用可能な場合、環境変数は、 Environ変数として個々の構成オプションの下に以下に記載されています。

単純な構成の場合、サーバー側の構成と組み合わせて環境変数を使用し、エージェント構成ファイルを完全に回避できます。これはHerokuのデフォルト設定であり、New Relicアドオンをインストールすると、必要な環境変数が自動的に入力されます。

New Relic APMとCodeStreamを使用している場合は、リポジトリを関連付ける方法と、ビルドSHAまたはリリースタグをエラー受信ボックスに関連付ける方法をご覧ください。

特定のWSGIサーバーでは、リクエストごとにアプリ名とキャプチャ属性の設定を上書きできます。これは、リクエストごとのWSGI環境ディクショナリに渡される追加のキー/値のペアを定義できるWSGIサーバーで可能です。

これらの値は、文字列on 、 off 、 true 、 false 、 1 、および0で設定します。Pythonコードを使用して実装された構成メカニズムから設定された場合、TrueまたはFalseに評価されるPythonオブジェクトも受け入れられます。

特定のエージェント構成設定をオーバーライドできることに加えて、WSGI環境キーを使用して他の要求ごとの構成設定を設定できます。

NewRelicアカウントのライセンスキーを指定します。このキーは、アプリの指標をNewRelicアカウントに関連付けます。

NewRelicUIでデータを集約するために使用されるアプリケーション名。同時に複数のアプリにデータを報告するには、セミコロン;で区切られた名前のリストを指定します。セミコロンの前にスペースを入れないでください。スペースを入れると、Python構成パーサーが名前を埋め込みコメントとして解釈します。

trueの場合、エージェントはアプリに関するパフォーマンスデータを収集し、このデータをデータコレクターに報告します。

trueの場合、エージェントはWebアプリを計測しますが、実際のデータは送信しません。このオフラインモードでは、アクティブなエージェントの料金は請求されません。

開発者モードを使用して、エージェントの新しいバージョンをテストするか、開発者環境でサードパーティパッケージに対してエージェントをテストします。エージェントが収集するメトリックはどこにも報告されないため、オフラインモードはAPMをローカルで実行する方法ではありません。

ログファイルの名前を設定します。これは、エージェントの問題をデバッグするのに役立ちます。これはデフォルトでは設定されていません。エージェントは、Webアプリプロセスの親ユーザーや、そのプロセスが書き込みを許可されているディレクトリを認識していないためです。詳細については、 Pythonエージェントのロギングを参照してください。

これをどのように設定しても、含まれているディレクトリとファイル自体のアクセス許可が正しいこと、およびWebアプリケーションを実行するユーザーがファイルに書き込めることを確認してください。

ログファイルの場所を設定している場合は、ログメッセージの詳細レベルを設定します。このlog_levelは、Pythonロギングモジュールのログレベルには影響しません。可能な値は、詳細の昇順で、 critical 、 error 、 warning 、 info 、およびdebugです。

エージェントの問題を報告するには、最も便利な設定はdebugです。ただし、 debugは非常に迅速に多くの情報を生成するため、問題の再現にかかる時間よりも長くエージェントをこのレベルに維持しないでください。

高セキュリティモードでは、特定のセキュリティ設定が適用され、それらが上書きされないようにするため、機密データが送信されることはありません。高セキュリティモードを有効にすると、リクエストパラメータが収集されず、生のSQLを送信できなくなります。

高セキュリティモードを有効にするには、ローカルの.iniでtrueに設定します構成ファイルを作成し、UIのアカウント設定でアクティブ化します。詳細については、「高セキュリティ」を参照してください。

デフォルトでは、Pythonエージェントはサーバーに直接接続しようとします。ホストとコレクターの間にHTTPプロキシの使用を必要とするファイアウォールがある場合は、 proxy_hostとproxy_portをHTTPプロキシに必要な値に設定します。プロキシ認証がHTTPプロキシによって実装されている場合は、 proxy_userとproxy_passも設定します。

proxy_scheme設定は、HTTPプロキシとの通信に使用されるプロトコルスキームを示します。httpに設定すると、エージェントはエンドツーエンド暗号化のためにHTTPプロキシを介したSSLトンネルを使用します。

proxy_scheme 、 proxy_host 、およびproxy_portの設定を行う代わりに、 proxy_hostの設定をプロキシの有効なURIに設定することもできます。スキーム、ホスト、およびポートを含めます。たとえば、 http://proxy-host:8000 。これは、 NEW_RELIC_PROXY_HOST環境変数を使用してHTTPプロキシの詳細を設定した場合にも機能します。

監査ログファイルの名前を設定します。設定されている場合、エージェントは、監視対象プロセスとコレクターの間でやり取りされるメッセージの詳細をログに記録します。これにより、Pythonエージェントのセキュリティを評価できます。

起動時にアプリの作業ディレクトリがどうなるかわからない場合は、絶対パスを使用してください。これをどのように設定しても、含まれているディレクトリとファイル自体の権限が正しいことを確認してください。また、Webアプリの親ユーザーがファイルに書き込めることを確認してください。

タグを追加します。name：valueをコロン:で区切り、追加のタグをセミコロン;で区切ります。

Server:One;Data Center:Primary

APMUIに表示されるホスト名を設定します。設定されている場合、これはエージェントが自動的にキャプチャするデフォルトのホスト名を上書きします。

newrelic-adminrecord-deployで使用されるapi_keyを設定します。

ローカルCAバンドルへのパスの手動オーバーライド。このCAバンドルは、データ収集サービスによって提示されたSSL証明書を検証するために使用されます。

トランザクショントレースがこのしきい値を超えたときに記録します。形式は秒数です（小数点を使用できます）。

apdex_tの用語集エントリを参照してください

この設定を使用して、すべての属性をオンまたはオフにすることができます。

属性が有効になっている場合、このリストにある属性キーが送信されます。リスト内のキーは、以下に示すようにスペースで区切る必要があります。

key1 key2 key3

属性のルールは、エージェント属性ページにあります。

このリストにあるすべての属性キーが送信されるわけではありません。リスト内のキーは、以下に示すようにスペースで区切る必要があります。

key1 key2 key3

属性のルールは、エージェント属性ページにあります。

有効にすると、トランザクショントレーサーは遅いトランザクションに関する詳細情報をキャプチャします。

トランザクショントレースを収集するタイミングのしきい値（秒単位）。コントローラアクションの応答時間がこのしきい値を超えると、エージェントはトランザクショントレースを記録します。有効な値は、任意の正の浮動小数点数、またはapdex_f （ apdex_tの4倍）です。

トランザクショントレーサーが有効になっている場合、エージェントはSQLステートメントを記録できます。レコーダには、 off （SQLを送信しない）、 raw （SQLステートメントを元の形式で送信する）、およびobfuscated （数値リテラルと文字列リテラルを削除する）の3つのモードがあります。

ほとんどのWebフレームワーク（Djangoを含む）はSQLクエリをパラメーター化するため、クエリの入力に使用される値は実際には含まれていません。これらのフレームワークのいずれかでrawモードを使用する場合、Pythonエージェントは値を挿入する前にのみSQLを認識します。パラメータ化されたSQLは、 obfuscatedモードによく似ています。

SQL呼び出しからスタックトレースを収集するタイミングのしきい値（秒単位）。SQLステートメントがこのしきい値を超えると、エージェントは現在のスタックトレースをキャプチャします。これは、長いSQL呼び出しがアプリケーションで発生した場所を特定するのに役立ちます。

Pythonエージェントが遅いSQLクエリのクエリプランをキャプチャするかどうかを決定します。MySQLとPostgreSQLでのみサポートされています。

このしきい値を超えるトランザクショントレースのクエリは、遅いクエリデータと利用可能なExplainプランを報告します。transaction_tracer.explain_enabledがfalseの場合、プランの収集は行われません。

この設定を使用して、トランザクショントレースのすべての属性をオンまたはオフにすることができます。ルートレベルのattributes.enabledがfalseの場合、この構成設定（ transaction_tracer.attributes.enabled ）の設定に関係なく、トランザクショントレースに属性は送信されません。

トランザクショントレースで属性が有効になっている場合、このリストにあるすべての属性キーがトランザクショントレースで送信されます。詳細については、エージェント属性ルールを参照してください。

このリストにあるすべての属性キーは、トランザクショントレースで送信されるわけではありません。詳細については、エージェント属性ルールを参照してください。

指定された機能またはメソッドについて、エージェントは追加の機能タイミングインストルメンテーションをキャプチャします。これらの名前は、 module:functionまたはmodule:class.functionの形式で指定してください。

関数名とクラス名のワイルドカード（グロブ）は、 fnmatchモジュールでサポートされているパターンを使用して可能です。モジュールパスはワイルドカードではサポートされていません。パターンをmodule:function*またはmodule:class.*の形式で指定します。

たとえば、以下のファイルのすべての検証関数に関数トレースを追加する場合は、次のようになります。

def validate_credentials():
…
def validate_status():
…
def format_message():
…

次の行をエージェント構成ファイルに追加して、ワイルドカードを使用してmy-app/common/utils.py内のすべての検証関数への関数トレースを含めます。

[newrelic]
...
transaction_tracer.function_trace = common.utils:validate*

この設定を使用して、トランザクショントレースのセグメントのすべての属性をオンまたはオフにすることができます。ルートレベルのattributes.enabledがfalseの場合、この構成設定（ transaction_segments.attributes.enabled ）の設定に関係なく、トランザクショントレースのセグメントに属性は送信されません。

トランザクショントレースのセグメントで属性が有効になっている場合、このリストにあるすべての属性キーは、トランザクショントレースのセグメントで送信されます。詳細については、エージェント属性ルールを参照してください。

このリストにあるすべての属性キーは、トランザクショントレースのセグメントで送信されるわけではありません。詳細については、エージェント属性ルールを参照してください。

有効にすると、エラーコレクタはキャッチされなかった例外に関する情報をキャプチャします。

特定のエラーの収集を停止するには、これを無視するPython例外タイプ名のスペースで区切られたリストに設定します。例外名には形式module:classを使用します。

エージェントがエラーとして記録するのではなく無視する必要があるHTTPステータスコードを一覧表示します。追加の状況コードをスペースで区切られた整数としてリストし、開始値と終了値の間にハイフン-区切り文字を使用して範囲を指定します。デフォルトコードの1つを許可リストに追加するには、コードの前に感嘆符!を付けます。

一部のフレームワークは例外を使用してHTTP応答を返さないため、この設定は一部のWebフレームワークとのみ互換性があります。

指定された例外クラスがエラー率またはApdexスコアに影響を与えずに、エラーをAPMに報告するのを防ぎます。これを、予期されるPython例外タイプ名のスペースで区切られたリストに設定します。例外名には形式module:classを使用します。

指定されたHTTPステータスコードがエラー率またはApdexスコアに影響を与えずに、エラーをAPMに報告するのを防ぎます。ステータスコードをスペースで区切られた整数としてリストし、開始値と終了値の間にハイフン-区切り文字を使用して範囲を指定します。リスト内のコードの1つを無効にするには、コードの前に感嘆符!を付けます。

一部のフレームワークは例外を使用してHTTP応答を返さないため、この設定は一部のWebフレームワークとのみ互換性があります。

この設定を使用して、トレースされたエラーのすべての属性をオンまたはオフにすることができます。attributes.enabledがルートレベルでfalseの場合、この構成設定（ error_collector.attributes.enabled ）がどのように設定されているかに関係なく、トレースされたエラーに属性は送信されません。

トレースされたエラーに対して属性が有効になっている場合、このリストにあるすべての属性キーがトレースされたエラーで送信されます。詳細については、エージェント属性ルールを参照してください。

このリストで見つかった属性キーは、トレースされたエラーでは送信されません。詳細については、エージェント属性ルールを参照してください。

有効にすると、エラーコレクターは高度な分析のためにイベントデータをキャプチャします。詳細については、 APMエラーを参照してください。

ブラウザの監視を有効にします。詳細については、Pythonでのページの読み込みタイミングを参照してください。

サポートされているPythonWebフレームワークの場合、この設定により、JavaScriptフラグメントを監視するブラウザーの自動挿入が有効になります。

ブラウザ監視エージェントが自動計測するHTML Content-Typeを指定します。スペースで区切られたリストにエントリを追加します。

browser_monitoring.content_type = text/html application/xhtml+xml

この設定を使用して、ブラウザ監視のすべての属性をオンまたはオフにすることができます。これは、ページビューイベントに送信されるデータです。ルートレベルでattributes.enabledがfalseの場合、構成設定（ browser_monitoring.attributes.enabled ）がどのように設定されているかに関係なく、ブラウザの監視で属性は送信されません。

属性がbrowser_monitoringに対して有効になっている場合、このリストにあるすべての属性キーがページビューで送信されます。詳細については、エージェント属性ルールを参照してください。

このリストにあるすべての属性キーは、ページビューでは送信されません。詳細については、エージェント属性ルールを参照してください。

トランザクションイベントデータを使用すると、ヒストグラムやパーセンタイルなどの追加情報を使用できます。

この設定を使用して、トランザクションイベントのすべての属性をオンまたはオフにすることができます。ルートレベルでattributes.enabledがfalseの場合、この構成設定（ transaction_events.attributes.enabled ）の設定に関係なく、トランザクションイベントに属性は送信されません。

属性がトランザクションイベントに対して有効になっている場合、このリストにあるすべての属性キーがトランザクションイベントで送信されます。詳細については、エージェント属性ルールを参照してください。

このリストにあるすべての属性キーは、トランザクションイベントでは送信されません。トランザクションイベントから属性を除外しても、スパンイベントから除外されないことに注意してください。詳細については、エージェント属性ルールを参照してください。

record_custom_event()を介してイベントAPIへのイベントの記録を許可します。

有効にすると、エージェントは一部のデータベースドライバーのデータストアインスタンスメトリック（ホストやポートなど）を収集します。これらは、低速のクエリトレースとトランザクショントレースでも報告されます。

有効にすると、エージェントは一部のデータベースドライバーのデータベース名を収集します。データベース名は、低速のクエリトレースとトランザクショントレースで報告されます。

分散トレースを有効にします

この設定を使用して、Pythonエージェントがスパンを送信するかどうかをオンまたはオフにすることができます。

この設定を使用して、スパンイベントのすべての属性をオンまたはオフにすることができます。ルートレベルのattributes.enabledがfalseの場合、この構成設定（ span_events.attributes.enabled ）の設定に関係なく、スパンイベントに属性は送信されません。詳細については、エージェント属性ルールを参照してください。

スパンイベントに対して属性が有効になっている場合、このリストにあるすべての属性キーがスパンイベントで送信されます。詳細については、エージェント属性ルールを参照してください。

このリストにあるすべての属性キーは、スパンイベントで送信されるわけではありません。詳細については、エージェント属性ルールを参照してください。

PythonエージェントのインスタンスからNewRelicに送信される1分あたりの分析イベントの制限。

PythonエージェントのインスタンスからNewRelicに送信される1分あたりのカスタムイベントの制限。カスタムイベントは、PythonTelemetrySDKを介して作成されます。

PythonエージェントのインスタンスからNewRelicに送信される1分あたりのスパンイベントの制限。

PythonエージェントのインスタンスからNewRelicに送信される1分あたりのエラーイベントの制限。

イベントループ情報を無効にするには、これをfalseに設定します。

トランザクションがイベントループ情報を生成する前にイベントループをブロックする必要がある時間のしきい値（秒単位）。

有効にすると、エージェントはガベージコレクションメトリックを生成して送信します。

エージェントは、ガベージコレクターによって収集されている最も一般的なオブジェクトタイプのオブジェクトカウントメトリックを報告します。この設定では、オブジェクトタイプごとに、サンプリングされる個々のメトリックの最大数を設定できます。

これをfalseに設定すると、コードレベルのメトリックのエージェント属性の収集が無効になります。

コミット社。シャ全体を使用することも、最初の7文字だけを使用することもできます（例：734713b）。

リリースタグ（v0.1.209など）またはリリース-209）。

trueの場合、これらのサブ機能構成も有効になっている場合は、ログの装飾とログイベントおよびログメトリックの収集を有効にします。falseの場合、ロギングインストルメンテーション機能は有効になりません。

trueの場合、エージェントはアプリケーションによって発行されたログレコードをキャプチャし、それらをNewRelicに転送します。この設定を有効にするには、 application_logging.enabledもtrueである必要があります。

NewRelicに1分あたりに送信するログレコードの数。この設定は、ログ転送機能を使用するときの全体的なメモリ消費を制御します。

trueの場合、エージェントは、アプリケーションによって送信されているログ行に関連するメトリックをキャプチャします。この設定を有効にするには、 application_logging.enabledもtrueである必要があります。

trueの場合、エージェントはログをメタデータで装飾して、エンティティ、ホスト、トレース、およびスパンにリンクします。この設定を有効にするには、 application_logging.enabledもtrueである必要があります。

trueの場合、エージェントはAWS環境で実行されていることを自動的に検出します。

trueの場合、エージェントはAzure環境で実行されていることを自動的に検出します。

trueの場合、エージェントはGoogleCloudPlatform環境で実行されていることを自動的に検出します。

trueの場合、エージェントはPivotalCloudFoundry環境で実行されていることを自動的に検出します。

trueの場合、エージェントはDockerで実行されていることを自動的に検出します。

有効にすると、エージェントは長時間実行されるSQLデータベースクエリから詳細をキャプチャします。

スレッドプロファイリングセッションをスケジュールできます。スレッドプロファイラーは、アプリケーション内のアクティブなスレッドごとに呼び出しスタックのスナップショットを定期的にキャプチャして、統計的に代表的な呼び出しツリーを構築します。

クロスアプリケーショントレースを有効にします。これにより、サービス指向アーキテクチャ内でアプリとサービスが接続されます。

有効にすると、機密情報が誤って取得されるのを防ぐために、例外メッセージがコレクターに送信される前にエラートレースから削除されます。このオプションは、高セキュリティモードで自動的に有効になります。

許可リストにリストされている例外は、 strip_exception_messages.enabledがtrueであっても、メッセージが削除されることはありません。許可リストは、スペースで区切られた例外タイプの文字列であり、それぞれmodule:exception_nameの形式です。組み込みの例外をexception_nameとしてリストします;それらの前にmodule:を付ける必要はありません。

例：組み込みの例外とユーザー定義の例外

KeyError my_module:MyException

デフォルトでは、エージェントは最初のトランザクション（Webまたは非Webのいずれか）を受信したときに開始します。次に、エージェントは並行して開始し、この最初の要求が遅延しないようにします。ただし、エージェントは登録が完了するまでデータを収集できないため、この最初のリクエストの詳細を記録しません。

これを上書きするには、起動タイムアウトを秒単位で設定できます。その後、エージェントは最初のトランザクションを一時停止し、登録が完了するのを待ちます。

プロセスのシャットダウン時に、エージェントはコレクターへの最後のアップロードを1回試行します。問題が発生した場合にエージェントが無期限に実行されるのを防ぐために、 shutdown_timeoutのしきい値に達すると、プロセスは正常にシャットダウンします。このシャットダウンによりデータが失われる可能性がありますが、エージェントはアップロードプロセス中に主要なメトリックデータを優先します。

バックグラウンドタスクキューイングシステム、特にプロセスごとに少数のタスクを実行するシステムの場合、エージェントがプロセスのシャットダウン時にすべてのデータをアップロードできるように、シャットダウンタイムアウトを増やすことができます。

ペイロードでデータ圧縮しきい値に達した場合、エージェントはデフォルトでgzip圧縮を使用してデータを圧縮します。構成オプションcompression_content_encodingをdeflateに設定して、deflate圧縮を使用できます。

trueの場合、エージェントはホスト名としてHerokudyno名を使用します。

通常、エージェントは、末尾にドットとプロセスIDが付いたdyno名を報告します（たとえば、 worker.3 ）。末尾のデータなしでレポートするプレフィックスを指定することで、この末尾のデータを削除できます（たとえば、 worker ）。

構成ファイルに以下を追加します。

[import-hook:MySQLdb]
enabled = false