Python エージェント：高度なインテグレーション

Pythonエージェントパッケージをインストールして設定ファイルを作成した後、アプリケーションにPythonエージェントを統合する必要があります。このステップでは、エージェントがアプリケーションの重要な関数およびWebリクエストをキャプチャーして、これをレポートすることが可能となります。

インテグレーションには2つのメソッドがあります：

• コマンドライン経由でAdminスクリプトを実行する：この方法は簡単で、アプリコードの変更を必要としないため推奨されています。
• 手動インテグレーション：Adminスクリプトメソッドを使用できない場合は、アプリコード内でPythonエージェントを手動で初期化できます。

Adminスクリプトのインテグレーションメソッド

コマンドライン経由でAdminスクリプトを使用する方法の簡単な解説に関しては、上級インストール手順のインテグレーションセクションを参照してください。以下に、詳細とコンテキストをさらに解説しています。

newrelic-adminは、ご利用のWSGIサーバーもしくはWebアプリケーションの起動に使用するコマンドに接頭辞をつけます。このスクリプトは、起動コマンドにラップして、共通のフレームワークによって使用される一定の関数クラスにリッスンすることで機能します。（デフォルトでインストゥルメントされていない関数およびメソッドをインストゥルメントするには、カスタムインストゥルメンテーションを使用します。）

以下に示すのは、このスクリプトを実行した例です：

以下の例では、Bourneシェルについて解説しています。異なるシェルに応じて、こうした解説を調整する必要があるかもしれません。

gunicorn -w 3 wsgi:application

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

newrelic-admin run-program paster serve production.ini

Adminスクリプトの使用をめぐるフレームワーク特有のドキュメンテーションに関しては、Webフレームワークおよびサーバーを参照してください。

以下に示すのは、Adminスクリプトを実行するにあたっての上級手順になります：

NEW_RELIC_CONFIG_FILE=newrelic.ini
export NEW_RELIC_CONFIG_FILE

newrelic-admin run-program YOUR_COMMAND_OPTIONS

NEW_RELIC_CONFIG_FILE=newrelic.ini
export NEW_RELIC_CONFIG_FILE

exec newrelic-admin run-program YOUR_COMMAND_OPTIONS

[program:warpdrive]
command = newrelic-admin run-program YOUR_COMMAND_OPTIONS
environment = NEW_RELIC_CONFIG_FILE=newrelic.ini

newrelic-admin run-program python main.py
newrelic-admin run-python main.py

[program:warpdrive]
command = newrelic-admin run-program  
environment = PATH="/path/to/python/app/venv/bin",NEW_RELIC_CONFIG_FILE="newrelic.ini" directory = /path/to/python/app user = www-data

詳細に関しては、Adminスクリプトの詳細を参照してください。

アプリケーションコードにおける手動インテグレーション

推奨されるAdminスクリプトインテグレーションを使用できない場合は、Webアプリコード内でPythonエージェントを手動で初期化する必要があります。これには、アプリケーションにPythonエージェントパッケージをインポートして、呼び出しを行ってエージェントを初期化するプロセスが伴います。このコールは、アプリケーションのインポートメカニズムを修正することで、ライブラリがインポートされた場合にエージェントが認識した関数クラスをリッスンします。

手動のインテグレーションでは、アプリケーションのスクリプトファイルの冒頭もしくはWSGIのエントリーポイントを持つモジュールに、以下を追加します。

import newrelic.agent
newrelic.agent.initialize('/some/path/newrelic.ini')
... YOUR_OTHER_IMPORTS

この例において、/some/path/newrelic.iniはPythonエージェントのインストレーション中に作成された設定ファイルのコピーのロケーションを表しています。設定ファイルは、ご利用のWebアプリケーションによって読み込み可能でなくてはいけません。

import newrelic.agent
newrelic.agent.initialize('/some/path/newrelic.ini', 'staging')

import newrelic.agent
newrelic.agent.initialize()

サポートされていないWebフレームワーク

サポートされていないWebフレームワークを使用しているか、WerkzeugもしくはPasteなどのWSGIコンポーネントを使用してWSGIアプリケーションを構築している場合、WSGI アプリケーションのエントリーポイントを手動でラップする必要があるかもしれません。これは、メインとなるインテグレーション方法（Adminスクリプトの使用またはPythonエージェントの手動初期化）に加えて行います。

WSGIアプリケーションのエントリーポイントが、ファイル自体で宣言された関数である場合、デコレータを使用します：

@newrelic.agent.wsgi_application()
def application(environ, start_response):
...

WSGIアプリケーションのエントリーポイントが、別のモジュールからインポートされた関数もしくはオブジェクトである場合、ラッパーオブジェクトでラップします：

import myapp
application = myapp.WSGIHandler()
application = newrelic.agent.WSGIApplicationWrapper(application)

サポートされるWebフレームワークが使用されている場合でも、デコレータまたはラッパーを明示的に使用できます。例えば、サポートされるWebフレームワーク周辺に追加のWSGIミドルウェアを設定する場合などです。こうして、すべてのWSGIミドルウェアの実行が、エージェントによる監視によって確実に網羅されることになります。

詳しくは、wsgi_application()とWSGIApplicationWrapperラッパーのドキュメントを参照してください。

その他のヘルプ

さらに支援が必要な場合は、これらのサポートと学習リソースを確認してください：

• Explorers Hubを参照して、コミュニティから支援を受け、ディスカッションに参加してください。
• 当社のサイトで回答を見つけ、サポートポータルの使用方法について学びます。
• Linux、Windows、およびmacOSのトラブルシューティングツールであるNew Relic Diagnosticsを実行します。
• New Relicのデータセキュリティとライセンスドキュメントを見直してください。