構文
newrelic.agent.application_settings(name=None)
アプリケーション設定オブジェクトを返します。
説明
これにより、アプリケーション設定オブジェクトへの参照が返されます。 global_settings
オブジェクトには、構成ファイルの設定と環境変数が含まれています。この application_settings
オブジェクトには、New Relic UI を介してサーバー側で設定された構成変更も含まれています。
返される設定は、ネストされた階層的なオブジェクトで、設定名は、 エージェント設定ファイル の名前と一致します。アプリケーション設定を公開する主な理由は、サーバーサイドで設定されたものではなく、エージェント固有のローカル設定をインストゥルメンテーションで参照したい場合です。
name
値が設定されていない場合、呼び出しではエージェント構成ファイルまたは NEW_RELIC_APP_NAME
環境変数で指定されたアプリケーション名が使用されます。
この呼び出しが行われたときにアプリケーションがデータ コレクターに登録されていない場合、値 None
が返されます。呼び出しが正常に行われ、値が返されると、登録時に取得されたアプリケーションの サーバー側構成 にオーバーレイされたローカル構成の値が反映されます。
重要
アプリケーションの設定オブジェクトに変更を加えないでください。サーバー側の設定変更により、エージェントがデータコレクタにアプリケーションを再登録すると、設定オブジェクトが無効になり、置き換えられるため、設定オブジェクトをキャッシュしないでください。
パラメーター
パラメータ | 説明 |
---|---|
ストリング | オプションです。アプリケーションの名前です。設定されていない場合は、そのアプリケーションのPythonエージェント構成で設定された名前と一致します。 |
戻り値
アプリケーション設定オブジェクトを返します。このオブジェクト自体はパブリックなAPIを提供しませんが、他のコールではこのオブジェクトを渡す必要があります。
例
IFステートメントの使用
構成設定を確認して、実装するカスタム インストルメンテーションを決定することをお勧めします。アプリ設定オブジェクトで if
ステートメントを使用する例を次に示します。
settings = newrelic.agent.application_settings()
if settings and settings.error_collector.enabled: ...
結果をdictに渡す
デバッグまたはログを実行していて、従来の Python 辞書オブジェクトとしてグローバル設定が必要な場合は、結果を dict
に渡すことができます。例えば:
settings_dict = dict(newrelic.agent.application_settings())
for name, value in settings_dict.items(): print name, value
各 name
は、その設定の完全な点線パスになります。