IBM Cloud Application Performance Management

Python エージェントの構成

エージェントがモニター対象の Python アプリケーションからデータを収集できるように、Monitoring Agent for Python を構成する必要があります。

始める前に

エージェントを構成する前に、必ず Apache HTTPD サーバーを始動してください。

Apache HTTPD サーバーの httpd.conf 構成ファイルを開き、mod_status がロードされていることを確認します。

httpd.conf 構成ファイルにコード変更を加えていないモニター対象の Apache サーバーで、コマンド apachectl status が正しく動作することを確認します。正しく動作しない場合、ダッシュボードの一部のメトリック (ビジー・ワーカーやアイドル・ワーカーなど) が表示できない可能性があります。

注: コマンド apachectl status が正しく動作するためには、Lynx がインストールされていなければなりません。コマンドの有効化について詳しくは、『apachectl - Apache HTTP Server Control Interface』を参照してください。

エージェント・インスタンスの構成が初めてではない場合、以下のステップを実行します。

エージェント・インスタンスを停止します。
以下のいずれかの手順に従いエージェント・インスタンスを構成します。
- サイレント応答ファイルを編集してエージェントを構成する。
- プロンプトに応答を入力してエージェントを構成する。
新しいミドルウェアが Django 設定フォルダーにデプロイされていることを確認します。これを行うには、Django 設定フォルダーの kpg_numeric_string.py ファイルが更新されていることを確認します。
Apache サーバーを再始動します。

このタスクについて

エージェントの構成時に権限の問題が発生しないようにするために、必ず、エージェントのインストールに使用したのと同じ root ユーザー ID または非 root ユーザー ID を使用してください。選択されたユーザーとしてエージェントをインストールした後で、別のユーザーとしてエージェントを構成する場合は、非 root ユーザーとしてのエージェントの構成を参照してください。選択されたユーザーとしてエージェントをインストールおよび構成した後で、別のユーザーとしてエージェントを開始する場合は、非 root ユーザーとしてのエージェントの開始を参照してください。

Python エージェントは複数インスタンス・エージェントです。最初のインスタンスを作成し、エージェントを手動で開始する必要があります。管理対象システム名には、指定するインスタンス名が含まれます (例: instance_name:host_name:pc)。ここで pc は、ご使用の製品の 2 文字の製品コードです。管理対象システム名は 32 文字に制限されています。指定するインスタンス名は 28 文字 (ホスト名の字数は除く) までに制限されています。例えば、インスタンス名に Python2 を指定すると、管理対象システム名は Python2:hostname:PG になります。

重要: 長いインスタンス名を指定した場合、管理対象システム名は切り捨てられ、エージェント・コードが正しく表示されません。

手順

サイレント応答ファイルを編集し、対話操作なしでスクリプトを実行することでエージェントを構成するには、以下の手順を実行します。
1. テキスト・エディターで install_dir/samples/python_silent_config.txt を開きます。ここで、install_dir は Python エージェントのインストール・ディレクトリーです。デフォルトのインストール・ディレクトリーは、/opt/ibm/apm/agent です。
2. HTTPD listening port には、ある HTTPD プロセス・グループを別のグループから識別するためのポート番号を指定します。デフォルトは 80 です。
  注:
  - ご使用の Apache サーバーが複数のポートを listen している場合は、このパラメーターにそのいずれかを指定できます。
  - 同一のシステム上で複数の Apache サーバーが稼働している場合は、Django アプリケーションが実行されているサーバーのポートを指定する必要があります。
  - 同じ Apache サーバーで異なるポートを使用している Python アプリケーション・インスタンスをモニターするために複数のエージェント・インスタンスを使用する場合、ポートの指定に加えて、異なる Django WSGI エントリー・ポイントの指定も次のステップで行う必要があります。ポートのみを指定する場合、エージェント・インスタンスは同じサーバーをモニターし、そのデータは同じになります。
3. Is Python 3 については、このフィールドの値が false の場合、Python 環境は Python バージョン 2.x と見なされます。Python のバージョンが 3.x の場合、値を false 以外 (true など) に変更します。デフォルト値は false です。
4. Django WSGI entry points には、Django WSGI のエントリー・ポイントを指定します。複数のエントリー・ポイントを区切るにはコロンを使用します。
  例えば、Apache 構成ファイル内に以下の構成行がある場合があります。
  WSGIScriptAlias / /var/www/html/mysite/mysite/wsgi.py
  この例では、/var/www/html/mysite/mysite/wsgi.py がエントリー・ポイントとして指定されています。
  
  Apache 構成ファイル内にあるすべてのエントリー・ポイントを含めるには、このパラメーターをブランクのままにします。
  注: 別のエージェント・インスタンスに同じ Django WSGI エントリー・ポイントを指定しないでください。デフォルト・オプションを使用し、あるエージェント・インスタンスが Apache サーバーをモニターするように構成する場合、その他のエージェント・インスタンスがそのサーバーをモニターするように構成しないでください。
5. Django settings for the monitored application には、モニター対象アプリケーションの Django 設定 (my_project.settings など) を指定します。デフォルト値を使用する場合は、このフィールドを空のままにしておいてください。
6. Minimum recorded response time には、平均応答時間をミリ秒単位で設定します。速さがこの数値以上 (時間がこの数値以下) の要求は記録されません。デフォルトは 300 です。
7. Slow request threshold には、低速要求しきい値をミリ秒単位で設定します。デフォルトは 500 です。
8. Extreme slow request threshold には、最低速要求しきい値をミリ秒単位で設定します。デフォルト値は 7000 です。
9. Profiler report interval には、エージェントが低速要求のプロファイラー・レポートを生成する間隔を分単位で設定します。この値の最小設定は 10 です。これにより、過度のプロファイル作成が原因でアプリケーションが低速になることを回避できます。通常はこの値に 10 より大きい数値を設定します。デフォルトは 10 です。
  また、このパラメーターは、モニター・データを集約する方法をエージェント・スクリプトに指示します。各分の最初に、モニター・ミドルウェアは、前の分で収集されたデータをリセットし、新しい生データ・ファイルの書き込みを開始します。エージェント・スクリプトは、このパラメーターに基づいて生データを要約して結果を返します。例えば、この数値が 10 分の場合、エージェント・スクリプトは、過去 10 分のすべての生データを集約して結果を返します。最終結果は、1 つの特定の URL の応答時間などの平均、または要求の合計数や合計トラフィック・バイトなどの合計になることがあります。
10. python_silent_config.txt フィルを保存して閉じてから、以下を入力します。
  install_dir/bin/python-agent.sh config instance_name install_dir/samples/python_silent_config.txt
  ここで、instance_name はインスタンスに指定する名前であり、install_dir は Python エージェントのインストール・ディレクトリーです。デフォルトのインストール・ディレクトリーは、/opt/ibm/apm/agent です。
11. エージェントを開始するには、以下を入力します。
  install_dir/bin/python-agent.sh start instance_name
スクリプトを実行し、プロンプトに応答を入力してエージェントを構成する場合は、以下の手順を実行します。
1. 以下を入力します。
  install_dir/bin/python-agent.sh config instance_name
  ここで、instance_name はインスタンスに指定する名前であり、install_dir は Python エージェントのインストール・ディレクトリーです。デフォルトのインストール・ディレクトリーは、/opt/ibm/apm/agent です。
2. Edit Monitoring Agent for Python settings というプロンプトが出されたら、1 を入力して続行します。
3. HTTP listening port というプロンプトが出されたら、Enter キーを押してデフォルトを受け入れるか、ポート番号を指定します。
  注:
  - ご使用の Apache サーバーが複数のポートを listen している場合は、このパラメーターにそのいずれかを指定できます。
  - 同一のシステム上で複数の Apache サーバーが稼働している場合は、Django アプリケーションが実行されているサーバーのポートを指定する必要があります。
  - 同じ Apache サーバーで異なるポートを使用している Python アプリケーション・インスタンスをモニターするために複数のエージェント・インスタンスを使用する場合、ポートの指定に加えて、異なる Django WSGI エントリー・ポイントの指定も次のステップで行う必要があります。ポートのみを指定する場合、エージェント・インスタンスは同じサーバーをモニターし、そのデータは同じになります。
4. Is Python 3 というプロンプトが出されたら、Python のバージョンが 3 でない場合は、false を入力します。Python のバージョンが 3.x の場合は、false 以外の値 (例: true) を入力します。デフォルト値は false です。
5. Django WSGI entry points というプロンプトが出されたら、このパラメーターをブランクのままにするか、エントリー・ポイントを指定します。
  注: 別のエージェント・インスタンスに同じ Django WSGI エントリー・ポイントを指定しないでください。デフォルト・オプションを使用し、あるエージェント・インスタンスが Apache サーバーをモニターするように構成する場合、その他のエージェント・インスタンスがそのサーバーをモニターするように構成しないでください。
6. Django settings for the monitored application の入力を求めるプロンプトが出されたら、モニター対象アプリケーションの Django 設定 (my_project.settings など) を指定します。デフォルト値を使用する場合は、このフィールドを空のままにし、Enter キーを押してください。
7. Minimum recorded response time というプロンプトが出されたら、Enter キーを押してデフォルトを受け入れるか、時間を指定します。
8. Slow request threshold というプロンプトが出されたら、Enter キーを押してデフォルトを受け入れるか、しきい値を指定します。
9. Extreme slow request threshold というプロンプトが出されたら、Enter キーを押してデフォルトを受け入れるか、しきい値を指定します。
10. Profiler report interval というプロンプトが出されたら、Enter キーを押してデフォルトを受け入れるか、間隔を指定します。
11. エージェントを開始するには、以下を入力します。
  install_dir/bin/python-agent.sh start instance_name

次のタスク

エージェント・インスタンスを開始すると、モニター・ミドルウェアをカスタマイズするためのインジェクション・スクリプトが生成されて、一時ディレクトリーに格納されます。

インジェクション・シェル・スクリプトは、エージェントの開始後に自動的に実行されます。このステップが正しく実行されたことを確認する場合は、以下のファイルが存在することを確認します。

install_dir/tmp/kpg/inject_numeric_string.sh
Django_setting_folder/kpg_numeric_string.py

重要: サフィックスの数値ストリングは、Django アプリケーションを示しています。当該の一時フォルダーに生成されたインジェクション・スクリプトが複数存在する場合は、同数の kpg_numeric_string.py ファイルがあります。

通常、インジェクション・スクリプトは、以下のジョブを実行します。

各 Django アプリケーションのオリジナル WSGI 設定ファイルをバックアップします。
カスタマイズした WSGI 設定ファイルをコピーして、オリジナル・ファイルをオーバーライドします。
カスタマイズしたミドルウェアを Django アプリケーション・フォルダーに移動します。
Apache サーバーのモジュール状況を有効にします。

また、インジェクション・スクリプトは、各 Django アプリケーションからミドルウェアをアンインストールできるようにするアンインストール・スクリプトを生成します。

注: Apache 状況モジュールの使用可能化が複数のインジェクション・スクリプトに含まれていることがありますが、スクリプトの実行時にモジュールが追加されるのは 1 回のみです。

参考までに、Apache サーバーに対して以下の停止コマンドおよび再始動コマンドを使用できます。

停止: apache_bin_directory/httpd -k graceful-stop
再始動: apache_bin_directory/httpd -k graceful