Monitoring and error tracking in Django

Introduction

Monitoring helps you see how your Django app is working. Error tracking tells you when something goes wrong so you can fix it fast.

You want to know if your Django website is slow or down.

You want to get alerts when users face errors on your site.

You want to find and fix bugs before users complain.

You want to understand how users interact with your app.

You want to keep your app running smoothly all the time.

Syntax

Django

INSTALLED_APPS = [
    ...
    # Add monitoring tools or error tracking apps here
]

# Example: Configure Sentry for error tracking
import sentry_sdk
from sentry_sdk.integrations.django import DjangoIntegration

sentry_sdk.init(
    dsn='your_sentry_dsn_here',
    integrations=[DjangoIntegration()],
    traces_sample_rate=1.0,
    send_default_pii=True
)

Put monitoring or error tracking apps in INSTALLED_APPS and middleware if needed.

Configure external services like Sentry with their SDK and your project DSN.

Examples

This example shows how to add Sentry to your Django app for error tracking with 50% performance tracing.

Django

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
]

import sentry_sdk
from sentry_sdk.integrations.django import DjangoIntegration

sentry_sdk.init(
    dsn='https://[e-mail]/0',
    integrations=[DjangoIntegration()],
    traces_sample_rate=0.5
)

This example configures Django's built-in logging to show warnings and errors in the console.

Django

# Using Django's logging for error tracking
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
        },
    },
    'root': {
        'handlers': ['console'],
        'level': 'WARNING',
    },
}

Sample Program

This Django settings.py setup adds Sentry for error tracking. Add the trigger_error view to your views.py and map it in urls.py (e.g., path('trigger-error/', trigger_error)) to test if Sentry catches the division by zero error.

Django

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

import sentry_sdk
from sentry_sdk.integrations.django import DjangoIntegration

sentry_sdk.init(
    dsn='https://[e-mail]/0',
    integrations=[DjangoIntegration()],
    traces_sample_rate=1.0,
    send_default_pii=True
)

# To test, add this view to views.py:
# from django.http import HttpResponse
#
# def trigger_error(request):
#     division_by_zero = 1 / 0
#     return HttpResponse("This won't be reached")
#
# And in urls.py: path('trigger-error/', trigger_error),

Important Notes

Always keep your monitoring and error tracking keys secret.

Test your error tracking by causing a safe error in a development environment.

Use monitoring dashboards to watch app health and respond quickly.

Summary

Monitoring shows how your Django app performs in real time.

Error tracking helps find and fix bugs fast.

Tools like Sentry integrate easily with Django for these tasks.

Practice

1. What is the main purpose of monitoring in a Django application?

easy

A. To design the user interface

B. To write new features for the app

C. To manage database migrations

D. To observe the app's performance and health in real time

Solution

1. Step 1: Understand monitoring concept

   Monitoring means watching how the app works live, checking speed, errors, and usage.

2. Step 2: Match purpose to options

   Only To observe the app's performance and health in real time talks about observing performance and health in real time, which matches monitoring.

3. Final Answer:

   To observe the app's performance and health in real time -> Option D

4. Quick Check:

   Monitoring = Real-time app observation [OK]

Hint: Monitoring = watching app health live [OK]

Common Mistakes:

• Confusing monitoring with coding features
• Thinking monitoring manages database
• Mixing monitoring with UI design

2. Which of the following is the correct way to install Sentry SDK for Django using pip?

easy

A. pip install sentry-sdk[django]

B. pip install sentry-django-sdk

C. pip install django-sentry

D. pip install sentry_sdk django

Solution

1. Step 1: Recall Sentry installation syntax

   Sentry SDK for Django is installed with extras syntax: sentry-sdk[django].

2. Step 2: Compare options

   Only pip install sentry-sdk[django] uses correct package name and extras format for Django integration.

3. Final Answer:

   pip install sentry-sdk[django] -> Option A

4. Quick Check:

   Correct pip install syntax = pip install sentry-sdk[django] [OK]

Hint: Use brackets for extras in pip install [OK]

Common Mistakes:

• Using wrong package names
• Missing brackets for extras
• Installing unrelated packages

3. Given this Django settings snippet for Sentry integration:

import sentry_sdk
from sentry_sdk.integrations.django import DjangoIntegration

sentry_sdk.init(
    dsn="https://[e-mail]/0",
    integrations=[DjangoIntegration()],
    traces_sample_rate=1.0,
    send_default_pii=True
)

What will happen when an error occurs in the Django app?

medium

A. The error will be ignored and not reported

B. The error will be sent to Sentry with user info and performance tracing

C. The app will crash without logging the error

D. Only performance data will be sent, no error details

Solution

1. Step 1: Analyze Sentry init parameters

   DSN is set, Django integration enabled, traces_sample_rate=1.0 means full performance tracing, send_default_pii=True sends user info.

2. Step 2: Understand error reporting behavior

   With this setup, errors and performance data including user info are sent to Sentry automatically.

3. Final Answer:

   The error will be sent to Sentry with user info and performance tracing -> Option B

4. Quick Check:

   Sentry setup sends errors + user info + traces [OK]

Hint: Full Sentry init sends errors and traces [OK]

Common Mistakes:

• Ignoring send_default_pii effect
• Confusing traces_sample_rate with error reporting
• Assuming errors are not sent automatically

4. You added Sentry to your Django project but no errors appear in your Sentry dashboard. Which is the most likely cause?

medium

A. You installed sentry-sdk but did not run migrations

B. You set traces_sample_rate to 0.5

C. You forgot to set the DSN in the sentry_sdk.init() call

D. You used the wrong Python version

Solution

1. Step 1: Identify key Sentry setup requirement

   DSN is required to send errors to the correct Sentry project.

2. Step 2: Evaluate options

   Without DSN, no errors are sent. Other options do not prevent error sending directly.

3. Final Answer:

   You forgot to set the DSN in the sentry_sdk.init() call -> Option C

4. Quick Check:

   Missing DSN = no error reports [OK]

Hint: Always set DSN to send errors [OK]

Common Mistakes:

• Thinking migrations affect Sentry error sending
• Confusing traces_sample_rate with error sending
• Blaming Python version without evidence

5. You want to monitor both errors and performance in your Django app using Sentry, but only want to sample 20% of transactions to reduce data volume. Which is the correct way to configure traces_sample_rate in sentry_sdk.init()?

hard

A. traces_sample_rate=0.2

B. traces_sample_rate=20

C. traces_sample_rate='20%'

D. traces_sample_rate=True

Solution

1. Step 1: Understand traces_sample_rate meaning

   It expects a float between 0.0 and 1.0 representing the fraction of transactions to sample.

2. Step 2: Match options to correct format

   0.2 means 20%, 20 or '20%' are invalid types, True is boolean not a fraction.

3. Final Answer:

   traces_sample_rate=0.2 -> Option A

4. Quick Check:

   Fraction 0.2 = 20% sampling [OK]

Hint: Use decimal fraction for sampling rate [OK]

Common Mistakes:

• Using integer or string instead of float
• Setting traces_sample_rate > 1
• Using boolean True instead of number