message_transaction (PythonエージェントAPI)

構文

newrelic.agent.message_transaction(library, destination_type, destination_name, application, routing_key=None, exchange_type=None, headers=None, queue_name=None, reply_to=None, correlation_id=None)

トランザクションとしてのメッセージ機能を報告する。

要件

エージェントのバージョンが2.88.0.72以上であること。

説明

このデコレータは、メッセージング関数のデコレータとして使用できるMessageTransactionWrapperの部分を返します。使用すると、返されたデコレータはメッセージトランザクションとそのメッセージ関連の属性を記録します。

デコレーターがアプリケーションで動作しない場合は、以下のいずれかを使用することができます。

The context manager
: コンテキストマネージャーフォームはMessageTransactionです。デコレータと同じものが必要です。
The wrapper
: ラッパーフォームはMessageTransactionWrapperです。デコレータを使用せずにラップされた関数を返すために使用できます。
The path-based wrapper
: パスベースのラッパー形式はwrap_message_transactionです。これは、モンキーパッチングを通じて、指定されたオブジェクトにMessageTransactionWrapperを適用します。これは、デコレータと同じ引数に加えて、追加のmoduleとobject_path引数を受け取ります。

これらの異なるコールをどのような場合に使用すべきかについての説明は、 Different call formats を参照してください。コールの例については、例をご覧ください。

パラメーター

message_transactionとMessageTransactionのパラメータ

newrelic.agent.message_transaction(library, destination_type, destination_name, application, routing_key=None, exchange_type=None, headers=None, queue_name=None, reply_to=None, correlation_id=None)

newrelic.agent.MessageTransaction(library, destination_type, destination_name, application, routing_key=None, exchange_type=None, headers=None, queue_name=None, reply_to=None, correlation_id=None)

デコレーターとコンテキストマネージャーは、これらのパラメータを使用します。

パラメータ	説明
`library` 文字列または機能	必須項目です。使用しているメッセージ・ブローカーの名前（またはタイプ）です。定義した文字列またはそれを返す関数のいずれかを渡します。
`destination_type` 文字列または機能	必須。操作の対象となる宛先のタイプ。それを定義する文字列またはそれを返す関数のいずれかを渡します。通常、これは`Exchange`または`Queue`です。
`destination_name` 文字列または機能	必須項目です。操作の対象となる宛先の名前です。この名前を定義する文字列か、この名前を返す関数を渡します。
`application` アプリケーション	必須。`application`によって返されるアプリケーションインスタンス。
`routing_key` 文字列または機能	オプションです。メッセージのルーティングキーです。
`exchange_type` 文字列または機能	オプションです。メッセージの交換タイプです。
`headers` 辞書または機能	オプションです。メッセージのヘッダです。
`queue_name` 文字列または機能	オプションです。メッセージのキュー・ネーム・プロパティです。
`reply_to` 文字列または機能	オプション。メッセージの`replyTo`プロパティ。
`correlation_id` 文字列または機能	オプション。メッセージの`correlationID`プロパティ。

MessageTransactionWrapperのパラメータ

newrelic.agent.MessageTransactionWrapper(wrapped, library, destination_type, destination_name, application, routing_key=None, exchange_type=None, headers=None, queue_name=None, reply_to=None, correlation_id=None)

MessageTransactionWrapperは、このwrappedパラメータに加えて、デコレータと同じパラメータをすべて受け取ります。

パラメータ	説明
`wrapped` 機能	必須です。メッセージ・ブローカーの時間に帰属させるメッセージング機能です。

パラメータ

説明

wrapped

機能

必須です。メッセージ・ブローカーの時間に帰属させるメッセージング機能です。

wrap_message_transactionのパラメータ

newrelic.agent.wrap_message_transaction(module, object_path, library, destination_type, destination_name, application, routing_key=None, exchange_type=None, headers=None, queue_name=None, reply_to=None, correlation_id=None)

これは、 moduleパラメータとobject_pathパラメータに加えて、デコレータが行うすべてのパラメータを取ります。

パラメータ	説明
`module` 物体	必要です。ラップされるオブジェクトを含むモジュール。
`object_path` ストリング	必要です。ラップされるオブジェクトへのパス。

パラメータ

説明

module

物体

必要です。ラップされるオブジェクトを含むモジュール。

object_path

ストリング

必要です。ラップされるオブジェクトへのパス。

戻り値

デコレータmessage_transactionはMessageTransactionWrapperパーシャルを返します。

例

メッセージトランザクションの例

デコレーターの例です。

mt = message_transaction('library', 'Exchange', 'x', routing_key='foo.bar')

@mt
def foo():
    pass

MessageTransactionの例

コンテキストマネージャーを使用した例です。

def callback(method, properties, body):
    with MessageTransaction('library', 'Exchange', 'x', application=app):
        pass

MessageTransactionWrapperの例

ラッパーを使った例

basic_consume_wrapper = newrelic.agent.MessageTransactionWrapper(basic_consume_register_callback, 'library', 'Queue', 'x')

method_frame, header_frame, body = basic_consume_wrapper('queue')

wrap_message_transactionの例

パスベースのラッパーを使った例

wrap_message_transaction('module', 'Foo.bar', 'library', 'Exchange', 'x')

この機械翻訳は、参考として提供されています。