Loading...
  1. Documentation
  2. Blackfire for Python
  3. Integrations
  4. WSGI Middleware

WSGI Middleware
Python

WSGI (Web Server Gateway Interface) is a specification that defines the protocol between web servers and Python web applications.

The Blackfire Python SDK contains a middleware easing the integration with WSGI web applications.

The integrations we provide for Django, Flask, Odoo are extending the BlackfireWSGIMiddleware. They could serve as examples helping the creation of a new middleware.

Integrations with other frameworks could benefit the Blackfire community. Please consider contributing your code.

The Blackfire Python SDK is available with the Blackfire Python Package.

Create a class extending the BlackfireWSGIMiddleware.

The FRAMEWORK variable must be set; it should describe the instrumented application.

1
2
3
4
5
6
7
from blackfire.hooks.wsgi import BlackfireWSGIMiddleware

class BlackfireFooBarMiddleware(BlackfireWSGIMiddleware):

    FRAMEWORK = 'Foo-Bar'

    ...

A get_view_name method must be defined to have the requests of your WSGI-based application be instrumented by Blackfire Monitoring.

This function is required only for the monitoring of your application. Its definition can be omitted if you are not considering it.

The get_view_name method retrieves the view name executing or handling the HTTP request. Blackfire Monitoring relies on this information to group requests in the monitoring dashboard.

If it returns None, the viewname will be grouped with other Unnamed Transactions

The function receives 1 parameter:

  • environ is a dictionary that contains the HTTP request headers and other metadata.

The function should return a string or None.

1
2
3
4
5
6
7
8
from blackfire.hooks.wsgi import BlackfireWSGIMiddleware

class BlackfireFooBarMiddleware(BlackfireWSGIMiddleware):

    FRAMEWORK = 'Foo-Bar'

    def get_view_name(self, environ):
        # implementation ...