構文
newrelic.agent.web_transaction(application=None, name=None, group=None, scheme=None, host=None, port=None, request_method=None, request_path=None, query_string=None, headers=None)
Webトランザクションを計測するために使用されます。
要件
エージェントのバージョン4.16.0.116以降
説明
この Python デコレーターは、Web トランザクションの計測に使用できます。このデコレーターでマークされたトランザクションは、APM UIではウェブトランザクションの下に表示され、非ウェブトランザクションとは区別されます。
デコレーターを使用できない場合は、これらの呼び出し形式のいずれかを使用すると便利です。
- ラッパー: 追跡したい特定の機能がどこにあるか事前にわかっている場合は、
web_transaction
デコレーターを使うことができます。しかし、追跡する必要のあるすべての関数がわからない場合(たとえば、ルーティングシステムの一部として動的に検索されている場合など)は、WebTransactionWrapper
を使って、登録時や呼び出し時に関数をラップしなければなりません。 - パスベースのラッパー: パスベースのラッパー形式は
wrap_web_transaction
.
これらの関数形式の違いや用途については、 Variable Call Formats を参照してください。
パラメータ
デコレーターのパラメータ
newrelic.agent.web_transaction(application=None, name=None, group=None, scheme=None, host=None, port=None, request_method=None, request_path=None, query_string=None, headers=None)
これらのコールのパラメータ
パラメーター | 説明 |
---|---|
アプリケーションインスタンス | 任意。データが報告されるアプリケーションです。値を指定しない場合は、エージェントの 設定 (config ファイルまたは環境変数) で指定されたアプリケーションが使用されます。 アプリケーション・オブジェクトの生成については、 |
文字列 | オプションです。トランザクションの名前です。デフォルトでは、この名前はデコレータが適用された関数の名前になりますが、この名前を指定することでこれを上書きできます。 |
文字列 | オプションです。 指定されない場合、グループのデフォルトは |
文字列 | オプションです。リクエスト URL のスキーム部分 |
文字列 | オプションです。リクエストURLのホスト部分 |
整数 | オプションです。リクエストURLのポート部分 |
文字列 | オプションです。GETやPOSTなどのHTTPリクエスト・メソッドです。 |
文字列 | 任意です。リクエストURLのパスの残りの部分 |
文字列 | オプションです。クエスチョンマークの後に続くリクエストURLの部分 |
イテレート可能またはディク | オプションです。HTTP リクエストヘッダー name はヘッダー名、value はヘッダーの値ですが、[name, value] の 2 項目のイテレート可能、または {name:value} の dict です。 |
ラッパーのパラメータです。
newrelic.agent.WebTransactionWrapper(wrapped, application=None, name=None, group=None, scheme=None, host=None, port=None, request_method=None, request_path=None, query_string=None, headers=None)
WebTransactionWrapper
は、 web_transaction
デコレーターと同じ パラメータ と、この追加の ラップされた
パラメータを取ります。
パラメーター | 説明 |
---|---|
メソッド | 必要です。トレースするメソッドです。 |
パスベースのパラメータ
newrelic.agent.wrap_web_transaction(module, object_path, application=None, name=None, group=None, scheme=None, host=None, port=None, request_method=None, request_path=None, query_string=None, headers=None)
wrap_web_transaction
は、 web_transaction
デコレーターと同じ パラメータ を取り、さらに以下の追加パラメータを取ります。
パラメーター | 説明 |
---|---|
モジュール または 文字列 | 必要です。インスツルメンテーションを行うWeb関数/アクティビティを含むモジュール。 |
文字列 | 必須です。モジュールへのパスです。 |
例
web_transaction
デコレーターの例
ここでは、web_transaction デコレーターの使用例を示します。
@newrelic.agent.web_transaction()def get(): ...
WebTransactionWrapper
例
WebTransactionWrapperの使用例
:
task = newrelic.agent.WebTransactionWrapper(get_next_task())result = task(*args, **kwargs)