IBM Cloud アプリケーション用の Python データ・コレクター のカスタマイズ

IBM® Cloud ユーザー・インターフェース (UI) で環境変数を追加して、ご使用の IBM Cloud アプリケーションのモニターをカスタマイズできます。以下の情報を使用して、ニーズに応じて変数を追加します。

Python データ・コレクター用のユーザー定義の環境変数

以下の表の情報を使用して、IBM Cloud での Python モニターをカスタマイズできます。

表 1. IBM Cloud での Python モニター用にサポートされるユーザー定義の環境変数
変数名 重要度 値 説明
APM_BM_GATEWAY_URL オプション
  • https://<server ip または hostname>:443
  • http://<server ip または hostname>:80
 ターゲットのオンプレミス・サーバー・ゲートウェイ URL。
APM_KEYFILE_PSWD オプション 鍵ファイルの暗号化されたパスワード 鍵ファイルと対になっている暗号化された鍵ファイル・パスワード。Linux ユーザーの場合は、echo -n <keyfile password> | base64 コマンドを使用してパスワードを暗号化できます。
注: この変数を設定するのは、HTTPS を使用するようにゲートウェイを構成した場合に限ります。
APM_KEYFILE_URL オプション http://<hosted http server>:<port>/keyfile.p12 鍵ファイルをダウンロードするための URL。
注: この変数を設定するのは、HTTPS を使用するようにゲートウェイを構成した場合に限ります。
KPG_ENABLE_DEEPDIVE オプション
  • False
  • True
 診断データの収集を有効または無効にします。
  • True: デフォルト値。この変数を True に設定すると、診断データが収集されます。
  • False: この変数を False に設定すると、診断データは収集されません。

この変数を設定しない場合、診断データは収集されます。
KPG_DD_CONFIG_FILE オプション 診断モニターの構成ファイルのファイル名。 診断モニターの構成ファイルのファイル名。デフォルトのファイル名は、kpg_dd_config.xml です。
注: このファイル内で設定値をカスタマイズした後、ファイルをアプリケーションのルート・ディレクトリーに配置する必要があります。

この変数を設定しない場合、データ・コレクター・パッケージ内のデフォルト構成ファイル kpg_dd_config.xml が使用されます。
KPG_DD_APP_PATH オプション Python アプリケーションへのパス。 データ・コレクターが診断データを収集する対象の Python アプリケーションまたはモジュールへのパス。モニターする Python アプリケーションおよびモジュールが複数ある場合は、それぞれのパスをセミコロン ; で区切ります。

この変数を設定しない場合、データ・コレクターは、アプリケーションによって使用される要求およびモジュールのデータを収集します。Python lib 内の要求のデータは収集されません。
KPG_DD_SECURITY_FILTER オプション
  • True
  • False
  • True: デフォルト値。この変数を True に設定すると、値 (パスワードなど) が SQL ステートメント内でマスクされ、グループ・ウィジェット「要求コンテキスト」にパラメーターが表示されません。
  • False: この変数を False に設定すると、SQL ステートメント内の値はマスクされず、グループ・ウィジェット「要求コンテキスト」にパラメーターが表示されます。

この変数を設定しない場合、値 (パスワードなど) が SQL ステートメント内でマスクされ、グループ・ウィジェット「要求コンテキスト」にパラメーターが表示されません。
KPG_GC_STATS オプション True python ガーベッジ・コレクションのすべての統計関数が有効になります。この値を True に設定すると、以下のコマンドを実行した場合と同じ結果が得られます。 

gc.set_debug(gc.DEBUG_STATS |
gc.DEBUG_COLLECTABLE |
gc.DEBUG_UNCOLLECTABLE | 
gc.DEBUG_INSTANCES | 
gc.DEBUG_OBJECTS )

KPG_GC_STATS を無効にするには、この環境変数を削除します。False に設定しないでください。

注: 正式な実稼働環境では、決して KPG_SAVE_ALL=True を設定しないでください。これは、デバッグ・モード専用です。アプリケーションに十分なメモリーが割り当てられていることを確認してください。
KPG_LOG_LEVEL オプション
  • DEBUG
  • ERROR
  • INFO
  • DEBUG: 有用なデバッグ情報のみがログに出力されます (収集されたデータ、サーバーに送信されたデータ、サーバーの応答など)。
  • ERROR: 例外および予期しないシチュエーションに関する情報のみがログに出力されます。
  • INFO: ユーザーがデータ・コレクターの処理内容を把握するための、データ・コレクターに関する要約情報がログに出力されます。
KPG_LOG_TOCONSOLE オプション
  • Y
  • True
  • False 以外のすべての値
 ログがコンソールに出力され、コマンド cf logs <appname> を実行してログを表示できます。
KPG_SAVE_ALL オプション True 参照されていないオブジェクトはすべて gc.garbage に保存されるため、1 分ごとに gc.garbage をクリアする必要があります (データ・コレクターによってクリアされます)。この値を True に設定すると、以下のコマンドを実行した場合と同じ結果が得られます。 
gc.set_debug(gc.SAVE_ALL)
KPG_SAVE_ALL を無効にするには、この環境変数を削除します。False に設定しないでください。
注: 正式な実稼働環境では、決して KPG_SAVE_ALL=True を設定しないでください。これはデバッグ・モード専用です。アプリケーションに十分なメモリーが割り当てられていることを確認してください。