構文
newrelic.agent.background_task(application=None, name=None, group=None)バックグラウンドタスクやその他の非ウェブトランザクションを計測するために使用されます。
説明
この Python デコレーターは、バックグラウンドタスクやその他の 非ウェブトランザクションを計測するために使用することができます 。これは通常、ワーカープロセス、ジョブベースのシステム、およびスタンドアロンのスクリプトなどの非ウェブアクティビティを計測するために使用されます。バックグラウンドタスクとしてマークされたトランザクションは、APM UIにおいて非ウェブトランザクションとして表示され、ウェブトランザクションから分離されます。
callout.imporant
関数がまだインストルメント化されていない場合は、 function_trace() を使用して、バックグラウンド タスク内でその関数の関数トレースを作成できます。または、 構成ファイルを 使用して、計測されていない機能を計測することもできます。
バックグラウンド・タスク・デコレーターを使用した関数が、ウェブ・トランザクションのコンテキスト内で呼び出された場合、そのウェブ・トランザクションはバックグラウンド・タスクとしてマークされます。所要時間の測定は、元のウェブ・トランザクションが開始された時点から始まります。
デコレーターを使用できない場合は、これらの呼び出し形式のいずれかを使用すると便利です。
- コンテキスト マネージャー: 監視対象のタスクが実行時のみに決定される (インポート時ではない) 場合は、
BackgroundTaskコンテキスト マネージャーを使用して、コード ブロックの実行を直接ラップできます。(これは、BackgroundTaskWrapperによって使用されるコンテキスト マネージャーです。) - ラッパー: 追跡したい特定の関数がどこにあるかが事前にわかっている場合は、
background_taskデコレータを使用できます。ただし、トレースする必要があるすべての関数がわからない場合 (たとえば、関数がルーティング システムの一部として動的に検索されている場合)、その時点でBackgroundTaskWrapperを使用して関数をラップする必要があります。登録時または電話時。 - パスベースのラッパー: パスベースのラッパー形式は
wrap_background_taskです。
これらの関数形式の違いや用途については、 Variable Call Formats を参照してください。
パラメーター
デコレーターとコンテキストマネージャーのパラメーター
newrelic.agent.background_task(application=None, name=None, group=None)newrelic.agent.BackgroundTask(application=None, name=None, group=None)これらのコールのパラメータ
パラメータ | 説明 |
|---|---|
アプリケーションインスタンス | 必要。データが報告されるアプリケーション。デフォルトは アプリケーション オブジェクトの生成の詳細については、 WSGI アプリケーションのリクエスト環境ディクショナリごとに |
ストリング | 必要。トランザクションの名前。デフォルト値は |
ストリング | オプション。 指定しない場合、グループは、名前が |
ラッパーのパラメータです。
newrelic.agent.BackgroundTaskWrapper(wrapped, application=None, name=None, group=None)BackgroundTaskWrapper は background_task デコレータと同じ パラメータ と、この追加の wrapped パラメータを受け取ります。
パラメータ | 説明 |
|---|---|
メソッド | 必要です。トレースするメソッドです。 |
パスベースのパラメータ
newrelic.agent.wrap_background_task(module, object_path, application=None, name=None, group=None)wrap_background_task は、 background_task デコレータと同じ パラメータ に加えて、次の追加パラメータを受け取ります。
パラメータ | 説明 |
|---|---|
モジュール または 文字列 | 必要です。インスツルメンテーションを行うノンウェブ機能／アクティビティを含むモジュール。 |
ストリング | 必須です。モジュールへのパスです。 |
例
background_task デコレータの例
background_task デコレータの使用例を次に示します。
@newrelic.agent.background_task()def task(): ...BackgroundTask コンテキストマネージャーの例
BackgroundTaskの使用例:
application = newrelic.agent.application()name = newrelic.agent.callable_name(task)
with BackgroundTask(application, name): task()より多くのパラメータを持つ別の例を示します。
application = newrelic.agent.register_application(timeout=10.0)
def execute_task(task_name): with newrelic.agent.BackgroundTask(application, name=task_name, group='Task'): ...BackgroundTaskWrapper 例
BackgroundTaskWrapperの使用例:
task = newrelic.agent.BackgroundTaskWrapper(get_next_task())result = task(*args, **kwargs)この例では、この呼び出しがエージェントによって監視されているウェブ・トランザクション内で行われた場合、呼び出しはウェブ・トランザクションをバックグラウンド・タスクとして再分類します。しかし、この呼び出しがバックグラウンドのスレッドやコルーチン内で行われた場合は、呼び出しが戻るまでの間に発生したことを追跡する新しいバックグラウンド・タスク・トランザクションの記録が開始されます。