131
196
if size <= 4 << 20:
133
198
old_fname = trace_fname + '.old'
134
from osutils import rename
135
rename(trace_fname, old_fname)
199
osutils.rename(trace_fname, old_fname)
140
def open_tracefile(tracefilename=None):
141
# Messages are always written to here, so that we have some
142
# information if something goes wrong. In a future version this
143
# file will be removed on successful completion.
144
global _file_handler, _bzr_log_file
147
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')
148
210
if sys.platform == 'win32':
149
211
from bzrlib import win32utils
150
212
home = win32utils.get_home_location()
152
214
home = os.path.expanduser('~')
153
tracefilename = os.path.join(home, '.bzr.log')
155
trace_fname = os.path.expanduser(tracefilename)
156
_rollover_trace_maybe(trace_fname)
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()
229
_rollover_trace_maybe(_bzr_log_filename)
159
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
160
tf = open(trace_fname, 'at', LINE_BUFFERED)
162
# tf.tell() on windows always return 0 until some writing done
165
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
166
tf.write("you can delete or truncate this file, or include sections in\n")
167
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
168
_file_handler = logging.StreamHandler(tf)
169
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
170
datefmt = r'%a %H:%M:%S'
171
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
172
_file_handler.setLevel(logging.DEBUG)
173
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")
174
239
except IOError, e:
175
240
warning("failed to open trace file: %s" % (e))
178
@deprecated_function(zero_nine)
179
def log_exception(msg=None):
180
"""Log the last exception to stderr and the trace file.
182
The exception string representation is used as the error
183
summary, unless msg is given.
185
Please see log_exception_quietly() for the replacement API.
189
log_exception_quietly()
241
# TODO: What should happen if we fail to open the trace file? Maybe the
242
# objects should be pointed at /dev/null or the equivalent? Currently
243
# returns None which will cause failures later.
247
def enable_default_logging():
248
"""Configure default logging: messages to stderr and debug to .bzr.log
250
This should only be called once per process.
252
Non-command-line programs embedding bzrlib do not need to call this. They
253
can instead either pass a file to _push_log_file, or act directly on
254
logging.getLogger("bzr").
256
Output can be redirected away by calling _push_log_file.
258
# Do this before we open the log file, so we prevent
259
# get_terminal_encoding() from mutter()ing multiple times
260
term_encoding = osutils.get_terminal_encoding()
261
start_time = osutils.format_local_date(_bzr_log_start_time,
263
# create encoded wrapper around stderr
264
bzr_log_file = _open_bzr_log()
265
if bzr_log_file is not None:
266
bzr_log_file.write(start_time.encode('utf-8') + '\n')
267
push_log_file(bzr_log_file,
268
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
269
r'%Y-%m-%d %H:%M:%S')
270
# after hooking output into bzr_log, we also need to attach a stderr
271
# handler, writing only at level info and with encoding
272
writer_factory = codecs.getwriter(term_encoding)
273
encoded_stderr = writer_factory(sys.stderr, errors='replace')
274
stderr_handler = logging.StreamHandler(encoded_stderr)
275
stderr_handler.setLevel(logging.INFO)
276
logging.getLogger('bzr').addHandler(stderr_handler)
279
def push_log_file(to_file, log_format=None, date_format=None):
280
"""Intercept log and trace messages and send them to a file.
282
:param to_file: A file-like object to which messages will be sent.
284
:returns: A memento that should be passed to _pop_log_file to restore the
285
previously active logging.
289
new_handler = logging.StreamHandler(to_file)
290
new_handler.setLevel(logging.DEBUG)
291
if log_format is None:
292
log_format = '%(levelname)8s %(message)s'
293
new_handler.setFormatter(logging.Formatter(log_format, date_format))
294
# save and remove any existing log handlers
295
bzr_logger = logging.getLogger('bzr')
296
old_handlers = bzr_logger.handlers[:]
297
del bzr_logger.handlers[:]
298
# set that as the default logger
299
bzr_logger.addHandler(new_handler)
300
bzr_logger.setLevel(logging.DEBUG)
301
# TODO: check if any changes are needed to the root logger
303
# TODO: also probably need to save and restore the level on bzr_logger.
304
# but maybe we can avoid setting the logger level altogether, and just set
305
# the level on the handler?
307
# save the old trace file
308
old_trace_file = _trace_file
309
# send traces to the new one
310
_trace_file = to_file
311
result = new_handler, _trace_file
312
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
315
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
316
"""Undo changes to logging/tracing done by _push_log_file.
318
This flushes, but does not close the trace file.
320
Takes the memento returned from _push_log_file."""
322
_trace_file = old_trace_file
323
bzr_logger = logging.getLogger('bzr')
324
bzr_logger.removeHandler(new_handler)
325
# must be closed, otherwise logging will try to close it atexit, and the
326
# file will likely already be closed underneath.
328
bzr_logger.handlers = old_handlers
329
new_trace_file.flush()
192
332
def log_exception_quietly():
193
333
"""Log the last exception to the trace file only.
195
Used for exceptions that occur internally and that may be
196
interesting to developers but not to users. For example,
335
Used for exceptions that occur internally and that may be
336
interesting to developers but not to users. For example,
197
337
errors loading plugins.
200
339
mutter(traceback.format_exc())
203
def enable_default_logging():
204
"""Configure default logging to stderr and .bzr.log"""
205
# FIXME: if this is run twice, things get confused
206
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
207
_stderr_handler = logging.StreamHandler()
208
logging.getLogger('').addHandler(_stderr_handler)
209
_stderr_handler.setLevel(logging.INFO)
210
if not _file_handler:
212
_trace_file = _bzr_log_file
214
_file_handler.setLevel(logging.DEBUG)
215
_bzr_logger.setLevel(logging.DEBUG)
342
def set_verbosity_level(level):
343
"""Set the verbosity level.
345
:param level: -ve for quiet, 0 for normal, +ve for verbose
347
global _verbosity_level
348
_verbosity_level = level
349
_update_logging_level(level < 0)
352
def get_verbosity_level():
353
"""Get the verbosity level.
355
See set_verbosity_level() for values.
357
return _verbosity_level
218
360
def be_quiet(quiet=True):
219
global _stderr_handler, _stderr_quiet
221
_stderr_quiet = quiet
223
_stderr_handler.setLevel(logging.WARNING)
225
_stderr_handler.setLevel(logging.INFO)
361
# Perhaps this could be deprecated now ...
363
set_verbosity_level(-1)
365
set_verbosity_level(0)
368
def _update_logging_level(quiet=True):
369
"""Hide INFO messages if quiet."""
371
_bzr_logger.setLevel(logging.WARNING)
373
_bzr_logger.setLevel(logging.INFO)
233
def disable_default_logging():
234
"""Turn off default log handlers.
236
This is intended to be used by the test framework, which doesn't
237
want leakage from the code-under-test into the main logs.
240
l = logging.getLogger('')
241
l.removeHandler(_stderr_handler)
243
l.removeHandler(_file_handler)
247
def enable_test_log(to_file):
248
"""Redirect logging to a temporary file for a test
250
returns an opaque reference that should be passed to disable_test_log
251
after the test completes.
253
disable_default_logging()
256
hdlr = logging.StreamHandler(to_file)
257
hdlr.setLevel(logging.DEBUG)
258
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
259
_bzr_logger.addHandler(hdlr)
260
_bzr_logger.setLevel(logging.DEBUG)
261
result = hdlr, _trace_file, _trace_depth
262
_trace_file = to_file
267
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
268
_bzr_logger.removeHandler(test_log_hdlr)
269
test_log_hdlr.close()
272
_trace_file = old_trace_file
273
_trace_depth = old_trace_depth
275
enable_default_logging()
377
"""Is the verbosity level negative?"""
378
return _verbosity_level < 0
382
"""Is the verbosity level positive?"""
383
return _verbosity_level > 0
386
def debug_memory(message='', short=True):
387
"""Write out a memory dump."""
388
if sys.platform == 'win32':
389
from bzrlib import win32utils
390
win32utils.debug_memory_win32api(message=message, short=short)
392
_debug_memory_proc(message=message, short=short)
395
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
397
def _debug_memory_proc(message='', short=True):
399
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
403
status = status_file.read()
408
for line in status.splitlines():
412
for field in _short_fields:
413
if line.startswith(field):
278
418
def report_exception(exc_info, err_file):
419
"""Report an exception to err_file (typically stderr) and to .bzr.log.
421
This will show either a full traceback or a short message as appropriate.
423
:return: The appropriate exit code for this error.
279
425
exc_type, exc_object, exc_tb = exc_info
280
426
# Log the full traceback to ~/.bzr.log
281
427
log_exception_quietly()
282
428
if (isinstance(exc_object, IOError)
283
429
and getattr(exc_object, 'errno', None) == errno.EPIPE):
284
print >>err_file, "bzr: broken pipe"
430
err_file.write("bzr: broken pipe\n")
431
return errors.EXIT_ERROR
285
432
elif isinstance(exc_object, KeyboardInterrupt):
286
print >>err_file, "bzr: interrupted"
433
err_file.write("bzr: interrupted\n")
434
return errors.EXIT_ERROR
435
elif isinstance(exc_object, ImportError) \
436
and str(exc_object).startswith("No module named "):
437
report_user_error(exc_info, err_file,
438
'You may need to install this Python library separately.')
439
return errors.EXIT_ERROR
287
440
elif not getattr(exc_object, 'internal_error', True):
288
441
report_user_error(exc_info, err_file)
442
return errors.EXIT_ERROR
289
443
elif isinstance(exc_object, (OSError, IOError)):
290
444
# Might be nice to catch all of these and show them as something more
291
445
# specific, but there are too many cases at the moment.
292
446
report_user_error(exc_info, err_file)
447
return errors.EXIT_ERROR
294
449
report_bug(exc_info, err_file)
450
return errors.EXIT_INTERNAL_ERROR
453
def print_exception(exc_info, err_file):
454
exc_type, exc_object, exc_tb = exc_info
455
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
456
exc_type.__module__, exc_type.__name__, exc_object))
458
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
297
461
# TODO: Should these be specially encoding the output?
298
def report_user_error(exc_info, err_file):
462
def report_user_error(exc_info, err_file, advice=None):
299
463
"""Report to err_file an error that's not an internal error.
301
465
These don't get a traceback unless -Derror was given.
467
:param exc_info: 3-tuple from sys.exc_info()
468
:param advice: Extra advice to the user to be printed following the
303
471
if 'error' in debug.debug_flags:
304
report_bug(exc_info, err_file)
472
print_exception(exc_info, err_file)
306
print >>err_file, "bzr: ERROR:", str(exc_info[1])
474
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
476
err_file.write("%s\n" % (advice,))
309
479
def report_bug(exc_info, err_file):
310
480
"""Report an exception that probably indicates a bug in bzr"""
312
exc_type, exc_object, exc_tb = exc_info
313
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
314
exc_type.__module__, exc_type.__name__, exc_object)
316
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
318
print >>err_file, 'bzr %s on python %s (%s)' % \
481
print_exception(exc_info, err_file)
483
err_file.write('bzr %s on python %s (%s)\n' % \
319
484
(bzrlib.__version__,
320
'.'.join(map(str, sys.version_info)),
322
print >>err_file, 'arguments: %r' % sys.argv
324
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
485
bzrlib._format_version_tuple(sys.version_info),
487
err_file.write('arguments: %r\n' % sys.argv)
489
'encoding: %r, fsenc: %r, lang: %r\n' % (
490
osutils.get_user_encoding(), sys.getfilesystemencoding(),
491
os.environ.get('LANG')))
492
err_file.write("plugins:\n")
493
for name, a_plugin in sorted(plugin.plugins().items()):
494
err_file.write(" %-20s %s [%s]\n" %
495
(name, a_plugin.path(), a_plugin.__version__))
498
*** Bazaar has encountered an internal error.
499
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
500
including this traceback, and a description of what you
501
were doing when the error occurred.