1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
1
3
# This program is free software; you can redistribute it and/or modify
2
4
# it under the terms of the GNU General Public License as published by
3
5
# the Free Software Foundation; either version 2 of the License, or
4
6
# (at your option) any later version.
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
11
# GNU General Public License for more details.
11
13
# You should have received a copy of the GNU General Public License
12
14
# along with this program; if not, write to the Free Software
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
"""Messages and logging for bazaar-ng
18
Messages are sent out through the Python logging library.
20
They can be sent to two places: to stderr, and to ~/.bzr.log.
22
~/.bzr.log gets all messages, and tracebacks of all uncaught
25
Normally stderr only gets messages of level INFO and higher, and gets
26
only a summary of exceptions, not the traceback.
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging for bazaar-ng.
19
Messages are supplied by callers as a string-formatting template, plus values
20
to be inserted into it. The actual %-formatting is deferred to the log
21
library so that it doesn't need to be done for messages that won't be emitted.
23
Messages are classified by severity levels: critical, error, warning, info,
26
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
27
such as running the test suite, they can also be redirected away from both of
28
those two places to another location.
30
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
31
This trace file is always in UTF-8, regardless of the user's default encoding,
32
so that we can always rely on writing any message.
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
of info and above are sent out, which results in progress messages such as the
36
list of files processed by add and commit. In quiet mode, only warnings and
37
above are shown. In debug mode, stderr gets debug messages too.
39
Errors that terminate an operation are generally passed back as exceptions;
40
others may be just emitted as messages.
42
Exceptions are reported in a brief form to stderr so as not to look scary.
43
BzrErrors are required to be able to format themselves into a properly
44
explanatory message. This is not true for builtin exceptions such as
45
KeyError, which typically just str to "0". They're printed in a different
30
# TODO: in debug mode, stderr should get full tracebacks and also
31
# debug messages. (Is this really needed?)
33
# TODO: When running the test suites, we should add an additional
34
# logger that sends messages into the test log file.
49
# FIXME: Unfortunately it turns out that python's logging module
50
# is quite expensive, even when the message is not printed by any handlers.
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
64
from bzrlib.lazy_import import lazy_import
65
lazy_import(globals(), """
66
from cStringIO import StringIO
44
_stderr_handler = None
47
class QuietFormatter(logging.Formatter):
48
"""Formatter that supresses the details of errors.
50
This is used by default on stderr so as not to scare the user.
52
# At first I tried overriding formatException to suppress the
53
# exception details, but that has global effect: no loggers
54
# can get the exception details is we suppress them here.
56
def format(self, record):
58
if record.levelno >= logging.WARNING:
59
s += record.levelname + ': '
61
s += record.getMessage()
64
# give just a summary of the exception, not the whole thing
65
exinfo = traceback.extract_tb(record.exc_info[2])
66
# the format of this string matches one of the REs
68
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
69
s += ' see ~/.bzr.log for debug information'
77
# configure convenient aliases for output routines
74
from bzrlib.symbol_versioning import (
79
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.
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')
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
84
log_error = _bzr_logger.error
85
error = _bzr_logger.error
86
mutter = _bzr_logger.debug
87
debug = _bzr_logger.debug
92
# we do the rollover using this code, rather than the default from python
93
# logging, because we only want to rollover at program startup, not on each
94
# message. maybe that's not a good enough reason.
113
def note(*args, **kwargs):
114
# FIXME note always emits utf-8, regardless of the terminal encoding
116
# FIXME: clearing the ui and then going through the abstract logging
117
# framework is whack; we should probably have a logging Handler that
118
# deals with terminal output if needed.
120
bzrlib.ui.ui_factory.clear_term()
121
_bzr_logger.info(*args, **kwargs)
124
def warning(*args, **kwargs):
126
bzrlib.ui.ui_factory.clear_term()
127
_bzr_logger.warning(*args, **kwargs)
130
@deprecated_function(deprecated_in((2, 1, 0)))
131
def info(*args, **kwargs):
132
"""Deprecated: use trace.note instead."""
133
note(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def log_error(*args, **kwargs):
138
"""Deprecated: use bzrlib.trace.show_error instead"""
139
_bzr_logger.error(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
149
"""Show an error message to the user.
151
Don't use this for exceptions, use report_exception instead.
153
_bzr_logger.error(*args, **kwargs)
156
def mutter(fmt, *args):
157
if _trace_file is None:
159
# XXX: Don't check this every time; instead anyone who closes the file
160
# ought to deregister it. We can tolerate None.
161
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
164
if isinstance(fmt, unicode):
165
fmt = fmt.encode('utf8')
168
# It seems that if we do ascii % (unicode, ascii) we can
169
# get a unicode cannot encode ascii error, so make sure that "fmt"
170
# is a unicode string
173
if isinstance(arg, unicode):
174
arg = arg.encode('utf8')
175
real_args.append(arg)
176
out = fmt % tuple(real_args)
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
181
out = timestamp + out + '\n'
182
_trace_file.write(out)
183
# there's no explicit flushing; the file is typically line buffered.
186
def mutter_callsite(stacklevel, fmt, *args):
187
"""Perform a mutter of fmt and args, logging the call trace.
189
:param stacklevel: The number of frames to show. None will show all
191
:param fmt: The format string to pass to mutter.
192
:param args: A list of substitution variables.
195
if stacklevel is None:
198
limit = stacklevel + 1
199
traceback.print_stack(limit=limit, file=outf)
200
formatted_lines = outf.getvalue().splitlines()
201
formatted_stack = '\n'.join(formatted_lines[:-2])
202
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
96
205
def _rollover_trace_maybe(trace_fname):
100
209
if size <= 4 << 20:
102
211
old_fname = trace_fname + '.old'
105
# must remove before rename on windows
111
# might fail if in use on windows
112
os.rename(trace_fname, old_fname)
212
osutils.rename(trace_fname, old_fname)
120
def open_tracefile(tracefilename='~/.bzr.log'):
121
# Messages are always written to here, so that we have some
122
# information if something goes wrong. In a future version this
123
# file will be removed on successful completion.
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
_rollover_trace_maybe(trace_fname)
130
# buffering=1 means line buffered
217
def _get_bzr_log_filename():
218
bzr_log = os.environ.get('BZR_LOG')
221
home = os.environ.get('BZR_HOME')
223
if sys.platform == 'win32':
224
from bzrlib import win32utils
225
home = win32utils.get_home_location()
227
home = os.path.expanduser('~')
228
return os.path.join(home, '.bzr.log')
232
"""Open the .bzr.log trace file.
234
If the log is more than a particular length, the old file is renamed to
235
.bzr.log.old and a new file is started. Otherwise, we append to the
238
This sets the global _bzr_log_filename.
240
global _bzr_log_filename
241
_bzr_log_filename = _get_bzr_log_filename()
242
_rollover_trace_maybe(_bzr_log_filename)
132
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
134
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
135
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
tf.write("you can delete or truncate this file, or include sections in\n")
137
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
139
_file_handler = logging.StreamHandler(tf)
140
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
datefmt = r'%a %H:%M:%S'
142
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
_file_handler.setLevel(logging.DEBUG)
144
logging.getLogger('').addHandler(_file_handler)
244
bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
245
# bzr_log_file.tell() on windows always return 0 until some writing done
246
bzr_log_file.write('\n')
247
if bzr_log_file.tell() <= 2:
248
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
249
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
250
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
146
252
except IOError, e:
147
253
warning("failed to open trace file: %s" % (e))
150
def log_startup(argv):
153
debug('bzr %s invoked on python %s (%s)',
155
'.'.join(map(str, sys.version_info)),
158
debug(' arguments: %r', argv)
159
debug(' working dir: %s', os.getcwdu())
162
def log_exception(msg=None):
163
"""Log the last exception into the trace file.
165
The exception string representation is used as the error
166
summary, unless msg is given.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
254
# TODO: What should happen if we fail to open the trace file? Maybe the
255
# objects should be pointed at /dev/null or the equivalent? Currently
256
# returns None which will cause failures later.
179
260
def enable_default_logging():
180
"""Configure default logging to stderr and .bzr.log"""
181
global _stderr_handler, _file_handler
183
_stderr_handler = logging.StreamHandler()
185
if not _file_handler:
186
open_tracefile() # also adds it
190
debug_flag = bool(os.environ['BZR_DEBUG'])
195
level = logging.DEBUG
196
fmt = '%(levelname)8s: %(message)s'
197
_stderr_handler.setFormatter(logging.Formatter(fmt))
200
# show only summary of exceptions
201
_stderr_handler.setFormatter(QuietFormatter())
203
_stderr_handler.setLevel(level)
204
_file_handler.setLevel(level)
206
logging.getLogger('').addHandler(_stderr_handler)
210
def disable_default_logging():
211
"""Turn off default log handlers.
213
This is intended to be used by the test framework, which doesn't
214
want leakage from the code-under-test into the main logs.
217
l = logging.getLogger('')
218
l.removeHandler(_stderr_handler)
220
l.removeHandler(_file_handler)
261
"""Configure default logging: messages to stderr and debug to .bzr.log
263
This should only be called once per process.
265
Non-command-line programs embedding bzrlib do not need to call this. They
266
can instead either pass a file to _push_log_file, or act directly on
267
logging.getLogger("bzr").
269
Output can be redirected away by calling _push_log_file.
271
# Do this before we open the log file, so we prevent
272
# get_terminal_encoding() from mutter()ing multiple times
273
term_encoding = osutils.get_terminal_encoding()
274
start_time = osutils.format_local_date(_bzr_log_start_time,
276
# create encoded wrapper around stderr
277
bzr_log_file = _open_bzr_log()
278
if bzr_log_file is not None:
279
bzr_log_file.write(start_time.encode('utf-8') + '\n')
280
push_log_file(bzr_log_file,
281
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
282
r'%Y-%m-%d %H:%M:%S')
283
# after hooking output into bzr_log, we also need to attach a stderr
284
# handler, writing only at level info and with encoding
285
writer_factory = codecs.getwriter(term_encoding)
286
encoded_stderr = writer_factory(sys.stderr, errors='replace')
287
stderr_handler = logging.StreamHandler(encoded_stderr)
288
stderr_handler.setLevel(logging.INFO)
289
logging.getLogger('bzr').addHandler(stderr_handler)
292
def push_log_file(to_file, log_format=None, date_format=None):
293
"""Intercept log and trace messages and send them to a file.
295
:param to_file: A file-like object to which messages will be sent.
297
:returns: A memento that should be passed to _pop_log_file to restore the
298
previously active logging.
302
new_handler = logging.StreamHandler(to_file)
303
new_handler.setLevel(logging.DEBUG)
304
if log_format is None:
305
log_format = '%(levelname)8s %(message)s'
306
new_handler.setFormatter(logging.Formatter(log_format, date_format))
307
# save and remove any existing log handlers
308
bzr_logger = logging.getLogger('bzr')
309
old_handlers = bzr_logger.handlers[:]
310
del bzr_logger.handlers[:]
311
# set that as the default logger
312
bzr_logger.addHandler(new_handler)
313
bzr_logger.setLevel(logging.DEBUG)
314
# TODO: check if any changes are needed to the root logger
316
# TODO: also probably need to save and restore the level on bzr_logger.
317
# but maybe we can avoid setting the logger level altogether, and just set
318
# the level on the handler?
320
# save the old trace file
321
old_trace_file = _trace_file
322
# send traces to the new one
323
_trace_file = to_file
324
result = new_handler, _trace_file
325
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
328
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
329
"""Undo changes to logging/tracing done by _push_log_file.
331
This flushes, but does not close the trace file.
333
Takes the memento returned from _push_log_file."""
335
_trace_file = old_trace_file
336
bzr_logger = logging.getLogger('bzr')
337
bzr_logger.removeHandler(new_handler)
338
# must be closed, otherwise logging will try to close it atexit, and the
339
# file will likely already be closed underneath.
341
bzr_logger.handlers = old_handlers
342
new_trace_file.flush()
345
def log_exception_quietly():
346
"""Log the last exception to the trace file only.
348
Used for exceptions that occur internally and that may be
349
interesting to developers but not to users. For example,
350
errors loading plugins.
352
mutter(traceback.format_exc())
355
def set_verbosity_level(level):
356
"""Set the verbosity level.
358
:param level: -ve for quiet, 0 for normal, +ve for verbose
360
global _verbosity_level
361
_verbosity_level = level
362
_update_logging_level(level < 0)
365
def get_verbosity_level():
366
"""Get the verbosity level.
368
See set_verbosity_level() for values.
370
return _verbosity_level
373
def be_quiet(quiet=True):
374
# Perhaps this could be deprecated now ...
376
set_verbosity_level(-1)
378
set_verbosity_level(0)
381
def _update_logging_level(quiet=True):
382
"""Hide INFO messages if quiet."""
384
_bzr_logger.setLevel(logging.WARNING)
386
_bzr_logger.setLevel(logging.INFO)
390
"""Is the verbosity level negative?"""
391
return _verbosity_level < 0
395
"""Is the verbosity level positive?"""
396
return _verbosity_level > 0
399
def debug_memory(message='', short=True):
400
"""Write out a memory dump."""
401
if sys.platform == 'win32':
402
from bzrlib import win32utils
403
win32utils.debug_memory_win32api(message=message, short=short)
405
_debug_memory_proc(message=message, short=short)
408
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
410
def _debug_memory_proc(message='', short=True):
412
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
416
status = status_file.read()
421
for line in status.splitlines():
425
for field in _short_fields:
426
if line.startswith(field):
431
def report_exception(exc_info, err_file):
432
"""Report an exception to err_file (typically stderr) and to .bzr.log.
434
This will show either a full traceback or a short message as appropriate.
436
:return: The appropriate exit code for this error.
438
# Log the full traceback to ~/.bzr.log
439
log_exception_quietly()
440
if 'error' in debug.debug_flags:
441
print_exception(exc_info, err_file)
442
return errors.EXIT_ERROR
443
exc_type, exc_object, exc_tb = exc_info
444
if (isinstance(exc_object, IOError)
445
and getattr(exc_object, 'errno', None) == errno.EPIPE):
446
err_file.write("bzr: broken pipe\n")
447
return errors.EXIT_ERROR
448
elif isinstance(exc_object, KeyboardInterrupt):
449
err_file.write("bzr: interrupted\n")
450
return errors.EXIT_ERROR
451
elif isinstance(exc_object, MemoryError):
452
err_file.write("bzr: out of memory\n")
453
return errors.EXIT_ERROR
454
elif isinstance(exc_object, ImportError) \
455
and str(exc_object).startswith("No module named "):
456
report_user_error(exc_info, err_file,
457
'You may need to install this Python library separately.')
458
return errors.EXIT_ERROR
459
elif not getattr(exc_object, 'internal_error', True):
460
report_user_error(exc_info, err_file)
461
return errors.EXIT_ERROR
462
elif isinstance(exc_object, (OSError, IOError)):
463
# Might be nice to catch all of these and show them as something more
464
# specific, but there are too many cases at the moment.
465
report_user_error(exc_info, err_file)
466
return errors.EXIT_ERROR
468
report_bug(exc_info, err_file)
469
return errors.EXIT_INTERNAL_ERROR
472
def print_exception(exc_info, err_file):
473
exc_type, exc_object, exc_tb = exc_info
474
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
475
exc_type.__module__, exc_type.__name__, exc_object))
477
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
480
# TODO: Should these be specially encoding the output?
481
def report_user_error(exc_info, err_file, advice=None):
482
"""Report to err_file an error that's not an internal error.
484
These don't get a traceback unless -Derror was given.
486
:param exc_info: 3-tuple from sys.exc_info()
487
:param advice: Extra advice to the user to be printed following the
490
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
492
err_file.write("%s\n" % (advice,))
495
def report_bug(exc_info, err_file):
496
"""Report an exception that probably indicates a bug in bzr"""
497
from bzrlib.crash import report_bug
498
report_bug(exc_info, err_file)
added
removed
bzrlib/trace.py
