Pythonエージェントパッケージをインストールして設定ファイルを作成した後、アプリケーションにNew RelicのPythonエージェントを統合する必要があります。このステップでは、エージェントがアプリケーションの重要な関数およびWebリクエストをキャプチャーして、これをレポートすることが可能となります。
インテグレーションには、以下の2つのメソッドがあります。
Adminスクリプトのインテグレーションメソッド
コマンドラインでAdminスクリプトを使用する方法の簡単な説明に関しては、詳細インストール手順のインテグレーションセクションを参照してください。以下に、詳細とコンテキストをさらに解説しています。
newrelic-adminは、WSGIサーバーまたはウェブアプリの起動に使用するコマンドにAdminスクリプト接頭辞を付けます。このスクリプトは、起動コマンドにラップして、共通のフレームワークによって使用される特定の関数クラスをリッスンすることで機能します。（デフォルトでインストゥルメントされていない関数およびメソッドをインストゥルメントするには、カスタムインストゥルメンテーションを使用します。）
以下に示すのは、このスクリプトを実行した例です。
古いコマンド形式 | 新しいコマンド形式 |
|---|
YOUR_ORIGINAL_COMMAND_OPTIONS
| NEW_RELIC_CONFIG_FILE=newrelic.ini newrelic-admin run-program YOUR_ORIGINAL_COMMAND_OPTIONS
|
VARIABLE=VALUE YOUR_ORIGINAL_COMMAND_OPTIONS
| NEW_RELIC_CONFIG_FILE=newrelic.ini VARIABLE=value newrelic-admin run-program YOUR_ORIGINAL_COMMAND_OPTIONS
|
以下の例は、Bourneシェルについて解説しています。異なるシェルに応じて、こうした解説を調整する必要があるかもしれません。
Gunicornを使用しており、起動コマンドが以下である場合：
gunicorn -w 3 wsgi:application
新しいagent-integratedコマンドは、次のようになります。
NEW_RELIC_CONFIG_FILE=newrelic.ini newrelic-admin run-program gunicorn -w 3 wsgi:application
newrelic-admin run-program uwsgi --socket /tmp/uwsgi.sock --single-interpreter --enable-threads wsgi.py
以下に示すのは、paster ini設定ファイルで指定されたWSGIアプリケーション上で、paster serveを使用してAdminスクリプトを実行する際の例です。
newrelic-admin run-program paster serve production.ini
Adminスクリプトの使用をめぐるフレームワーク特定のドキュメンテーションに関しては、Webフレームワークおよびサーバーを参照してください。
以下に示すのは、Adminスクリプトを実行するにあたっての詳細手順です。
スクリプトを実行する前に、NEW_RELIC_CONFIG_FILE環境変数を別々に設定してエクスポートできます。必ず、YOUR_COMMAND_OPTIONSの既存のコマンドオプションを置き換えてください。
NEW_RELIC_CONFIG_FILE=newrelic.ini
export NEW_RELIC_CONFIG_FILE
newrelic-admin run-program YOUR_COMMAND_OPTIONS
起動コマンドがexecを使用する場合、環境変数の設定とAdminスクリプトの実行を区別してください。必ず、YOUR_COMMAND_OPTIONSの既存のコマンドオプションを置き換えてください。
NEW_RELIC_CONFIG_FILE=newrelic.ini
export NEW_RELIC_CONFIG_FILE
exec newrelic-admin run-program YOUR_COMMAND_OPTIONS
環境変数を別々の構成設定にしなくてはならないsupervisordなどのプロセス管理システムを使用する場合は、コマンドと同じラインに設定することはできません。
たとえば、supervisordで、以下を使用する場合があります。既存のコマンドオプションをYOUR_COMMAND_OPTIONSに置き換えてください。
[program:warpdrive]
command = newrelic-admin run-program YOUR_COMMAND_OPTIONS
environment = NEW_RELIC_CONFIG_FILE=newrelic.ini
実行するコマンドがpythonの実行ファイルであり、それがpython main.pyとしてPythonコードファイル上で直接実行されている場合は、次のいずれかを使用してください。
newrelic-admin run-program python main.py
newrelic-admin run-python main.py
run-pythonを使用することで、 常に、Pythonインストレーションにインストールされたもの、またはnewrelic-adminがインストールされた仮想環境と同じpythonの実行ファイルを使用します。
実行するnewrelic-adminプログラムは、ご利用のアプリケーションが使用しているものと同じPythonインストレーションまたは仮想環境に由来するものである必要があります異なるPythonインストレーションに由来するプログラム/コンポーネントは混合できません。これを行うと、エージェントが正しく動作しません。
仮想環境でsupervisordなどのプロセスマネジメントシステムを使用する場合、以下の設定を使用できます。
command = newrelic-admin run-program
environment = PATH="/path/to/python/app/venv/bin",NEW_RELIC_CONFIG_FILE="newrelic.ini"
directory = /path/to/python/app
PATH環境変数が示すパスは、仮想環境で使用するものと同一のパスである点に注意してください。
このようなnewrelic-adminに関するオプション、またユーザーの環境変数に基づくさまざまな設定オプションの詳細については、run-programおよびrun-pythonオプションの詳細なドキュメンテーションを参照してください。
詳細については、Adminスクリプトの詳細を参照してください。
アプリコードにおける手動インテグレーション
推奨されるAdminスクリプトインテグレーションを使用できない場合、または使用しない場合は、ウェブアプリコードでPythonエージェントを手動で初期化する必要があります。これには、アプリにPythonエージェントパッケージをインポート、呼び出してエージェントを初期化するプロセスが伴います。このコールは、アプリケーションのインポートメカニズムを修正することで、ライブラリがインポートされた場合にエージェントが認識した関数クラスをリッスンします。
手動のインテグレーションでは、アプリケーションのスクリプトファイルの冒頭、またはWSGIのエントリーポイントを保持するモジュールに、以下を追加します。
重要
標準的なPythonの機能性とは異なり、ここではインポートの順序が重要となります。エージェントパッケージを最初にインポートする必要があります。
import newrelic.agent
newrelic.agent.initialize('/some/path/newrelic.ini')
... YOUR_OTHER_IMPORTS
この例では、/some/path/newrelic.iniは、Pythonエージェントのインストレーション中に作成された設定ファイルのコピーの場所を表しています。設定ファイルは、Webアプリケーションによって読み込み可能である必要があります。
特定のデプロイメント環境に対応したエージェント設定ファイルでオーバーライドを指定するには、initialize()関数の2つ目の引数として、その環境名を指定します。PythonパッケージをPythonの仮想環境にインストールした場合は、sys.pathをアクティブ化、またはセットアップ後にこれらの行を追加して、仮想環境を見つける必要があります。
import newrelic.agent
newrelic.agent.initialize('/some/path/newrelic.ini', 'staging')
この手順は、可能な限り、インストゥルメントされるモジュールのインポートより先に行います。Flaskなどのウェブフレームワークには、これは必須です。インストゥルメンテーションは、そのフレームワークのコードがインポートされるすべてのインポートの前に配置しないと正しく機能しません。
Adminスクリプトを使用しないが、引き続きNEW_RELIC_CONFIG_FILEとNEW_RELIC_ENVIRONMENT環境変数を使用してエージェントを設定する場合は、引数なしでinitialize()関数を呼び出すと、これらの環境変数を自動的に読み込みできます。
newrelic.agent.initialize()
または、その他のすべての構成設定のデフォルトが適切であれば、NEW_RELIC_LICENSE_KEYとNEW_RELIC_APP_NAME環境変数を設定できます。
Apache/mod_wsgiなどの組み込み環境では、一般的に、環境変数から設定を導出することは難しくなります。これは、通常、組み込みシステムではWSGIスクリプトファイルで使用できるプロセスの環境変数を設定できないためです。詳細については、initialize()関数のドキュメントを参照してください。
サポートされていないWebフレームワーク
サポートされていないウェブフレームワークを使用している、または、WerkzeugまたはPasteなどのWSGIコンポーネントを使用してWSGIアプリケーションを構築している場合は、WSGIアプリケーションのエントリーポイントを手動でラップする必要もあります。これは、メインとなるインテグレーション方法（Adminスクリプトの使用またはPythonエージェントの手動初期化）に加えて行います。
WSGIアプリケーションのエントリーポイントが、ファイル自体で宣言された関数である場合は、デコレータを使用します。
@newrelic.agent.wsgi_application()
def application(environ, start_response):
WSGIアプリケーションのエントリーポイントが、別のモジュールからインポートされた関数またはオブジェクトである場合は、ラッパーオブジェクトでラップします。
application = myapp.WSGIHandler()
application = newrelic.agent.WSGIApplicationWrapper(application)
サポートされているウェブフレームワークが使用されている場合でも、デコレータまたはラッパーを明示的に使用できます。たとえば、サポートされているウェブフレームワーク周辺に追加のWSGIミドルウェアを設定する場合などです。こうして、すべてのWSGIミドルウェアの実行が、エージェントによる監視によって確実に網羅されることになります。
詳細については、wsgi_application()とWSGIApplicationWrapperラッパーのドキュメントを参照してください。
その他のヘルプ
さらに支援が必要な場合は、これらのサポートと学習リソースを確認してください：