28
42
Exceptions are reported in a brief form to stderr so as not to look scary.
29
43
BzrErrors are required to be able to format themselves into a properly
30
explanatory message. This is not true for builtin excexceptions such as
44
explanatory message. This is not true for builtin exceptions such as
31
45
KeyError, which typically just str to "0". They're printed in a different
35
# TODO: in debug mode, stderr should get full tracebacks and also
36
# debug messages. (Is this really needed?)
38
49
# FIXME: Unfortunately it turns out that python's logging module
39
50
# is quite expensive, even when the message is not printed by any handlers.
40
51
# We should perhaps change back to just simply doing it here.
53
# On the other hand, as of 1.2 we generally only call the mutter() statement
54
# if (according to debug_flags) we actually intend to write it. So the
55
# increased cost of logging.py is not so bad, and we could standardize on
65
from bzrlib.lazy_import import lazy_import
66
lazy_import(globals(), """
67
from cStringIO import StringIO
48
from bzrlib.errors import BzrError, BzrNewError
52
_stderr_handler = None
75
lazy_import(globals(), """
86
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
87
# is quiet; >0 is verbose.
90
# File-like object where mutter/debug output is currently sent. Can be
91
# changed by _push_log_file etc. This is directly manipulated by some
92
# external code; maybe there should be functions to do that more precisely
93
# than push/pop_log_file.
58
class QuietFormatter(logging.Formatter):
59
"""Formatter that supresses the details of errors.
61
This is used by default on stderr so as not to scare the user.
63
# At first I tried overriding formatException to suppress the
64
# exception details, but that has global effect: no loggers
65
# can get the exception details is we suppress them here.
67
def format(self, record):
68
if record.levelno >= logging.WARNING:
69
s = 'bzr: ' + record.levelname + ': '
72
s += record.getMessage()
74
s += '\n' + format_exception_short(record.exc_info)
96
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
97
# redirected elsewhere. Used to show the location in --version.
98
_bzr_log_filename = None
100
# The time the first message was written to the trace file, so that we can
101
# show relative times since startup.
102
_bzr_log_start_time = bzrlib._start_time
105
# held in a global for quick reference
106
_bzr_logger = logging.getLogger('bzr')
109
def note(*args, **kwargs):
110
# FIXME note always emits utf-8, regardless of the terminal encoding
112
# FIXME: clearing the ui and then going through the abstract logging
113
# framework is whack; we should probably have a logging Handler that
114
# deals with terminal output if needed.
116
bzrlib.ui.ui_factory.clear_term()
117
_bzr_logger.info(*args, **kwargs)
120
def warning(*args, **kwargs):
122
bzrlib.ui.ui_factory.clear_term()
123
_bzr_logger.warning(*args, **kwargs)
77
126
# configure convenient aliases for output routines
79
_bzr_logger = logging.getLogger('bzr')
81
info = note = _bzr_logger.info
82
warning = _bzr_logger.warning
128
# TODO: deprecate them, have one name for each.
83
130
log_error = _bzr_logger.error
84
131
error = _bzr_logger.error
134
_last_mutter_flush_time = None
87
136
def mutter(fmt, *args):
137
global _last_mutter_flush_time
88
138
if _trace_file is None:
90
if hasattr(_trace_file, 'closed') and _trace_file.closed:
140
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
143
if isinstance(fmt, unicode):
144
fmt = fmt.encode('utf8')
147
# It seems that if we do ascii % (unicode, ascii) we can
148
# get a unicode cannot encode ascii error, so make sure that "fmt"
149
# is a unicode string
152
if isinstance(arg, unicode):
153
arg = arg.encode('utf8')
154
real_args.append(arg)
155
out = fmt % tuple(real_args)
159
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
160
out = timestamp + out + '\n'
97
161
_trace_file.write(out)
162
# We flush if we haven't flushed for a few seconds. We don't want to flush
163
# on every mutter, but when a command takes a while, it can be nice to see
164
# updates in the debug log.
165
if (_last_mutter_flush_time is None
166
or (now - _last_mutter_flush_time) > 2.0):
167
flush = getattr(_trace_file, 'flush', None)
168
if flush is not None:
170
_last_mutter_flush_time = now
173
def mutter_callsite(stacklevel, fmt, *args):
174
"""Perform a mutter of fmt and args, logging the call trace.
176
:param stacklevel: The number of frames to show. None will show all
178
:param fmt: The format string to pass to mutter.
179
:param args: A list of substitution variables.
182
if stacklevel is None:
185
limit = stacklevel + 1
186
traceback.print_stack(limit=limit, file=outf)
187
formatted_lines = outf.getvalue().splitlines()
188
formatted_stack = '\n'.join(formatted_lines[:-2])
189
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
101
192
def _rollover_trace_maybe(trace_fname):
105
196
if size <= 4 << 20:
107
198
old_fname = trace_fname + '.old'
108
from osutils import rename
109
rename(trace_fname, old_fname)
199
osutils.rename(trace_fname, old_fname)
114
def open_tracefile(tracefilename='~/.bzr.log'):
115
# Messages are always written to here, so that we have some
116
# information if something goes wrong. In a future version this
117
# file will be removed on successful completion.
118
global _file_handler, _bzr_log_file
121
trace_fname = os.path.join(os.path.expanduser(tracefilename))
122
_rollover_trace_maybe(trace_fname)
204
def _get_bzr_log_filename():
205
bzr_log = os.environ.get('BZR_LOG')
208
home = os.environ.get('BZR_HOME')
210
if sys.platform == 'win32':
211
from bzrlib import win32utils
212
home = win32utils.get_home_location()
214
home = os.path.expanduser('~')
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)
125
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
128
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
129
tf.write("you can delete or truncate this file, or include sections in\n")
130
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
131
_file_handler = logging.StreamHandler(tf)
132
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
133
datefmt = r'%a %H:%M:%S'
134
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
135
_file_handler.setLevel(logging.DEBUG)
136
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")
137
239
except IOError, e:
138
240
warning("failed to open trace file: %s" % (e))
141
def log_startup(argv):
142
debug('\n\nbzr %s invoked on python %s (%s)',
144
'.'.join(map(str, sys.version_info)),
146
debug(' arguments: %r', argv)
147
debug(' working dir: %r', os.getcwdu())
150
def log_exception(msg=None):
151
"""Log the last exception to stderr and the trace file.
153
The exception string representation is used as the error
154
summary, unless msg is given.
159
exc_str = format_exception_short(sys.exc_info())
161
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()
164
332
def log_exception_quietly():
165
333
"""Log the last exception to the trace file only.
167
Used for exceptions that occur internally and that may be
168
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,
169
337
errors loading plugins.
172
debug(traceback.format_exc())
175
def enable_default_logging():
176
"""Configure default logging to stderr and .bzr.log"""
177
# FIXME: if this is run twice, things get confused
178
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
179
_stderr_handler = logging.StreamHandler()
180
_stderr_handler.setFormatter(QuietFormatter())
181
logging.getLogger('').addHandler(_stderr_handler)
182
_stderr_handler.setLevel(logging.INFO)
183
if not _file_handler:
185
_trace_file = _bzr_log_file
187
_file_handler.setLevel(logging.DEBUG)
188
_bzr_logger.setLevel(logging.DEBUG)
339
mutter(traceback.format_exc())
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
192
360
def be_quiet(quiet=True):
193
global _stderr_handler, _stderr_quiet
195
_stderr_quiet = quiet
197
_stderr_handler.setLevel(logging.WARNING)
199
_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)
207
def disable_default_logging():
208
"""Turn off default log handlers.
210
This is intended to be used by the test framework, which doesn't
211
want leakage from the code-under-test into the main logs.
214
l = logging.getLogger('')
215
l.removeHandler(_stderr_handler)
217
l.removeHandler(_file_handler)
221
def enable_test_log(to_file):
222
"""Redirect logging to a temporary file for a test
224
returns an opaque reference that should be passed to disable_test_log
225
after the test complete.
227
disable_default_logging()
229
hdlr = logging.StreamHandler(to_file)
230
hdlr.setLevel(logging.DEBUG)
231
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
232
_bzr_logger.addHandler(hdlr)
233
_bzr_logger.setLevel(logging.DEBUG)
234
result = hdlr, _trace_file
235
_trace_file = to_file
239
def disable_test_log((test_log_hdlr, old_trace_file)):
240
_bzr_logger.removeHandler(test_log_hdlr)
241
_trace_file = old_trace_file
242
enable_default_logging()
245
def format_exception_short(exc_info):
246
"""Make a short string form of an exception.
248
This is used for display to stderr. It specially handles exception
249
classes without useful string methods.
251
The result has no trailing newline.
253
exc_info - typically an exception from sys.exc_info()
255
exc_type, exc_object, exc_tb = exc_info
258
return '(no exception)'
259
if isinstance(exc_object, (BzrError, BzrNewError)):
260
return str(exc_object)
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():
263
tb = traceback.extract_tb(exc_tb)
264
msg = '%s: %s' % (exc_type, exc_object)
268
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
270
except Exception, formatting_exc:
271
# XXX: is this really better than just letting it run up?
272
return '(error formatting exception of type %s: %s)' \
273
% (exc_type, formatting_exc)
412
for field in _short_fields:
413
if line.startswith(field):
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.
425
exc_type, exc_object, exc_tb = exc_info
426
# Log the full traceback to ~/.bzr.log
427
log_exception_quietly()
428
if (isinstance(exc_object, IOError)
429
and getattr(exc_object, 'errno', None) == errno.EPIPE):
430
err_file.write("bzr: broken pipe\n")
431
return errors.EXIT_ERROR
432
elif isinstance(exc_object, KeyboardInterrupt):
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
440
elif not getattr(exc_object, 'internal_error', True):
441
report_user_error(exc_info, err_file)
442
return errors.EXIT_ERROR
443
elif isinstance(exc_object, (OSError, IOError)):
444
# Might be nice to catch all of these and show them as something more
445
# specific, but there are too many cases at the moment.
446
report_user_error(exc_info, err_file)
447
return errors.EXIT_ERROR
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)
461
# TODO: Should these be specially encoding the output?
462
def report_user_error(exc_info, err_file, advice=None):
463
"""Report to err_file an error that's not an internal error.
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
471
if 'error' in debug.debug_flags:
472
print_exception(exc_info, err_file)
474
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
476
err_file.write("%s\n" % (advice,))
479
def report_bug(exc_info, err_file):
480
"""Report an exception that probably indicates a bug in bzr"""
481
from bzrlib.crash import report_bug
482
report_bug(exc_info, err_file)
added
removed
bzrlib/trace.py
