Django Middleware Instrumentation Filtering

The Python agent can now filter which Django middleware should be monitored. By default, all middleware will be instrumented.

Important

Middleware Instrumentation Filtering for Django is available for Python agent version 10.17.0 and higher. By default, all middleware will be instrumented. To change this configuration, check out our documentation.

Disable all Django middleware

Disabling instrumentation of middleware in Django can be done one of two ways:

Set the NEW_RELIC_INSTRUMENTATION_DJANGO_MIDDLEWARE_ENABLED environment variable to False
Set instrumentation.middleware.django.enabled = false in the configuration file.

Django middleware configuration settings

Type:	Space-Separated List of Strings
Default:	(none)

If attributes are enabled, all attribute keys in this list will be sent.

Type:	Space-separated list of strings
Default:	(none)

Middleware exclude/include rules

The agent follows these rules when determining which middleware to include or exclude for monitoring:

The instrumentation.middleware.FRAMEWORK.enabled flags take precedence over include and exclude middlewares.

Example configuration:

instrumentation.middleware.django.enabled = false
instrumentation.middleware.django.include = one two
instrumentation.middleware.django.include = three four

Example output:

Middleware used in app: one, two, three, four
Middleware included for monitoring:
Middleware excluded for monitoring: one, two, three, four

If a destination is enabled, all middleware is sent to that destination by default.

All middleware monitoring defaults to true.

Example configuration:

instrumentation.middleware.django.enabled = true
instrumentation.middleware.django.exclude = baz

Example output:

Middleware used in app: foo, bar, baz
Middleware included for monitoring: foo, bar
Middleware excluded for monitoring: baz

If the same middleware is listed in the include and exclude lists, then middleware with the specified name will be excluded.

Example configuration:

instrumentation.middleware.django.enabled = true
instrumentation.middleware.django.include = foo bar
instrumentation.middleware.django.exclude = nerd bar

Example output:

Middleware used in app: foo, bar, nerd
Middleware included for monitoring: foo
Middleware excluded for monitoring: nerd, bar

Middleware names are case-sensitive.

Example configuration:

instrumentation.middleware.django.enabled = true
instrumentation.middleware.django.exclude = username UsErNaMe

Example output:

Middleware used in app: username, Username, USERNAME, UsErNaMe, userNAME
Middleware included for monitoring:  Username, USERNAME, userNAME
Middleware excluded for monitoring:  username, UsErNaMe

You can use an asterisk * at the end of a name as a wildcard. This will match a set of middleware with the same prefix.

Example configuration:

instrumentation.middleware.django.enabled = true
instrumentation.middleware.django.include = custom*
instrumentation.middleware.django.exclude = request.parameters.*

Example output:

Middleware used in app: custom, custom.key1, custom.key2, request.parameters., request.parameters.foo, request.parameters.bar
Middleware included for monitoring: custom, custom.key1, custom.key2
Middleware excluded for monitoring: request.parameters., request.parameters.foo, request.parameters.bar

If multiple include or exclude names affect the same middleware, the most specific name will have priority.

Example configuration:

instrumentation.middleware.django.enabled = true
instrumentation.middleware.django.include = request.parameters.foo
instrumentation.middleware.django.exclude = request.parameters.*

Example output:

Middleware used in app: request.parameters., request.parameters.foo, request.parameters.bar
Middleware included for monitoring: request.parameters.foo
Middleware included for monitoring: request.parameters., request.parameters.bar

Django Middleware Instrumentation Filtering

Important

Disable all Django middleware

Django middleware configuration settings

instrumentation.middleware.django.include

instrumentation.middleware.django.exclude

Middleware exclude/include rules

Enabled takes precedence over include and exclude.

Middleware is included if the destination is enabled.

Exclude always supersedes include.

Middleware names are case sensitive.

Use `\*` for wildcards.

Most specific middleware name takes priority.

Django Middleware Instrumentation Filtering

Important

Disable all Django middleware .css-21sua1{background:none;border:none;width:0;padding:0;}

Django middleware configuration settings

instrumentation.middleware.django.exclude

Middleware exclude/include rules

Enabled takes precedence over include and exclude.

Middleware is included if the destination is enabled.

Exclude always supersedes include.

Middleware names are case sensitive.

Use \* for wildcards.

Most specific middleware name takes priority.

Disable all Django middleware

Use `\*` for wildcards.