mirror of
https://github.com/sprockets/sprockets.logging.git
synced 2024-11-21 11:18:35 +00:00
Update docs, revert tornado-app.py example, add new one
This commit is contained in:
parent
80beb20c2e
commit
553688c87a
3 changed files with 101 additions and 11 deletions
|
@ -17,3 +17,16 @@ the custom filter and format string into the logging infrastructure and
|
|||
insert context easily with :class:`logging.LoggerAdapter`.
|
||||
|
||||
.. literalinclude:: ../examples/tornado-app.py
|
||||
|
||||
|
||||
Tornado Application JSON Logging
|
||||
--------------------------------
|
||||
If you're looking to log Tornado requests as JSON, the
|
||||
:class:`sprockets.logging.JSONRequestFormatter` class works in conjunction with
|
||||
the :method:`tornado_log_function` method to output all Tornado log entries as
|
||||
JSON objects. In the following example, the dictionary-based configuration is
|
||||
expanded upon to include specify the :class:`sprockets.logging.JSONRequestFormatter`
|
||||
as the formatter and passes :method:`tornado_log_function` in as the ``log_function``
|
||||
when creating the Tornado application.
|
||||
|
||||
.. literalinclude:: ../examples/tornado-json-logger.py
|
||||
|
|
|
@ -13,30 +13,31 @@ LOG_CONFIG = {
|
|||
'class': 'logging.StreamHandler',
|
||||
'stream': 'ext://sys.stdout',
|
||||
'formatter': 'simple',
|
||||
'filters': ['context']
|
||||
}
|
||||
'filters': ['context'],
|
||||
},
|
||||
},
|
||||
'formatters': {
|
||||
'simple': {
|
||||
'()': sprockets.logging.JSONRequestFormatter
|
||||
}
|
||||
'class': 'logging.Formatter',
|
||||
'format': '%(levelname)s %(name)s: %(message)s [%(context)s]',
|
||||
},
|
||||
},
|
||||
'filters': {
|
||||
'context': {
|
||||
'()': 'sprockets.logging.ContextFilter',
|
||||
'properties': ['context']
|
||||
}
|
||||
'properties': ['context'],
|
||||
},
|
||||
},
|
||||
'loggers': {
|
||||
'tornado': {
|
||||
'level': 'DEBUG'
|
||||
}
|
||||
'level': 'DEBUG',
|
||||
},
|
||||
},
|
||||
'root': {
|
||||
'handlers': ['console'],
|
||||
'level': 'DEBUG'
|
||||
'level': 'DEBUG',
|
||||
},
|
||||
'incremental': False
|
||||
'incremental': False,
|
||||
}
|
||||
|
||||
|
||||
|
@ -68,7 +69,7 @@ if __name__ == '__main__':
|
|||
app = web.Application([
|
||||
web.url('/(?P<object_id>\w+)', RequestHandler,
|
||||
kwargs={'parent_log': logger}),
|
||||
], log_function=sprockets.logging.tornado_log_function)
|
||||
])
|
||||
app.listen(8000)
|
||||
signal.signal(signal.SIGINT, sig_handler)
|
||||
signal.signal(signal.SIGTERM, sig_handler)
|
||||
|
|
76
examples/tornado-json-logger.py
Normal file
76
examples/tornado-json-logger.py
Normal file
|
@ -0,0 +1,76 @@
|
|||
import logging.config
|
||||
import signal
|
||||
import uuid
|
||||
|
||||
from tornado import ioloop, web
|
||||
import sprockets.logging
|
||||
|
||||
|
||||
LOG_CONFIG = {
|
||||
'version': 1,
|
||||
'handlers': {
|
||||
'console': {
|
||||
'class': 'logging.StreamHandler',
|
||||
'stream': 'ext://sys.stdout',
|
||||
'formatter': 'simple',
|
||||
'filters': ['context']
|
||||
}
|
||||
},
|
||||
'formatters': {
|
||||
'simple': {
|
||||
'()': sprockets.logging.JSONRequestFormatter
|
||||
}
|
||||
},
|
||||
'filters': {
|
||||
'context': {
|
||||
'()': 'sprockets.logging.ContextFilter',
|
||||
'properties': ['context']
|
||||
}
|
||||
},
|
||||
'loggers': {
|
||||
'tornado': {
|
||||
'level': 'DEBUG'
|
||||
}
|
||||
},
|
||||
'root': {
|
||||
'handlers': ['console'],
|
||||
'level': 'DEBUG'
|
||||
},
|
||||
'incremental': False
|
||||
}
|
||||
|
||||
|
||||
class RequestHandler(web.RequestHandler):
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
self.parent_log = kwargs.pop('parent_log')
|
||||
super(RequestHandler, self).__init__(*args, **kwargs)
|
||||
|
||||
def prepare(self):
|
||||
uniq_id = self.request.headers.get('X-UniqID', uuid.uuid4().hex)
|
||||
self.logger = logging.LoggerAdapter(
|
||||
self.parent_log.getChild('RequestHandler'),
|
||||
extra={'context': uniq_id})
|
||||
|
||||
def get(self, object_id):
|
||||
self.logger.debug('fetchin %s', object_id)
|
||||
self.set_status(200)
|
||||
return self.finish()
|
||||
|
||||
def sig_handler(signo, frame):
|
||||
logging.info('caught signal %d, stopping IO loop', signo)
|
||||
iol = ioloop.IOLoop.instance()
|
||||
iol.add_callback_from_signal(iol.stop)
|
||||
|
||||
if __name__ == '__main__':
|
||||
logging.config.dictConfig(LOG_CONFIG)
|
||||
logger = logging.getLogger('app')
|
||||
app = web.Application([
|
||||
web.url('/(?P<object_id>\w+)', RequestHandler,
|
||||
kwargs={'parent_log': logger}),
|
||||
], log_function=sprockets.logging.tornado_log_function)
|
||||
app.listen(8000)
|
||||
signal.signal(signal.SIGINT, sig_handler)
|
||||
signal.signal(signal.SIGTERM, sig_handler)
|
||||
ioloop.IOLoop.instance().start()
|
||||
logger.info('IO loop stopped, exiting')
|
Loading…
Reference in a new issue