Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commite4d413c

Browse files
Feature django logging (#30)
* Setup django app config for testing purposes* Add django context, req reader and resp reader* Add django logging support* Export logging middleware to be added in django app for logging capabilities* Write tests for logging in sample django app* Fix pylint issues* Rename django test app to be more descriptive* Add README notes for django support* Fix some errors in docstrings* Apply pull request comment changes* Make pylint version fixed* Remove readme note about django versions
1 parent32199a9 commite4d413c

File tree

15 files changed

+357
-5
lines changed

15 files changed

+357
-5
lines changed

‎README.rst‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Features
2323
* `Flask 0.1x<http://flask.pocoo.org/>`__
2424
* `Sanic 0.5.x<https://github.com/channelcat/sanic>`__
2525
* `Falcon<https://falconframework.org/>`__
26+
* `Django<https://www.djangoproject.com/>`__
2627
* Extensible to support others
2728

2829
6. Includes CF-specific information (space id, app id, etc.) to logs.
@@ -137,6 +138,73 @@ Falcon
137138
app.add_route('/resource', Resource())
138139
falcon_logging.init(app)
139140
141+
Django
142+
^^^^^^
143+
144+
..code::bash
145+
146+
django-admin startproject example
147+
148+
..code::python
149+
150+
# example/settings.py
151+
152+
MIDDLEWARES= [
153+
# ...,
154+
'sap.cf_logging.django_logging.LoggingMiddleware'
155+
]
156+
157+
# example/wsgi.py
158+
159+
# ...
160+
from sap.cf_loggingimport django_logging
161+
162+
os.environ.setdefault("DJANGO_SETTINGS_MODULE","sap_logtesting.settings")
163+
django_logging.init()
164+
165+
# ...
166+
167+
Create a new app
168+
169+
..code::bash
170+
171+
python manage.py startapp example_app
172+
173+
..code::python
174+
175+
# example_app/views.py
176+
177+
import logging
178+
179+
from django.httpimport HTTPResponse
180+
from sap.cf_logging.core.constantsimportREQUEST_KEY
181+
182+
defindex(request):
183+
extra= {REQUEST_KEY: request}
184+
logger= logging.getLogger('my.logger')
185+
logger.info("Resource requested",extra=extra)
186+
return HttpResponse("ok")
187+
188+
# example_app/urls.py
189+
190+
from django.conf.urlsimport url
191+
192+
from .import views
193+
194+
urlpatterns= [
195+
url('^$', views.index)
196+
]
197+
198+
# example/urls.py
199+
200+
from django.contribimport admin
201+
from django.conf.urlsimport url, include
202+
203+
urlpatterns= [
204+
url('admin/', admin.site.urls),
205+
url('example/', include('example_app.urls'))
206+
]
207+
140208
General
141209
^^^^^^^
142210

‎conftest.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
importsys
22

3+
34
ifsys.version_info< (3,5):
45
collect_ignore= ['tests/test_sanic_logging.py']
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
""" Logging support for Django based applications """
2+
importlogging
3+
fromdatetimeimportdatetime
4+
5+
fromsapimportcf_logging
6+
fromsap.cf_loggingimportdefaults
7+
fromsap.cf_logging.core.constantsimportREQUEST_KEY,RESPONSE_KEY
8+
fromsap.cf_logging.core.frameworkimportFramework
9+
fromsap.cf_logging.django_logging.contextimportDjangoContext
10+
fromsap.cf_logging.django_logging.request_readerimportDjangoRequestReader
11+
fromsap.cf_logging.django_logging.response_readerimportDjangoResponseReader
12+
13+
DJANGO_FRAMEWORK_NAME='django.framework'
14+
15+
16+
classLoggingMiddleware(object):
17+
""" Django logging middleware """
18+
19+
def__init__(self,get_response,logger_name='cf.django.logger'):
20+
self._logger_name=logger_name
21+
self._get_response=get_response
22+
23+
def__call__(self,request):
24+
self.process_request(request)
25+
response=self._get_response(request)
26+
27+
response=self.process_response(request,response)
28+
returnresponse
29+
30+
defprocess_request(self,request):# pylint: disable=no-self-use
31+
"""
32+
Process the request before routing it.
33+
34+
:param request: - Django Request object
35+
"""
36+
framework=cf_logging.FRAMEWORK
37+
cid=framework.request_reader.get_correlation_id(request)
38+
framework.context.set_correlation_id(cid,request)
39+
framework.context.set('request_started_at',datetime.utcnow(),request)
40+
41+
defprocess_response(self,request,response):
42+
"""
43+
Post-processing of the response (after routing).
44+
45+
:param request: - Django Request object
46+
:param request: - Django Response object
47+
"""
48+
cf_logging.FRAMEWORK.context.set(
49+
'response_sent_at',datetime.utcnow(),request)
50+
extra= {REQUEST_KEY:request,RESPONSE_KEY:response}
51+
logging.getLogger(self._logger_name).info('',extra=extra)
52+
returnresponse
53+
54+
55+
definit(level=defaults.DEFAULT_LOGGING_LEVEL):
56+
"""
57+
Initializes logging in JSON format.
58+
59+
:param level: - valid log level from standard logging package (optional)
60+
"""
61+
framework=Framework(DJANGO_FRAMEWORK_NAME,DjangoContext(),
62+
DjangoRequestReader(),DjangoResponseReader())
63+
64+
cf_logging.init(framework,level)
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
"""
2+
Django logging context - used by the logging package to keep
3+
request specific data, needed for logging purposes.
4+
For example correlation_id needs to be stored during request processing,
5+
so all log entries contain it.
6+
"""
7+
8+
fromsap.cf_logging.core.contextimportContext
9+
10+
11+
def_init_context(request):
12+
ifnothasattr(request,'context'):
13+
request.context= {}
14+
15+
classDjangoContext(Context):
16+
""" Stores logging context in Django's request objecct """
17+
18+
defset(self,key,value,request):
19+
_init_context(request)
20+
request.context[key]=value
21+
22+
defget(self,key,request):
23+
_init_context(request)
24+
returnrequest.context.get(key)ifrequestelseNone
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
""" Django request reader """
2+
3+
fromsap.cf_loggingimportdefaults
4+
fromsap.cf_logging.core.request_readerimportRequestReader
5+
6+
7+
classDjangoRequestReader(RequestReader):
8+
""" Read log related properties out of Django request """
9+
10+
defget_remote_user(self,request):
11+
returnrequest.META.get('REMOTE_USER')ordefaults.UNKNOWN
12+
13+
defget_protocol(self,request):
14+
returnrequest.scheme
15+
16+
defget_content_length(self,request):
17+
returnrequest.META.get('CONTENT_LENGTH')ordefaults.UNKNOWN
18+
19+
defget_remote_ip(self,request):
20+
returnrequest.META.get('REMOTE_ADDR')
21+
22+
defget_remote_port(self,request):
23+
returnrequest.META.get('SERVER_PORT')ordefaults.UNKNOWN
24+
25+
defget_http_header(self,request,header_name,default=None):
26+
ifrequestisNone:
27+
returndefault
28+
29+
ifheader_nameinrequest.META:
30+
returnrequest.META.get(header_name)
31+
ifheader_name.upper()inrequest.META:
32+
returnrequest.META.get(header_name.upper())
33+
34+
returndefault
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
""" Django response reader """
2+
fromsap.cf_logging.core.response_readerimportResponseReader
3+
4+
5+
classDjangoResponseReader(ResponseReader):
6+
""" Read log related properties out of Django response """
7+
8+
defget_status_code(self,response):
9+
returnresponse.status_code
10+
11+
defget_response_size(self,response):
12+
returnlen(response.content)
13+
14+
defget_content_type(self,response):
15+
returnresponse.get('Content-Type')

‎test-requirements.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ sonic182-json-validator==0.0.12
88
pytest==3.6.2
99
pytest-cov==2.5.1
1010
pytest-mock==1.6.3
11-
pylint
11+
pylint==1.9.2
1212
tox
13+
django

‎tests/common_test_params.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def get_web_record_header_fixtures():
2222
'response_content_type':v_str('text/plain'),
2323
'request':v_str('/test/path')})
2424
]
25-
forheaderin ['x-Correlation-ID','X-CorrelationID','X-Request-ID','X-Vcap-Request-Id']:
25+
forheaderin ['X-Correlation-ID','X-CorrelationID','X-Request-ID','X-Vcap-Request-Id']:
2626
test_cases.append(({header:'298ebf9d-be1d-11e7-88ff-2c44fd152864'},
2727
{'correlation_id':v_str('298ebf9d-be1d-11e7-88ff-2c44fd152864')}))
2828

‎tests/django_logging/__init__.py‎

Whitespace-only changes.

‎tests/django_logging/test_app/__init__.py‎

Whitespace-only changes.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp