Skip to content

Commit 442de87

Browse files
author
Emanuele Palazzetti
committed
[django] minor renamings
1 parent 3cd7278 commit 442de87

File tree

6 files changed

+26
-23
lines changed

6 files changed

+26
-23
lines changed

ddtrace/contrib/django/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,24 @@
1919
)
2020
2121
The configuration of this integration is all namespaced inside a single
22-
Django setting, named ``DATADOG_APM``. For example, your ``settings.py``
22+
Django setting, named ``DATADOG_TRACE``. For example, your ``settings.py``
2323
may contain::
2424
25-
DATADOG_APM = {
25+
DATADOG_TRACE = {
2626
'DEFAULT_SERVICE': 'my-django-app',
2727
}
2828
2929
If you need to access to the tracing settings, you should::
3030
31-
from ddtrace.contrib.django.conf import settings as dd_settings
31+
from ddtrace.contrib.django.conf import settings
3232
33-
tracer = dd_settings.DEFAULT_TRACER
33+
tracer = settings.TRACER
3434
tracer.trace("something")
3535
# your code ...
3636
3737
The available settings are:
3838
39-
* ``DEFAULT_TRACER`` (default ``ddtrace.tracer``): set the default tracer
39+
* ``TRACER`` (default ``ddtrace.tracer``): set the default tracer
4040
instance that is used to trace Django internals. By default the ``ddtrace``
4141
tracer is used.
4242
* ``DEFAULT_SERVICE`` (default: ``django``): set the service name used by the

ddtrace/contrib/django/apps.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def ready(self):
2424
all Django internals are properly configured.
2525
"""
2626
if settings.ENABLED:
27-
tracer = settings.DEFAULT_TRACER
27+
tracer = settings.TRACER
2828

2929
# define the service details
3030
tracer.set_service_info(
@@ -33,10 +33,13 @@ def ready(self):
3333
app_type=AppTypes.web,
3434
)
3535

36+
# trace Django internals
3637
try:
37-
# trace Django internals
38-
patch_template(tracer)
3938
patch_db(tracer)
4039
except Exception:
41-
# TODO[manu]: we can provide better details there
42-
log.exception('error patching Django internals')
40+
log.exception('error patching Django database connections')
41+
42+
try:
43+
patch_template(tracer)
44+
except Exception:
45+
log.exception('error patching Django template rendering')

ddtrace/contrib/django/conf.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
"""
2-
Settings for Datadog tracer are all namespaced in the DATADOG_APM setting.
2+
Settings for Datadog tracer are all namespaced in the DATADOG_TRACE setting.
33
For example your project's `settings.py` file might look like this:
44
5-
DATADOG_APM = {
6-
'DEFAULT_TRACER': 'myapp.tracer',
5+
DATADOG_TRACE = {
6+
'TRACER': 'myapp.tracer',
77
}
88
99
This module provides the `setting` object, that is used to access
@@ -19,18 +19,18 @@
1919
from django.test.signals import setting_changed
2020

2121

22-
USER_SETTINGS = getattr(django_settings, 'DATADOG_APM', None)
22+
USER_SETTINGS = getattr(django_settings, 'DATADOG_TRACE', None)
2323

2424
# List of available settings with their defaults
2525
DEFAULTS = {
26-
'DEFAULT_TRACER': 'ddtrace.tracer',
26+
'TRACER': 'ddtrace.tracer',
2727
'DEFAULT_SERVICE': 'django',
2828
'ENABLED': not django_settings.DEBUG,
2929
}
3030

3131
# List of settings that may be in string import notation.
3232
IMPORT_STRINGS = (
33-
'DEFAULT_TRACER',
33+
'TRACER',
3434
)
3535

3636
# List of settings that have been removed
@@ -63,7 +63,7 @@ class DatadogSettings(object):
6363
6464
from ddtrace.contrib.django.conf import settings
6565
66-
tracer = settings.DEFAULT_TRACER
66+
tracer = settings.TRACER
6767
6868
Any setting with string import paths will be automatically resolved
6969
and return the class, rather than the string literal.
@@ -77,7 +77,7 @@ def __init__(self, user_settings=None, defaults=None, import_strings=None):
7777
@property
7878
def user_settings(self):
7979
if not hasattr(self, '_user_settings'):
80-
self._user_settings = getattr(settings, 'DATADOG_APM', {})
80+
self._user_settings = getattr(settings, 'DATADOG_TRACE', {})
8181
return self._user_settings
8282

8383
def __getattr__(self, attr):
@@ -118,7 +118,7 @@ def reload_settings(*args, **kwargs):
118118
"""
119119
global settings
120120
setting, value = kwargs['setting'], kwargs['value']
121-
if setting == 'DATADOG_APM':
121+
if setting == 'DATADOG_TRACE':
122122
settings = DatadogSettings(value, DEFAULTS, IMPORT_STRINGS)
123123

124124

ddtrace/contrib/django/middleware.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def __init__(self):
2424
raise MiddlewareNotUsed
2525

2626
def process_request(self, request):
27-
tracer = settings.DEFAULT_TRACER
27+
tracer = settings.TRACER
2828

2929
try:
3030
span = tracer.trace(

tests/contrib/django/app/settings.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@
6464
'ddtrace.contrib.django',
6565
]
6666

67-
DATADOG_APM = {
67+
DATADOG_TRACE = {
6868
# tracer with a DummyWriter
69-
'DEFAULT_TRACER': 'tests.contrib.django.utils.tracer',
69+
'TRACER': 'tests.contrib.django.utils.tracer',
7070
'ENABLED': True,
7171
}

tests/contrib/django/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class DjangoTraceTestCase(TestCase):
2525
"""
2626
def setUp(self):
2727
# assign the default tracer
28-
self.tracer = settings.DEFAULT_TRACER
28+
self.tracer = settings.TRACER
2929
# empty the tracer spans from previous operations
3030
# such as database creation queries
3131
self.tracer.writer.spans = []

0 commit comments

Comments
 (0)