20
34
Output to stderr depends on the mode chosen by the user. By default, messages
21
35
of info and above are sent out, which results in progress messages such as the
22
list of files processed by add and commit. In quiet mode, only warnings and
23
above are shown. In debug mode, stderr gets debug messages too.
36
list of files processed by add and commit. In debug mode, stderr gets debug messages too.
25
38
Errors that terminate an operation are generally passed back as exceptions;
26
39
others may be just emitted as messages.
28
41
Exceptions are reported in a brief form to stderr so as not to look scary.
29
42
BzrErrors are required to be able to format themselves into a properly
30
explanatory message. This is not true for builtin excexceptions such as
43
explanatory message. This is not true for builtin exceptions such as
31
44
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
48
# FIXME: Unfortunately it turns out that python's logging module
39
49
# is quite expensive, even when the message is not printed by any handlers.
40
50
# We should perhaps change back to just simply doing it here.
52
# On the other hand, as of 1.2 we generally only call the mutter() statement
53
# if (according to debug_flags) we actually intend to write it. So the
54
# increased cost of logging.py is not so bad, and we could standardize on
63
from bzrlib.lazy_import import lazy_import
64
lazy_import(globals(), """
65
from cStringIO import StringIO
48
from bzrlib.errors import BzrError, BzrNewError
52
_stderr_handler = None
73
from bzrlib.symbol_versioning import (
78
lazy_import(globals(), """
90
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
# is quiet; >0 is verbose.
94
# File-like object where mutter/debug output is currently sent. Can be
95
# changed by _push_log_file etc. This is directly manipulated by some
96
# external code; maybe there should be functions to do that more precisely
97
# 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)
77
# configure convenient aliases for output routines
100
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
101
# redirected elsewhere. Used to show the location in --version.
102
_bzr_log_filename = None
104
# The time the first message was written to the trace file, so that we can
105
# show relative times since startup.
106
_bzr_log_start_time = bzrlib._start_time
109
# held in a global for quick reference
79
110
_bzr_logger = logging.getLogger('bzr')
81
113
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
120
# FIXME note always emits utf-8, regardless of the terminal encoding
122
# FIXME: clearing the ui and then going through the abstract logging
123
# framework is whack; we should probably have a logging Handler that
124
# deals with terminal output if needed.
83
126
bzrlib.ui.ui_factory.clear_term()
84
127
_bzr_logger.info(*args, **kwargs)
86
130
def warning(*args, **kwargs):
88
132
bzrlib.ui.ui_factory.clear_term()
89
133
_bzr_logger.warning(*args, **kwargs)
92
log_error = _bzr_logger.error
93
error = _bzr_logger.error
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def info(*args, **kwargs):
138
"""Deprecated: use trace.note instead."""
139
note(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def log_error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
148
@deprecated_function(deprecated_in((2, 1, 0)))
149
def error(*args, **kwargs):
150
"""Deprecated: use bzrlib.trace.show_error instead"""
151
_bzr_logger.error(*args, **kwargs)
154
def show_error(*args, **kwargs):
155
"""Show an error message to the user.
157
Don't use this for exceptions, use report_exception instead.
159
_bzr_logger.error(*args, **kwargs)
96
162
def mutter(fmt, *args):
97
163
if _trace_file is None:
99
if hasattr(_trace_file, 'closed') and _trace_file.closed:
165
# XXX: Don't check this every time; instead anyone who closes the file
166
# ought to deregister it. We can tolerate None.
167
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
170
if isinstance(fmt, unicode):
171
fmt = fmt.encode('utf8')
101
173
if len(args) > 0:
174
# It seems that if we do ascii % (unicode, ascii) we can
175
# get a unicode cannot encode ascii error, so make sure that "fmt"
176
# is a unicode string
179
if isinstance(arg, unicode):
180
arg = arg.encode('utf8')
181
real_args.append(arg)
182
out = fmt % tuple(real_args)
186
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
187
out = timestamp + out + '\n'
106
188
_trace_file.write(out)
189
# there's no explicit flushing; the file is typically line buffered.
192
def mutter_callsite(stacklevel, fmt, *args):
193
"""Perform a mutter of fmt and args, logging the call trace.
195
:param stacklevel: The number of frames to show. None will show all
197
:param fmt: The format string to pass to mutter.
198
:param args: A list of substitution variables.
201
if stacklevel is None:
204
limit = stacklevel + 1
205
traceback.print_stack(limit=limit, file=outf)
206
formatted_lines = outf.getvalue().splitlines()
207
formatted_stack = '\n'.join(formatted_lines[:-2])
208
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
110
211
def _rollover_trace_maybe(trace_fname):
114
215
if size <= 4 << 20:
116
217
old_fname = trace_fname + '.old'
117
from osutils import rename
118
rename(trace_fname, old_fname)
218
osutils.rename(trace_fname, old_fname)
123
def open_tracefile(tracefilename='~/.bzr.log'):
124
# Messages are always written to here, so that we have some
125
# information if something goes wrong. In a future version this
126
# file will be removed on successful completion.
127
global _file_handler, _bzr_log_file
130
trace_fname = os.path.join(os.path.expanduser(tracefilename))
131
_rollover_trace_maybe(trace_fname)
223
def _get_bzr_log_filename():
224
bzr_log = os.environ.get('BZR_LOG')
227
home = os.environ.get('BZR_HOME')
229
if sys.platform == 'win32':
230
from bzrlib import win32utils
231
home = win32utils.get_home_location()
233
home = os.path.expanduser('~')
234
return os.path.join(home, '.bzr.log')
238
"""Open the .bzr.log trace file.
240
If the log is more than a particular length, the old file is renamed to
241
.bzr.log.old and a new file is started. Otherwise, we append to the
244
This sets the global _bzr_log_filename.
246
global _bzr_log_filename
248
def _open_or_create_log_file(filename):
249
"""Open existing log file, or create with ownership and permissions
251
It inherits the ownership and permissions (masked by umask) from
252
the containing directory to cope better with being run under sudo
253
with $HOME still set to the user's homedir.
255
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
258
fd = os.open(filename, flags)
261
if e.errno != errno.ENOENT:
264
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
266
if e.errno != errno.EEXIST:
269
osutils.copy_ownership_from_path(filename)
271
return os.fdopen(fd, 'at', 0) # unbuffered
274
_bzr_log_filename = _get_bzr_log_filename()
275
_rollover_trace_maybe(_bzr_log_filename)
134
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
137
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
138
tf.write("you can delete or truncate this file, or include sections in\n")
139
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
140
_file_handler = logging.StreamHandler(tf)
141
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
142
datefmt = r'%a %H:%M:%S'
143
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
144
_file_handler.setLevel(logging.DEBUG)
145
logging.getLogger('').addHandler(_file_handler)
147
warning("failed to open trace file: %s" % (e))
150
def log_startup(argv):
151
debug('\n\nbzr %s invoked on python %s (%s)',
153
'.'.join(map(str, sys.version_info)),
155
debug(' arguments: %r', argv)
156
debug(' working dir: %r', os.getcwdu())
159
def log_exception(msg=None):
160
"""Log the last exception to stderr and the trace file.
162
The exception string representation is used as the error
163
summary, unless msg is given.
168
exc_str = format_exception_short(sys.exc_info())
170
log_exception_quietly()
277
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
278
bzr_log_file.write('\n')
279
if bzr_log_file.tell() <= 2:
280
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
286
except EnvironmentError, e:
287
# If we are failing to open the log, then most likely logging has not
288
# been set up yet. So we just write to stderr rather than using
289
# 'warning()'. If we using warning(), users get the unhelpful 'no
290
# handlers registered for "bzr"' when something goes wrong on the
291
# server. (bug #503886)
292
sys.stderr.write("failed to open trace file: %s\n" % (e,))
293
# TODO: What should happen if we fail to open the trace file? Maybe the
294
# objects should be pointed at /dev/null or the equivalent? Currently
295
# returns None which will cause failures later.
299
def enable_default_logging():
300
"""Configure default logging: messages to stderr and debug to .bzr.log
302
This should only be called once per process.
304
Non-command-line programs embedding bzrlib do not need to call this. They
305
can instead either pass a file to _push_log_file, or act directly on
306
logging.getLogger("bzr").
308
Output can be redirected away by calling _push_log_file.
310
# Do this before we open the log file, so we prevent
311
# get_terminal_encoding() from mutter()ing multiple times
312
term_encoding = osutils.get_terminal_encoding()
313
start_time = osutils.format_local_date(_bzr_log_start_time,
315
# create encoded wrapper around stderr
316
bzr_log_file = _open_bzr_log()
317
if bzr_log_file is not None:
318
bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
push_log_file(bzr_log_file,
320
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
r'%Y-%m-%d %H:%M:%S')
322
# after hooking output into bzr_log, we also need to attach a stderr
323
# handler, writing only at level info and with encoding
324
writer_factory = codecs.getwriter(term_encoding)
325
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
stderr_handler = logging.StreamHandler(encoded_stderr)
327
stderr_handler.setLevel(logging.INFO)
328
logging.getLogger('bzr').addHandler(stderr_handler)
331
def push_log_file(to_file, log_format=None, date_format=None):
332
"""Intercept log and trace messages and send them to a file.
334
:param to_file: A file-like object to which messages will be sent.
336
:returns: A memento that should be passed to _pop_log_file to restore the
337
previously active logging.
341
new_handler = logging.StreamHandler(to_file)
342
new_handler.setLevel(logging.DEBUG)
343
if log_format is None:
344
log_format = '%(levelname)8s %(message)s'
345
new_handler.setFormatter(logging.Formatter(log_format, date_format))
346
# save and remove any existing log handlers
347
bzr_logger = logging.getLogger('bzr')
348
old_handlers = bzr_logger.handlers[:]
349
del bzr_logger.handlers[:]
350
# set that as the default logger
351
bzr_logger.addHandler(new_handler)
352
bzr_logger.setLevel(logging.DEBUG)
353
# TODO: check if any changes are needed to the root logger
355
# TODO: also probably need to save and restore the level on bzr_logger.
356
# but maybe we can avoid setting the logger level altogether, and just set
357
# the level on the handler?
359
# save the old trace file
360
old_trace_file = _trace_file
361
# send traces to the new one
362
_trace_file = to_file
363
result = new_handler, _trace_file
364
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
367
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
368
"""Undo changes to logging/tracing done by _push_log_file.
370
This flushes, but does not close the trace file.
372
Takes the memento returned from _push_log_file."""
374
_trace_file = old_trace_file
375
bzr_logger = logging.getLogger('bzr')
376
bzr_logger.removeHandler(new_handler)
377
# must be closed, otherwise logging will try to close it atexit, and the
378
# file will likely already be closed underneath.
380
bzr_logger.handlers = old_handlers
381
new_trace_file.flush()
173
384
def log_exception_quietly():
174
385
"""Log the last exception to the trace file only.
176
Used for exceptions that occur internally and that may be
177
interesting to developers but not to users. For example,
387
Used for exceptions that occur internally and that may be
388
interesting to developers but not to users. For example,
178
389
errors loading plugins.
181
debug(traceback.format_exc())
184
def enable_default_logging():
185
"""Configure default logging to stderr and .bzr.log"""
186
# FIXME: if this is run twice, things get confused
187
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
188
_stderr_handler = logging.StreamHandler()
189
_stderr_handler.setFormatter(QuietFormatter())
190
logging.getLogger('').addHandler(_stderr_handler)
191
_stderr_handler.setLevel(logging.INFO)
192
if not _file_handler:
194
_trace_file = _bzr_log_file
196
_file_handler.setLevel(logging.DEBUG)
197
_bzr_logger.setLevel(logging.DEBUG)
391
mutter(traceback.format_exc())
394
def set_verbosity_level(level):
395
"""Set the verbosity level.
397
:param level: -ve for quiet, 0 for normal, +ve for verbose
399
global _verbosity_level
400
_verbosity_level = level
401
_update_logging_level(level < 0)
402
ui.ui_factory.be_quiet(level < 0)
405
def get_verbosity_level():
406
"""Get the verbosity level.
408
See set_verbosity_level() for values.
410
return _verbosity_level
201
413
def be_quiet(quiet=True):
202
global _stderr_handler, _stderr_quiet
204
_stderr_quiet = quiet
206
_stderr_handler.setLevel(logging.WARNING)
208
_stderr_handler.setLevel(logging.INFO)
415
set_verbosity_level(-1)
417
set_verbosity_level(0)
420
def _update_logging_level(quiet=True):
421
"""Hide INFO messages if quiet."""
423
_bzr_logger.setLevel(logging.WARNING)
425
_bzr_logger.setLevel(logging.INFO)
216
def disable_default_logging():
217
"""Turn off default log handlers.
219
This is intended to be used by the test framework, which doesn't
220
want leakage from the code-under-test into the main logs.
223
l = logging.getLogger('')
224
l.removeHandler(_stderr_handler)
226
l.removeHandler(_file_handler)
230
def enable_test_log(to_file):
231
"""Redirect logging to a temporary file for a test
233
returns an opaque reference that should be passed to disable_test_log
234
after the test complete.
236
disable_default_logging()
429
"""Is the verbosity level negative?"""
430
return _verbosity_level < 0
434
"""Is the verbosity level positive?"""
435
return _verbosity_level > 0
438
def debug_memory(message='', short=True):
439
"""Write out a memory dump."""
440
if sys.platform == 'win32':
441
from bzrlib import win32utils
442
win32utils.debug_memory_win32api(message=message, short=short)
444
_debug_memory_proc(message=message, short=short)
447
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
449
def _debug_memory_proc(message='', short=True):
451
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
455
status = status_file.read()
460
for line in status.splitlines():
464
for field in _short_fields:
465
if line.startswith(field):
470
def report_exception(exc_info, err_file):
471
"""Report an exception to err_file (typically stderr) and to .bzr.log.
473
This will show either a full traceback or a short message as appropriate.
475
:return: The appropriate exit code for this error.
477
# Log the full traceback to ~/.bzr.log
478
log_exception_quietly()
479
if 'error' in debug.debug_flags:
480
print_exception(exc_info, err_file)
481
return errors.EXIT_ERROR
482
exc_type, exc_object, exc_tb = exc_info
483
if (isinstance(exc_object, IOError)
484
and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
err_file.write("bzr: broken pipe\n")
486
return errors.EXIT_ERROR
487
elif isinstance(exc_object, KeyboardInterrupt):
488
err_file.write("bzr: interrupted\n")
489
return errors.EXIT_ERROR
490
elif isinstance(exc_object, MemoryError):
491
err_file.write("bzr: out of memory\n")
492
return errors.EXIT_ERROR
493
elif isinstance(exc_object, ImportError) \
494
and str(exc_object).startswith("No module named "):
495
report_user_error(exc_info, err_file,
496
'You may need to install this Python library separately.')
497
return errors.EXIT_ERROR
498
elif not getattr(exc_object, 'internal_error', True):
499
report_user_error(exc_info, err_file)
500
return errors.EXIT_ERROR
501
elif isinstance(exc_object, (OSError, IOError)) or (
502
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
503
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
504
# Might be nice to catch all of these and show them as something more
505
# specific, but there are too many cases at the moment.
506
report_user_error(exc_info, err_file)
507
return errors.EXIT_ERROR
509
report_bug(exc_info, err_file)
510
return errors.EXIT_INTERNAL_ERROR
513
def print_exception(exc_info, err_file):
514
exc_type, exc_object, exc_tb = exc_info
515
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
516
exc_type.__module__, exc_type.__name__, exc_object))
518
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
521
# TODO: Should these be specially encoding the output?
522
def report_user_error(exc_info, err_file, advice=None):
523
"""Report to err_file an error that's not an internal error.
525
These don't get a traceback unless -Derror was given.
527
:param exc_info: 3-tuple from sys.exc_info()
528
:param advice: Extra advice to the user to be printed following the
531
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
533
err_file.write("%s\n" % (advice,))
536
def report_bug(exc_info, err_file):
537
"""Report an exception that probably indicates a bug in bzr"""
538
from bzrlib.crash import report_bug
539
report_bug(exc_info, err_file)
542
def _flush_stdout_stderr():
543
# installed into an atexit hook by bzrlib.initialize()
549
if e.errno in [errno.EINVAL, errno.EPIPE]:
556
# run from atexit hook
237
557
global _trace_file
238
hdlr = logging.StreamHandler(to_file)
239
hdlr.setLevel(logging.DEBUG)
240
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
241
_bzr_logger.addHandler(hdlr)
242
_bzr_logger.setLevel(logging.DEBUG)
243
result = hdlr, _trace_file
244
_trace_file = to_file
248
def disable_test_log((test_log_hdlr, old_trace_file)):
249
_bzr_logger.removeHandler(test_log_hdlr)
250
test_log_hdlr.close()
251
_trace_file = old_trace_file
252
enable_default_logging()
255
def format_exception_short(exc_info):
256
"""Make a short string form of an exception.
258
This is used for display to stderr. It specially handles exception
259
classes without useful string methods.
261
The result has no trailing newline.
263
exc_info - typically an exception from sys.exc_info()
265
exc_type, exc_object, exc_tb = exc_info
268
return '(no exception)'
269
if isinstance(exc_object, (BzrError, BzrNewError)):
270
return str(exc_object)
273
tb = traceback.extract_tb(exc_tb)
274
msg = '%s: %s' % (exc_type, exc_object)
278
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
280
except Exception, formatting_exc:
281
# XXX: is this really better than just letting it run up?
282
return '(error formatting exception of type %s: %s)' \
283
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
