Search code examples
pythondjangosentrydjango-settings

How to prevent sentry from logging errors while on Django local server?


I am trying to prevent Sentry from logging errors to my Sentry dashboard while I'm working on my local server (i.e http://127.0.0.1:8000/). The only time I want sentry to log errors to my dashboard is when my code is in production. How can I go about this? I have tried this below, but it doesn't work:

if DEBUG == True
    sentry_sdk.init(
        dsn=os.environ.get('SENTRY_DSN', None),
        integrations=[DjangoIntegration()],
    
        # Set traces_sample_rate to 1.0 to capture 100%
        # of transactions for performance monitoring.
        # We recommend adjusting this value in production.
        traces_sample_rate=1.0,
    
        # If you wish to associate users to errors (assuming you are using
        # django.contrib.auth) you may enable sending PII data.
        send_default_pii=True
    )

Solution

  • There are two ways you can do this:

    The first option is to import sys and check for runserver (ref:https://stackoverflow.com/a/49874564/15205504)

    import sys
    
    if (len(sys.argv) >= 2 and sys.argv[1] != 'runserver'):
        sentry_sdk.init(
            dsn=os.environ.get('SENTRY_DSN', None),
            integrations=[DjangoIntegration()],
    
            # Set traces_sample_rate to 1.0 to capture 100%
            # of transactions for performance monitoring.
            # We recommend adjusting this value in production.
            traces_sample_rate=1.0,
    
            # If you wish to associate users to errors (assuming you are using
            # django.contrib.auth) you may enable sending PII data.
            send_default_pii=True
    )
    

    The second option is to specify an environment type in your settings.py. For instance, if your production server is Heroku, you can create an env_type variable in Heroku or your .env file and set it to 'HEROKU', then use it like this:

    env_type = os.environ.get('env_type', 'LOCAL')
    
    if env_type == 'HEROKU':
        sentry_sdk.init(
            dsn=os.environ.get('SENTRY_DSN', None),
            integrations=[DjangoIntegration()],
    
            # Set traces_sample_rate to 1.0 to capture 100%
            # of transactions for performance monitoring.
            # We recommend adjusting this value in production.
            traces_sample_rate=1.0,
    
            # If you wish to associate users to errors (assuming you are using
            # django.contrib.auth) you may enable sending PII data.
            send_default_pii=True
    )