Syntax
newrelic.agent.asgi_application(application=None, name=None, group=None, framework=None)Monitor web transactions by marking the ASGI application entry point.
Description
asgi_application is a Python decorator used to monitor web transactions by instrumenting the ASGI application entry point. The Python agent automatically supports most frameworks and servers that use ASGI. If your framework or web server is not supported, you may need to use this API as part of the advanced integration process.
If you cannot use the asgi_application decorator, you can use one of these other call formats:
- The wrapper: The wrapper call is
ASGIApplicationWrapper. You can use the wrapper in more than one place for distinct ASGI application components that may be stacked. In that case, the first wrapper encountered marks the start of the transaction and the agent determines the target app based on that first wrapper (and ignores subsequent ones). - The path-based wrapper: The path-based wrapper call is
wrap_asgi_application. Use this if you could not reference the ASGI object as a variable in the instrumentation scope. This takes the same parameters as the decorator with additionalmoduleandobject_pathparameters.
For an explanation of the reasons to use the decorator versus the wrappers, see Different call formats.
Parameters
Decorator parameters
newrelic.agent.asgi_application(application=None, name=None, group=None, framework=None)The asgi_application decorator uses these parameters:
Parameter | Description |
|---|---|
string, or application object | Optional. The application name to associate with this data. Default is If a string is provided, it must be the exact application name and cannot be a list of application names. For more on generating an application object, see the |
string | Optional, rarely used. Sets a transaction name for all requests captured via the ASGI entry point. Generally not used, because you usually would not want all transactions to have the same name (see also Metric grouping issue). |
string | Optional, rarely used. The |
tuple | Optional. A tuple with two strings representing the name of the framework and the version number. For example: |
Wrapper parameters
newrelic.agent.ASGIApplicationWrapper(wrapped, application=None, name=None, group=None, framework=None)This takes all of the parameters required by asgi_application in addition to a wrapped parameter:
Parameter | Description |
|---|---|
object | Required. The ASGI object to be wrapped. |
Path-based wrapper parameters
newrelic.agent.wrap_asgi_application(module, object_path, application=None, name=None, group=None, framework=None)In addition to the parameters required by asgi_application, this call requires additional module and object_path parameters:
Parameter | Description |
|---|---|
object or string | Required. The module containing the ASGI object. |
string | Required. Represents the class method or method for finding the ASGI object within a file. |
Examples
asgi_application example
An example of the decorator being called without the optional application parameter:
@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 example
An example of using the ASGIApplicationWrapper, which may be necessary if the asgi_application decorator doesn't work:
import osos.environ.setdefault("DJANGO_SETTINGS_MODULE", "mysite.settings")from django.core.asgi import get_asgi_applicationapplication = get_asgi_application()
application = newrelic.agent.ASGIApplicationWrapper(application)wrap_asgi_application example
An example of using the path-based wrapper:
import newrelic.agentnewrelic.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')