132
196
if size <= 4 << 20:
134
198
old_fname = trace_fname + '.old'
135
from osutils import rename
136
rename(trace_fname, old_fname)
199
osutils.rename(trace_fname, old_fname)
141
def open_tracefile(tracefilename=None):
142
# Messages are always written to here, so that we have some
143
# information if something goes wrong. In a future version this
144
# file will be removed on successful completion.
145
global _file_handler, _bzr_log_file, _bzr_log_filename
148
if tracefilename is None:
204
def _get_bzr_log_filename():
205
bzr_log = os.environ.get('BZR_LOG')
208
home = os.environ.get('BZR_HOME')
149
210
if sys.platform == 'win32':
150
211
from bzrlib import win32utils
151
212
home = win32utils.get_home_location()
153
214
home = os.path.expanduser('~')
154
_bzr_log_filename = os.path.join(home, '.bzr.log')
156
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
215
return os.path.join(home, '.bzr.log')
219
"""Open the .bzr.log trace file.
221
If the log is more than a particular length, the old file is renamed to
222
.bzr.log.old and a new file is started. Otherwise, we append to the
225
This sets the global _bzr_log_filename.
227
global _bzr_log_filename
228
_bzr_log_filename = _get_bzr_log_filename()
157
229
_rollover_trace_maybe(_bzr_log_filename)
160
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
161
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
163
# tf.tell() on windows always return 0 until some writing done
166
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
167
tf.write("you can delete or truncate this file, or include sections in\n")
168
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
169
_file_handler = logging.StreamHandler(tf)
170
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
171
datefmt = r'%a %H:%M:%S'
172
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
173
_file_handler.setLevel(logging.DEBUG)
174
logging.getLogger('').addHandler(_file_handler)
231
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
232
# bzr_log_file.tell() on windows always return 0 until some writing done
233
bzr_log_file.write('\n')
234
if bzr_log_file.tell() <= 2:
235
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
236
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
237
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
175
239
except IOError, e:
176
warning("failed to open trace file: %s" % (e))
179
@deprecated_function(zero_nine)
180
def log_exception(msg=None):
181
"""Log the last exception to stderr and the trace file.
183
The exception string representation is used as the error
184
summary, unless msg is given.
186
Please see log_exception_quietly() for the replacement API.
190
log_exception_quietly()
240
# If we are failing to open the log, then most likely logging has not
241
# been set up yet. So we just write to stderr rather than using
242
# 'warning()'. If we using warning(), users get the unhelpful 'no
243
# handlers registered for "bzr"' when something goes wrong on the
244
# server. (bug #503886)
245
sys.stderr.write("failed to open trace file: %s\n" % (e,))
246
# TODO: What should happen if we fail to open the trace file? Maybe the
247
# objects should be pointed at /dev/null or the equivalent? Currently
248
# returns None which will cause failures later.
252
def enable_default_logging():
253
"""Configure default logging: messages to stderr and debug to .bzr.log
255
This should only be called once per process.
257
Non-command-line programs embedding bzrlib do not need to call this. They
258
can instead either pass a file to _push_log_file, or act directly on
259
logging.getLogger("bzr").
261
Output can be redirected away by calling _push_log_file.
263
# Do this before we open the log file, so we prevent
264
# get_terminal_encoding() from mutter()ing multiple times
265
term_encoding = osutils.get_terminal_encoding()
266
start_time = osutils.format_local_date(_bzr_log_start_time,
268
# create encoded wrapper around stderr
269
bzr_log_file = _open_bzr_log()
270
if bzr_log_file is not None:
271
bzr_log_file.write(start_time.encode('utf-8') + '\n')
272
push_log_file(bzr_log_file,
273
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
274
r'%Y-%m-%d %H:%M:%S')
275
# after hooking output into bzr_log, we also need to attach a stderr
276
# handler, writing only at level info and with encoding
277
writer_factory = codecs.getwriter(term_encoding)
278
encoded_stderr = writer_factory(sys.stderr, errors='replace')
279
stderr_handler = logging.StreamHandler(encoded_stderr)
280
stderr_handler.setLevel(logging.INFO)
281
logging.getLogger('bzr').addHandler(stderr_handler)
284
def push_log_file(to_file, log_format=None, date_format=None):
285
"""Intercept log and trace messages and send them to a file.
287
:param to_file: A file-like object to which messages will be sent.
289
:returns: A memento that should be passed to _pop_log_file to restore the
290
previously active logging.
294
new_handler = logging.StreamHandler(to_file)
295
new_handler.setLevel(logging.DEBUG)
296
if log_format is None:
297
log_format = '%(levelname)8s %(message)s'
298
new_handler.setFormatter(logging.Formatter(log_format, date_format))
299
# save and remove any existing log handlers
300
bzr_logger = logging.getLogger('bzr')
301
old_handlers = bzr_logger.handlers[:]
302
del bzr_logger.handlers[:]
303
# set that as the default logger
304
bzr_logger.addHandler(new_handler)
305
bzr_logger.setLevel(logging.DEBUG)
306
# TODO: check if any changes are needed to the root logger
308
# TODO: also probably need to save and restore the level on bzr_logger.
309
# but maybe we can avoid setting the logger level altogether, and just set
310
# the level on the handler?
312
# save the old trace file
313
old_trace_file = _trace_file
314
# send traces to the new one
315
_trace_file = to_file
316
result = new_handler, _trace_file
317
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
320
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
321
"""Undo changes to logging/tracing done by _push_log_file.
323
This flushes, but does not close the trace file.
325
Takes the memento returned from _push_log_file."""
327
_trace_file = old_trace_file
328
bzr_logger = logging.getLogger('bzr')
329
bzr_logger.removeHandler(new_handler)
330
# must be closed, otherwise logging will try to close it atexit, and the
331
# file will likely already be closed underneath.
333
bzr_logger.handlers = old_handlers
334
new_trace_file.flush()
193
337
def log_exception_quietly():
194
338
"""Log the last exception to the trace file only.
196
Used for exceptions that occur internally and that may be
197
interesting to developers but not to users. For example,
340
Used for exceptions that occur internally and that may be
341
interesting to developers but not to users. For example,
198
342
errors loading plugins.
201
344
mutter(traceback.format_exc())
204
def enable_default_logging():
205
"""Configure default logging to stderr and .bzr.log"""
206
# FIXME: if this is run twice, things get confused
207
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
208
_stderr_handler = logging.StreamHandler()
209
logging.getLogger('').addHandler(_stderr_handler)
210
_stderr_handler.setLevel(logging.INFO)
211
if not _file_handler:
213
_trace_file = _bzr_log_file
215
_file_handler.setLevel(logging.DEBUG)
216
_bzr_logger.setLevel(logging.DEBUG)
347
def set_verbosity_level(level):
348
"""Set the verbosity level.
350
:param level: -ve for quiet, 0 for normal, +ve for verbose
352
global _verbosity_level
353
_verbosity_level = level
354
_update_logging_level(level < 0)
357
def get_verbosity_level():
358
"""Get the verbosity level.
360
See set_verbosity_level() for values.
362
return _verbosity_level
219
365
def be_quiet(quiet=True):
220
global _stderr_handler, _stderr_quiet
222
_stderr_quiet = quiet
224
_stderr_handler.setLevel(logging.WARNING)
226
_stderr_handler.setLevel(logging.INFO)
366
# Perhaps this could be deprecated now ...
368
set_verbosity_level(-1)
370
set_verbosity_level(0)
373
def _update_logging_level(quiet=True):
374
"""Hide INFO messages if quiet."""
376
_bzr_logger.setLevel(logging.WARNING)
378
_bzr_logger.setLevel(logging.INFO)
234
def disable_default_logging():
235
"""Turn off default log handlers.
237
This is intended to be used by the test framework, which doesn't
238
want leakage from the code-under-test into the main logs.
241
l = logging.getLogger('')
242
l.removeHandler(_stderr_handler)
244
l.removeHandler(_file_handler)
248
def enable_test_log(to_file):
249
"""Redirect logging to a temporary file for a test
251
returns an opaque reference that should be passed to disable_test_log
252
after the test completes.
254
disable_default_logging()
257
hdlr = logging.StreamHandler(to_file)
258
hdlr.setLevel(logging.DEBUG)
259
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
260
_bzr_logger.addHandler(hdlr)
261
_bzr_logger.setLevel(logging.DEBUG)
262
result = hdlr, _trace_file, _trace_depth
263
_trace_file = to_file
268
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
269
_bzr_logger.removeHandler(test_log_hdlr)
270
test_log_hdlr.close()
273
_trace_file = old_trace_file
274
_trace_depth = old_trace_depth
276
enable_default_logging()
382
"""Is the verbosity level negative?"""
383
return _verbosity_level < 0
387
"""Is the verbosity level positive?"""
388
return _verbosity_level > 0
391
def debug_memory(message='', short=True):
392
"""Write out a memory dump."""
393
if sys.platform == 'win32':
394
from bzrlib import win32utils
395
win32utils.debug_memory_win32api(message=message, short=short)
397
_debug_memory_proc(message=message, short=short)
400
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
402
def _debug_memory_proc(message='', short=True):
404
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
408
status = status_file.read()
413
for line in status.splitlines():
417
for field in _short_fields:
418
if line.startswith(field):
279
423
def report_exception(exc_info, err_file):
424
"""Report an exception to err_file (typically stderr) and to .bzr.log.
426
This will show either a full traceback or a short message as appropriate.
428
:return: The appropriate exit code for this error.
280
430
exc_type, exc_object, exc_tb = exc_info
281
431
# Log the full traceback to ~/.bzr.log
282
432
log_exception_quietly()
283
433
if (isinstance(exc_object, IOError)
284
434
and getattr(exc_object, 'errno', None) == errno.EPIPE):
285
print >>err_file, "bzr: broken pipe"
435
err_file.write("bzr: broken pipe\n")
436
return errors.EXIT_ERROR
286
437
elif isinstance(exc_object, KeyboardInterrupt):
287
print >>err_file, "bzr: interrupted"
438
err_file.write("bzr: interrupted\n")
439
return errors.EXIT_ERROR
440
elif isinstance(exc_object, MemoryError):
441
err_file.write("bzr: out of memory\n")
442
return errors.EXIT_ERROR
443
elif isinstance(exc_object, ImportError) \
444
and str(exc_object).startswith("No module named "):
445
report_user_error(exc_info, err_file,
446
'You may need to install this Python library separately.')
447
return errors.EXIT_ERROR
288
448
elif not getattr(exc_object, 'internal_error', True):
289
449
report_user_error(exc_info, err_file)
450
return errors.EXIT_ERROR
290
451
elif isinstance(exc_object, (OSError, IOError)):
291
452
# Might be nice to catch all of these and show them as something more
292
453
# specific, but there are too many cases at the moment.
293
454
report_user_error(exc_info, err_file)
455
return errors.EXIT_ERROR
295
457
report_bug(exc_info, err_file)
458
return errors.EXIT_INTERNAL_ERROR
461
def print_exception(exc_info, err_file):
462
exc_type, exc_object, exc_tb = exc_info
463
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
464
exc_type.__module__, exc_type.__name__, exc_object))
466
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
298
469
# TODO: Should these be specially encoding the output?
299
def report_user_error(exc_info, err_file):
470
def report_user_error(exc_info, err_file, advice=None):
300
471
"""Report to err_file an error that's not an internal error.
302
473
These don't get a traceback unless -Derror was given.
475
:param exc_info: 3-tuple from sys.exc_info()
476
:param advice: Extra advice to the user to be printed following the
304
479
if 'error' in debug.debug_flags:
305
report_bug(exc_info, err_file)
480
print_exception(exc_info, err_file)
307
print >>err_file, "bzr: ERROR:", str(exc_info[1])
482
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
484
err_file.write("%s\n" % (advice,))
310
487
def report_bug(exc_info, err_file):
311
488
"""Report an exception that probably indicates a bug in bzr"""
313
exc_type, exc_object, exc_tb = exc_info
314
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
315
exc_type.__module__, exc_type.__name__, exc_object)
317
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
319
print >>err_file, 'bzr %s on python %s (%s)' % \
321
'.'.join(map(str, sys.version_info)),
323
print >>err_file, 'arguments: %r' % sys.argv
325
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
489
from bzrlib.crash import report_bug
490
report_bug(exc_info, err_file)