def test_logTooLong(self):
"""
If the log event is too long to fit in a UDP datagram, send regrets.
"""
logger = udplog.UDPLogger()
self._catchOutput(logger)
logger.log('atest', {u'message': u'a' * self.MAX_DATAGRAM_SIZE,
u'timestamp': 1357328823.75116})
self.assertEqual(1, len(self.output))
category, eventDict = udplog.unserialize(self.output[0])
self.assertEqual('udplog', category)
self.assertEqual(u'Failed to send udplog message',
eventDict[u'message'])
self.assertEqual(u'socket.error', eventDict['excType'])
self.assertEqual(u'[Errno %d] Message too long' % errno.EMSGSIZE,
eventDict[u'excValue'])
self.assertIn(u'excText', eventDict)
self.assertEqual(u'WARNING', eventDict[u'logLevel'])
# Check trimmed original
original = eventDict[u'original']
self.assertEqual(u'atest', original[u'category'])
self.assertEqual(1357328823.75116, original[u'timestamp'])
self.assertEqual(u'a' * (udplog.MAX_TRIMMED_MESSAGE_SIZE - 4) + '[..]',
original[u'message'])
self.assertEqual(self.MAX_DATAGRAM_SIZE,
eventDict[u'original_message_size'])
self.assertLess(self.MAX_DATAGRAM_SIZE,
eventDict[u'original_size'])
def test_logTooLong(self):
"""
If the log event is too long to fit in a UDP datagram, send regrets.
"""
logger = udplog.UDPLogger()
self._catchOutput(logger)
logger.log(
'atest', {
u'message': u'a' * self.MAX_DATAGRAM_SIZE,
u'timestamp': 1357328823.75116
})
self.assertEqual(1, len(self.output))
category, eventDict = udplog.unserialize(self.output[0])
self.assertEqual('udplog', category)
self.assertEqual(u'Failed to send udplog message',
eventDict[u'message'])
self.assertEqual(u'socket.error', eventDict['excType'])
self.assertEqual(u'[Errno %d] Message too long' % errno.EMSGSIZE,
eventDict[u'excValue'])
self.assertIn(u'excText', eventDict)
self.assertEqual(u'WARNING', eventDict[u'logLevel'])
# Check trimmed original
original = eventDict[u'original']
self.assertEqual(u'atest', original[u'category'])
self.assertEqual(1357328823.75116, original[u'timestamp'])
self.assertEqual(u'a' * (udplog.MAX_TRIMMED_MESSAGE_SIZE - 4) + '[..]',
original[u'message'])
self.assertEqual(self.MAX_DATAGRAM_SIZE,
eventDict[u'original_message_size'])
self.assertLess(self.MAX_DATAGRAM_SIZE, eventDict[u'original_size'])
def datagramReceived(self, datagram, addr):
data = datagram.rstrip()
try:
category, event = udplog.unserialize(data)
event['category'] = category
except (ValueError, TypeError):
log.err()
return
self.callback(event)
def test_logTooLongDefault(self):
"""
If the log event is too long, the warning has default fields.
"""
logger = udplog.UDPLogger(defaultFields={'foo': 'bar'})
self._catchOutput(logger)
logger.log('atest', {u'message': u'a' * self.MAX_DATAGRAM_SIZE,
u'timestamp': 1357328823.75116})
self.assertEqual(1, len(self.output))
category, eventDict = udplog.unserialize(self.output[0])
self.assertIn('foo', eventDict)
def test_logObjects(self):
"""
Arbitrary objects do not choke the JSON encoding.
"""
class Something(object):
pass
something = Something()
logger = udplog.UDPLogger()
self._catchOutput(logger)
logger.log('atest', {u'something': something})
category, eventDict = udplog.unserialize(self.output[0])
self.assertEqual(repr(something), eventDict[u'something'])
def test_augmentDefaultFields(self):
"""
Every log event gets default fields.
"""
defaultFields = {u'hostname': u'foo.example.org'}
logger = udplog.UDPLogger(defaultFields=defaultFields)
self._catchOutput(logger)
logger.log('test', {u'message': u'test'})
category, eventDict = udplog.unserialize(self.output[0])
self.assertIn(u'hostname', eventDict)
self.assertEqual(u'foo.example.org', eventDict[u'hostname'])
def test_logObjects(self):
"""
Arbitrary objects do not choke the JSON encoding.
"""
class Something(object):
pass
something = Something()
logger = udplog.UDPLogger()
self._catchOutput(logger)
logger.log('atest', {u'something': something})
category, eventDict = udplog.unserialize(self.output[0])
self.assertEqual(repr(something), eventDict[u'something'])
def test_augmentDefaultFields(self):
"""
Every log event gets default fields.
"""
defaultFields = {u'hostname': u'foo.example.org'}
logger = udplog.UDPLogger(defaultFields=defaultFields)
self._catchOutput(logger)
logger.log('test', {u'message': u'test'})
category, eventDict = udplog.unserialize(self.output[0])
self.assertIn(u'hostname', eventDict)
self.assertEqual(u'foo.example.org', eventDict[u'hostname'])
def test_augmentDefaultFieldsOverride(self):
"""
Default fields can be overridden in individual events.
"""
defaultFields = {u'hostname': u'foo.example.org'}
logger = udplog.UDPLogger(defaultFields=defaultFields)
self._catchOutput(logger)
logger.log('test', {u'message': u'test',
u'hostname': u'bar.example.org'})
category, eventDict = udplog.unserialize(self.output[0])
self.assertIn(u'hostname', eventDict)
self.assertEqual(u'bar.example.org', eventDict[u'hostname'])
def test_logTooLongDefault(self):
"""
If the log event is too long, the warning has default fields.
"""
logger = udplog.UDPLogger(defaultFields={'foo': 'bar'})
self._catchOutput(logger)
logger.log(
'atest', {
u'message': u'a' * self.MAX_DATAGRAM_SIZE,
u'timestamp': 1357328823.75116
})
self.assertEqual(1, len(self.output))
category, eventDict = udplog.unserialize(self.output[0])
self.assertIn('foo', eventDict)
def test_augmentTimestamp(self):
"""
Every log event gets a timestamp if not already set.
"""
logger = udplog.UDPLogger()
self._catchOutput(logger)
before = time.time()
logger.log('test', {u'message': u'test'})
after = time.time()
category, eventDict = udplog.unserialize(self.output[0])
self.assertIn(u'timestamp', eventDict)
timestamp = eventDict[u'timestamp']
self.assertGreaterEqual(timestamp, before)
self.assertLessEqual(timestamp, after)
def test_augmentDefaultFieldsOverride(self):
"""
Default fields can be overridden in individual events.
"""
defaultFields = {u'hostname': u'foo.example.org'}
logger = udplog.UDPLogger(defaultFields=defaultFields)
self._catchOutput(logger)
logger.log('test', {
u'message': u'test',
u'hostname': u'bar.example.org'
})
category, eventDict = udplog.unserialize(self.output[0])
self.assertIn(u'hostname', eventDict)
self.assertEqual(u'bar.example.org', eventDict[u'hostname'])
def test_augmentTimestamp(self):
"""
Every log event gets a timestamp if not already set.
"""
logger = udplog.UDPLogger()
self._catchOutput(logger)
before = time.time()
logger.log('test', {u'message': u'test'})
after = time.time()
category, eventDict = udplog.unserialize(self.output[0])
self.assertIn(u'timestamp', eventDict)
timestamp = eventDict[u'timestamp']
self.assertGreaterEqual(timestamp, before)
self.assertLessEqual(timestamp, after)
def test_log(self):
"""
A log event is serialized and sent out over UDP.
"""
logger = udplog.UDPLogger()
self._catchOutput(logger)
logger.log('test', {u'message': u'test'})
self.assertEqual(1, len(self.output))
msg = self.output[0]
self.assertRegexpMatches(msg, r'^test:\t{.*}$')
category, eventDict = udplog.unserialize(msg)
self.assertEqual(b'test', category)
self.assertIn(u'message', eventDict)
self.assertEqual(u'test', eventDict[u'message'])
def test_log(self):
"""
A log event is serialized and sent out over UDP.
"""
logger = udplog.UDPLogger()
self._catchOutput(logger)
logger.log('test', {u'message': u'test'})
self.assertEqual(1, len(self.output))
msg = self.output[0]
self.assertRegexpMatches(msg, r'^test:\t{.*}$')
category, eventDict = udplog.unserialize(msg)
self.assertEqual(b'test', category)
self.assertIn(u'message', eventDict)
self.assertEqual(u'test', eventDict[u'message'])
def test_logTooLongAdditionalFields(self):
"""
If the log event is too long, keep several fields.
"""
logger = udplog.UDPLogger()
self._catchOutput(logger)
eventDict = {
u'message': u'a' * self.MAX_DATAGRAM_SIZE,
u'timestamp': 1357328823.75116,
u'logLevel': u'ERROR',
u'logName': __name__,
u'excType': u'exceptions.ValueError',
u'excValue': 'Oops',
u'excText': u'exceptions.ValueError: Oops',
u'filename': __file__,
u'lineno': 4,
u'funcName': u'test_log_too_long_additional_fields',
u'foo': u'bar',
}
logger.log('atest', eventDict)
self.assertEqual(1, len(self.output))
category, failEventDict = udplog.unserialize(self.output[0])
original = failEventDict[u'original']
self.assertEqual(eventDict[u'logLevel'], original[u'logLevel'])
self.assertEqual(eventDict[u'logName'], original[u'logName'])
self.assertEqual(eventDict[u'excType'], original[u'excType'])
self.assertEqual(eventDict[u'excValue'], original[u'excValue'])
self.assertEqual(eventDict[u'excText'], original[u'excText'])
self.assertEqual(eventDict[u'filename'], original[u'filename'])
self.assertEqual(eventDict[u'lineno'], original[u'lineno'])
self.assertEqual(eventDict[u'funcName'], original[u'funcName'])
self.assertNotIn(u'foo', original)
def test_logTooLongAdditionalFields(self):
"""
If the log event is too long, keep several fields.
"""
logger = udplog.UDPLogger()
self._catchOutput(logger)
eventDict = {
u'message': u'a' * self.MAX_DATAGRAM_SIZE,
u'timestamp': 1357328823.75116,
u'logLevel': u'ERROR',
u'logName': __name__,
u'excType': u'exceptions.ValueError',
u'excValue': 'Oops',
u'excText': u'exceptions.ValueError: Oops',
u'filename': __file__,
u'lineno': 4,
u'funcName': u'test_log_too_long_additional_fields',
u'foo': u'bar',
}
logger.log('atest', eventDict)
self.assertEqual(1, len(self.output))
category, failEventDict = udplog.unserialize(self.output[0])
original = failEventDict[u'original']
self.assertEqual(eventDict[u'logLevel'], original[u'logLevel'])
self.assertEqual(eventDict[u'logName'], original[u'logName'])
self.assertEqual(eventDict[u'excType'], original[u'excType'])
self.assertEqual(eventDict[u'excValue'], original[u'excValue'])
self.assertEqual(eventDict[u'excText'], original[u'excText'])
self.assertEqual(eventDict[u'filename'], original[u'filename'])
self.assertEqual(eventDict[u'lineno'], original[u'lineno'])
self.assertEqual(eventDict[u'funcName'], original[u'funcName'])
self.assertNotIn(u'foo', original)
