asgi_application (PythonエージェントAPI)

構文

newrelic.agent.asgi_application(application=None, name=None, group=None, framework=None)

ASGIアプリケーションのエントリーポイントをマークすることで、Webトランザクションを監視します。

説明

asgi_application ASGI アプリケーションのエントリポイントを計測することで Web トランザクションを監視するために使用される Python デコレータです。Python エージェントは、ASGI を使用するほとんどのフレームワークとサーバーを自動的にサポートします。フレームワークまたは Web サーバーがサポートされていない場合は、高度な統合プロセスの一部としてこの API を使用する必要がある場合があります。

asgi_application デコレータを使用できない場合は、次の他の呼び出し形式のいずれかを使用できます。

ラッパー: ラッパー呼び出しは ASGIApplicationWrapperです。スタック可能な個別の ASGI アプリケーションコンポーネントの複数の場所でラッパーを使用できます。その場合、最初に見つかったラッパーがトランザクションの開始をマークし、エージェントはその最初のラッパーに基づいてターゲットアプリを決定します (その後のラッパーは無視されます)。
パスベースのラッパー: パスベースのラッパー呼び出しは wrap_asgi_applicationです。ASGI オブジェクトをインストルメンテーションスコープ内の変数として参照できない場合は、これを使用します。これは、追加の module と object_path パラメーターを備えたデコレーターと同じパラメーターを受け取ります。

デコレーターとラッパーを使い分ける理由については、 Different call formats を参照してください。

パラメーター

デコレーターのパラメータ

newrelic.agent.asgi_application(application=None, name=None, group=None, framework=None)

asgi_applicationデコレータは次のパラメータを使用します:

パラメータ	説明
`application` string、またはアプリケーションオブジェクト	オプション。このデータに関連付けるアプリケーション名。デフォルトは `None`です。値を指定しない場合、エージェントはエージェント設定で指定されたアプリケーション名を使用します。文字列を指定する場合は、正確なアプリケーション名である必要があり、アプリケーション名のリストを指定することはできません。アプリケーションオブジェクトの生成の詳細については、 `application` メソッドをご覧ください。
`name` ストリング	オプションで、ほとんど使用されません。ASGI エントリポイントを介して取得されるすべてのリクエストのトランザクション名を設定します。通常は、すべてのトランザクションが同じ名前になることを望まないため、使用されません（ Metric grouping issue も参照）。
`group` ストリング	オプションですが、ほとんど使用されません。 `group` は、 `name` パラメータの命名構造を表します。これを設定すると、トランザクションタイプサブカテゴリが作成されます。 `name`と同様に、通常はアプリケーション全体を 1 つのトランザクション名またはカテゴリとしてレポートする必要がないため、これはほとんど使用されません。
`framework` タプル	オプション。フレームワークの名前とバージョン番号を表す 2 つの文字列を含むタプル。例えば： `('Flask', '0.12.2')`

ラッパーのパラメーター

newrelic.agent.ASGIApplicationWrapper(wrapped, application=None, name=None, group=None, framework=None)

これは、 wrapped パラメータに加えて、 asgi_application で必要なすべてのパラメータを受け取ります。

パラメータ	説明
`wrapped` 物体	必須.ラッピングされるASGIオブジェクト。

パラメータ

説明

wrapped

物体

必須.ラッピングされるASGIオブジェクト。

パスベースのラッパーパラメーター

newrelic.agent.wrap_asgi_application(module, object_path, application=None, name=None, group=None, framework=None)

asgi_applicationで必要なパラメータに加えて、この呼び出しには追加の module パラメータと object_path パラメータが必要です。

パラメータ	説明
`module` オブジェクトまたは文字列	必須.ASGIオブジェクトを含むモジュールです。
`object_path` ストリング	必須.ファイル内のASGIオブジェクトを見つけるためのクラスメソッドまたはメソッドを表します。

パラメータ

説明

module

オブジェクト または 文字列

必須.ASGIオブジェクトを含むモジュールです。

object_path

ストリング

必須.ファイル内のASGIオブジェクトを見つけるためのクラスメソッドまたはメソッドを表します。

例

asgi_applicationの例

オプションの application パラメータを指定せずに呼び出されるデコレータの例:

@newrelic.agent.asgi_application()
async def application(scope, receive, send):
    await send(
        {
            "type": "http.response.start",
            "status": 200,
            "headers": [(b"Content-type", b"text/plain")]
        }
    )
    await send(
        {
            "type": "http.response.body",
            "body": b"Hello World!"
        }
    )

ASGIApplicationWrapperの例

ASGIApplicationWrapperの使用例。これは、 asgi_application デコレーターが機能しない場合に必要になる可能性があります。

import os
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "mysite.settings")
from django.core.asgi import get_asgi_application
application = get_asgi_application()

application = newrelic.agent.ASGIApplicationWrapper(application)

wrap_asgi_applicationの例

パスベースのラッパーの使用例。

import newrelic.agent
newrelic.agent.initialize('newrelic.ini')

class Application:
   def __init__(self, scope):
      self.scope = scope

   async def __call__(self, receive, send):
      await send({"type": "http.response.start", "status": 200})
      await send({"type": "http.response.body", "body": b"Hello World!"})

newrelic.agent.wrap_asgi_application(__name__, 'Application')

この機械翻訳は参考用に提供されます。