Install Atatus Python APM agent in Django server

​

Supported Versions

• Django 1.11 and above.

​

Installation steps

1. Install the Atatus python agent: Option 1: Install the agent using pip.
   pip install atatus
   
   Option 2: Add atatus to your project’s requirements.txt file, and install the agent using pip.
   # requirements.txt
   atatus
   
   pip install -r requirements.txt
   
2. Add atatus.contrib.django to INSTALLED_APPS in your settings.py:
   # settings.py
   
   INSTALLED_APPS = [
      # ...
      'atatus.contrib.django',
   ]
   
3. Add license key and app name in your settings.py:
   # settings.py
   
   ATATUS = {
      'APP_NAME': 'Django App',
      'LICENSE_KEY': 'lic_apm_xxxxxxx',
      'NOTIFY_HOST': 'YOUR_ON_PREMISE_URL',
      'ANALYTICS_NOTIFY_HOST': 'YOUR_ON_PREMISE_URL',
      # 'DEBUG': True  # Please uncomment this line if you are running in development/debug mode. Otherwise, we do not send data.
   }
   
4. Restart your Django server

​

Installation steps for Django 5+ with ASGI

​

Step 1: Install Required Dependencies

pip install atatus

​

Step 2: Integrate ASGI Tracing Middleware in asgi.py

1. Open your project’s asgi.py file.
2. Update it to include the ASGITracingMiddleware:
   import os
   from django.core.asgi import get_asgi_application
   from atatus.contrib.asgi import ASGITracingMiddleware
   
   os.environ.setdefault("DJANGO_SETTINGS_MODULE", "<your_django_app_config>.settings")
   
   application = ASGITracingMiddleware(get_asgi_application())
   

​

Step 3: Configure CustomTracingMiddleware

1. Create or open the middleware.py file in your Django application.
2. Add the following code to middleware.py:
   import atatus
   from atatus.contrib.django.middleware import TracingMiddleware
   from django.http import HttpRequest
   from django.urls import resolve
   
   class CustomTracingMiddleware(TracingMiddleware):
       def process_request(self, request: HttpRequest):
           # Check if there's an active Atatus transaction
           if atatus.get_transaction_id():
               # Format the transaction name based on the request method and path
               transaction_name = "{} {}".format(request.method.upper(), request.path.lower())
               route_name = ""
   
               # Attempt to resolve the route name from the request
               try:
                   if request.resolver_match:
                       route_name = request.resolver_match.view_name
                   else:
                       match = resolve(request.path)
                       if match:
                           route_name = match.view_name
               except Exception:
                   pass
   
               # Set transaction name to route name or formatted transaction name
               txn_name = route_name if route_name else transaction_name
               atatus.set_transaction_name(txn_name) #type: ignore
   
           return None
   
3. Add CustomTracingMiddleware to your middleware configuration in your settings.py file:
   MIDDLEWARE = [
       '<your_middleware_module>.middleware.CustomTracingMiddleware',  # Ensure this path matches your app structure
       # other middleware components...
   ]
   
   Make sure CustomTracingMiddleware is included in the order that best fits your middleware needs.

​

Step 4: Configure Atatus

1. Add atatus.contrib.django to INSTALLED_APPS in your settings.py:
   # settings.py
   
   INSTALLED_APPS = [
      # ...
      'atatus.contrib.django',
   ]
   
2. Add license key and app name in your settings.py:
   # settings.py
   
   ATATUS = {
      'APP_NAME': 'Django App',
      'LICENSE_KEY': 'lic_apm_xxxxxxx',
      'NOTIFY_HOST': 'YOUR_ON_PREMISE_URL',
      'ANALYTICS_NOTIFY_HOST': 'YOUR_ON_PREMISE_URL',
      # 'DEBUG': True  # Please uncomment this line if you are running in development/debug mode. Otherwise, we do not send data.
   }
   

​

Step 5: Restart your Django server