• Search by Module
• Search by Words
• Search Projects

• Java
• Python
• JavaScript
• TypeScript
• C++
• Scala
• Blog

• scout_apm_python-master
  • src
    • scout_apm
      • sqlalchemy.py
      • nameko.py
      • dramatiq.py
      • pyramid.py
      • falcon.py
      • api
        • __init__.py
      • bottle.py
      • cherrypy.py
      • hug.py
      • django
        • apps.py
        • middleware.py
        • __init__.py
        • instruments
          • sql.py
          • template.py
          • __init__.py
          • huey.py
      • __init__.py
      • rq.py
      • async_
        • starlette.py
        • __init__.py
        • instruments
          • jinja2.py
          • __init__.py
      • instruments
        • redis.py
        • jinja2.py
        • pymongo.py
        • __init__.py
        • urllib3.py
        • elasticsearch.py
      • core
        • threading.py
        • config.py
        • socket.py
        • web_requests.py
        • cli
          • core_agent_manager.py
          • __init__.py
        • stacktracer.py
        • core_agent_manager.py
        • _objtrace.c
        • backtrace.py
        • commands.py
        • metadata.py
        • platform_detection.py
        • __init__.py
        • objtrace.py
        • context.py
        • n_plus_one_tracker.py
        • samplers
          • cpu.py
          • memory.py
          • __init__.py
          • thread.py
        • tracked_request.py
      • compat.py
      • huey.py
      • celery.py
      • flask
        • sqlalchemy.py
        • __init__.py
  • .python-version
  • .pre-commit-config.yaml
  • LICENSE
  • DEVELOPMENT.md
  • CHANGELOG.md
  • setup.py
  • setup.cfg
  • .travis.yml
  • README.md
  • tests
    • integration
      • test_starlette_py36plus.py
      • test_flask.py
      • util.py
      • test_nameko.py
      • test_dramatiq.py
      • app.py
      • test_bottle.py
      • test_huey.py
      • test_instruments.py
      • django_app.py
      • test_cherrypy.py
      • test_flask_sqlalchemy.py
      • test_celery.py
      • __init__.py
      • instruments
        • test_elasticsearch.py
        • test_jinja2.py
        • test_pymongo.py
        • test_jinja2_py36plus.py
        • __init__.py
        • test_redis.py
        • test_urllib3.py
      • core
        • test_core_agent_manager.py
        • __init__.py
        • test_socket.py
      • test_rq.py
      • test_api.py
      • test_pyramid.py
      • test_falcon.py
      • test_sqlalchemy.py
      • test_django.py
      • test_hug.py
    • tools.py
    • __init__.py
    • compat.py
    • unit
      • test_compat.py
      • __init__.py
      • core
        • test_stacktracer.py
        • test_backtrace.py
        • test_metadata.py
        • test_platform_detection.py
        • test_objtrace.py
        • test_commands.py
        • cli
          • test_core_agent_manager.py
        • test_web_requests.py
        • test_tracked_request.py
        • test_config.py
        • test_n_plus_one_tracker.py
        • __init__.py
        • samplers
          • test_memory.py
          • test_thread.py
          • test_cpu.py
          • __init__.py
        • test_threading.py
      • test_core.py
    • conftest.py
  • pytest.ini
  • .gitignore
  • MANIFEST.in
  • tox.ini

# coding=utf-8
from __future__ import absolute_import, division, print_function, unicode_literals

from django.apps import AppConfig
from django.conf import settings
from django.test.signals import setting_changed

import scout_apm.core
from scout_apm.core.config import scout_config
from scout_apm.django.instruments.huey import ensure_huey_instrumented
from scout_apm.django.instruments.sql import ensure_sql_instrumented
from scout_apm.django.instruments.template import ensure_templates_instrumented


class ScoutApmDjangoConfig(AppConfig):
    name = "scout_apm"
    verbose_name = "Scout Apm (Django)"

    def ready(self):
        self.update_scout_config_from_django_settings()
        setting_changed.connect(self.on_setting_changed)

        # Finish installing the agent. If the agent isn't installed for any
        # reason, return without installing instruments
        installed = scout_apm.core.install()
        if not installed:
            return

        self.install_middleware()

        # Setup Instruments
        ensure_huey_instrumented()
        ensure_sql_instrumented()
        ensure_templates_instrumented()

    def update_scout_config_from_django_settings(self, **kwargs):
        for name in dir(settings):
            self.on_setting_changed(name)

    def on_setting_changed(self, setting, **kwargs):
        cast = None
        if setting == "BASE_DIR":
            scout_name = "application_root"
            cast = str
        elif setting.startswith("SCOUT_"):
            scout_name = setting.replace("SCOUT_", "").lower()
        else:
            return

        try:
            value = getattr(settings, setting)
        except AttributeError:
            # It was removed
            scout_config.unset(scout_name)
        else:
            if cast is not None:
                value = cast(value)
            scout_config.set(**{scout_name: value})

    def install_middleware(self):
        """
        Attempts to insert the ScoutApm middleware as the first middleware
        (first on incoming requests, last on outgoing responses).
        """
        from django.conf import settings

        # If MIDDLEWARE is set, update that, with handling of tuple vs array forms
        if getattr(settings, "MIDDLEWARE", None) is not None:
            timing_middleware = "scout_apm.django.middleware.MiddlewareTimingMiddleware"
            view_middleware = "scout_apm.django.middleware.ViewTimingMiddleware"

            if isinstance(settings.MIDDLEWARE, tuple):
                if timing_middleware not in settings.MIDDLEWARE:
                    settings.MIDDLEWARE = (timing_middleware,) + settings.MIDDLEWARE
                if view_middleware not in settings.MIDDLEWARE:
                    settings.MIDDLEWARE = settings.MIDDLEWARE + (view_middleware,)
            else:
                if timing_middleware not in settings.MIDDLEWARE:
                    settings.MIDDLEWARE.insert(0, timing_middleware)
                if view_middleware not in settings.MIDDLEWARE:
                    settings.MIDDLEWARE.append(view_middleware)

        # Otherwise, we're doing old style middleware, do the same thing with
        # the same handling of tuple vs array forms
        else:
            timing_middleware = (
                "scout_apm.django.middleware.OldStyleMiddlewareTimingMiddleware"
            )
            view_middleware = "scout_apm.django.middleware.OldStyleViewMiddleware"

            if isinstance(settings.MIDDLEWARE_CLASSES, tuple):
                if timing_middleware not in settings.MIDDLEWARE_CLASSES:
                    settings.MIDDLEWARE_CLASSES = (
                        timing_middleware,
                    ) + settings.MIDDLEWARE_CLASSES

                if view_middleware not in settings.MIDDLEWARE_CLASSES:
                    settings.MIDDLEWARE_CLASSES = settings.MIDDLEWARE_CLASSES + (
                        view_middleware,
                    )
            else:
                if timing_middleware not in settings.MIDDLEWARE_CLASSES:
                    settings.MIDDLEWARE_CLASSES.insert(0, timing_middleware)
                if view_middleware not in settings.MIDDLEWARE_CLASSES:
                    settings.MIDDLEWARE_CLASSES.append(view_middleware)