この章ではエージェント（Python）のインストール方法について説明します。

エージェント（Python）の対応環境

対応OS

エージェント（PHP）をインストールできるOSは次の通りです。

• Linux配布版

• MacOS

対応Pythonバージョン

• CPython 2.x : 2.7以上

• CPython 3.x : 3.3以上

対応フレームワーク

• Flask 0.11以上

• Django １.５以上

• fastapi 0.78.o以上

対応データベースドライバ

エージェントのインストール

pipを利用してインストールする方法

$ pip install jennifer-python

インターネットの接続制限などがあって上記のコマンドでインストールができない場合は、次のようにPythonパッケージとしてインストールすることができます。

# v2.x
$ python -m pip install <download_path>/jennifer_python-5.6.x.x-py2-none-any.whl
# v3.x
$ python -m pip install <download_path>/jennifer_python-5.6.x.x-py3-none-any.whl

①のコマンドを実行すると「jennifer-admin」ツールもインストールされます。これを実行してjennifer-pythonが使用する設定ファイルを生成します。

$ jennifer-admin generate-config

上記のコマンドを実行するとjennifer.iniファイルが生成されます。このファイルを開いて設定を行います。

生成した設定ファイルでJENNIFERを実行します。

$ JENNIFER_CONFIG_FILE=<設定ファイルパス> jennifer-admin run <python実行コマンド>
$ JENNIFER_CONFIG_FILE=<設定ファイルパス> jennifer-admin runasync <python実行コマンド>

<python実行コマンド>は、既存pythonウェブアプリケーションサーバを実行するコマンド(例、python manage.py runserver, uwsgi -i uwsgi.iniなど)を意味します。

例えば、jennifer.iniファイルが/home/user/jenniferディレクトリに存在して、既存pythonの実行コマンドが“uwsgi -i uwsgi.ini”でしたら、次のように実行します。

$ JENNIFER_CONFIG_FILE=/home/user/jennifer/jennifer.ini jennifer-admin run uwsgi -i uwsgi.ini

もし、uvicornのような非同期のサービスである場合は"runasync"オプションを使用して、次のように実行します。

$ JENNIFER_CONFIG_FILE=/home/user/jennifer/jennifer.ini jennifer-admin runasync uvicorn --loop asyncio main:app

2022/08/05 10:11:09 start agent > pid: 40289, ppid: 40288

2022/08/05 10:11:09 Agent Config: /Users/novalove/Works/pyapps/venv1/agent.python/jennifer.ini
----------------------
Data server host: 192.168.1.12
Data server port: 5000
Domain id: 1000
Instance id: 10000
2022/08/05 10:11:09 startUnixSocket: /var/folders/y6/_wy7csnx7wd1s3663y4s5fw00000gn/T/jennifer-1659661869.sock
2022/08/05 10:11:09 [Diag] startUnixSocket: listening...
2022/08/05 10:11:09 [Diag] [SessionRequest] ver = 5.6.0.15, server = 192.168.1.12, domain_id = 1000, inst_id = 10000, local_address = 192.168.1.11
2022/08/05 10:11:09 processing server message

pipを利用しないでインストールする方法

5.6.3.0以降からpipを利用せずにエージェントをインストールする方法を提供します。

$ pwd
/tmp
$ unzip jennifer_python-5.6.3.0-py3-none-any.whl

圧縮を解凍すると/tmp/jenniferディレクトリが生成されます。

「jennifer-admin」ツールの使用ができないため、jennifer-pythonが使用する設定ファイルを手動で生成します。

$ pwd
/home/user/jennifer$ vi jennifer.ini
  [JENNIFER]

  server_address = 127.0.0.1
  server_port = 5000
  domain_id = 1000
  inst_id = -1

  # log_dir = /tmp
  # service_dump_dir = /tmp

次のオプションの設定を適切に行います。

圧縮を解凍したパスをPYTHONPATH環境変数に、jennifer.iniファイルをJENNIFER_CONFIG_FILE環境変数に追加します。

$ export PYTHONPATH=/tmp/jennifer/admin
$ export JENNIFER_CONFIG_FILE=/home/user/jennifer/jennifer.ini

次のようにwsgi/asgi アプリケーションを実行するとJENNIFERエージェントが適用されます。

• 同期(wsgi)アプリケーションの場合

$ uwsgi -i uwsgi.ini

• 非同期(asgi) アプリケーションの場合

$ export JENNIFER_IS_ASYNC=true
$ uvicorn --loop asyncio main:app

Azure Web Appにインストールする方法

Azure ポータルにアクセスして [開発ツール] > [SSH] で SSH セッション画面にて、pip installコマンドでインストールします。

$ pip install jennifer-python -t /home/jennifer

$ pip install jennifer-python -t /home/jennifer2

Web App環境の場合、必ず、「/home」ディレクトリのサブディレクトリINIファイル作成する必要があります。

$ pwd
/home/jennifer$ vi jennifer.ini
  [JENNIFER]

  server_address = 127.0.0.1
  server_port = 5000
  domain_id = 1000
  inst_id = -1

  # log_dir = /tmp
  # service_dump_dir = /tmp

「Settings(設定) > Environment variables(環境変数)」画面にてINIファイルのパスを追加します。

[App settings]

NAME: JENNIFER_CONFIG_FILE
VALUE: /home/jennifer_conf.ini

次に、「Settings(設定) > Configuration(構成)」のスタートアップ コマンドに設定されている既存のコマンドに加え、jenniferの起動コマンドを追加します。

例えば、現在のスタートアップ コマンド値が「python -m uvicorn main:app --host 0.0.0.0.0」と設定されている場合、次のように追加します。

[General settings]

Startup Command: python /home/jennifer/jennifer/admin/__init__.py run python -m uvicorn main:app --host 0.0.0.0

注意事項

一部Webアプリケーションサーバの場合、jennifer-pythonの適切なデータ収集のために次のオプションの追加が必要です。

エージェントのアンインストール

次のコマンドを実行してJENNIFERパッケージを削除し、Pythonウェブサーバを再起動します。

$ pip uninstall jennifer-python

スタートアップ コマンドを元のコマンドに変更します。その後、Web Appを再起動すると既存のpip installの -t オプションで指定したディレクトリが削除されます。