1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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
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
74
lazy_import(globals(), """
85
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
86
# is quiet; >0 is verbose.
89
# File-like object where mutter/debug output is currently sent. Can be
90
# changed by _push_log_file etc. This is directly manipulated by some
91
# external code; maybe there should be functions to do that more precisely
92
# than push/pop_log_file.
95
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
96
# redirected elsewhere. Used to show the location in --version.
97
_bzr_log_filename = None
99
# The time the first message was written to the trace file, so that we can
100
# show relative times since startup.
101
_bzr_log_start_time = bzrlib._start_time
104
# held in a global for quick reference
105
_bzr_logger = logging.getLogger('bzr')
108
def note(*args, **kwargs):
109
# FIXME note always emits utf-8, regardless of the terminal encoding
111
# FIXME: clearing the ui and then going through the abstract logging
112
# framework is whack; we should probably have a logging Handler that
113
# deals with terminal output if needed.
115
bzrlib.ui.ui_factory.clear_term()
116
_bzr_logger.info(*args, **kwargs)
119
def warning(*args, **kwargs):
121
bzrlib.ui.ui_factory.clear_term()
122
_bzr_logger.warning(*args, **kwargs)
125
# configure convenient aliases for output routines
127
# TODO: deprecate them, have one name for each.
128
error = _bzr_logger.error
131
_last_mutter_flush_time = None
133
def mutter(fmt, *args):
134
global _last_mutter_flush_time
135
if _trace_file is None:
137
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
140
if isinstance(fmt, unicode):
141
fmt = fmt.encode('utf8')
144
# It seems that if we do ascii % (unicode, ascii) we can
145
# get a unicode cannot encode ascii error, so make sure that "fmt"
146
# is a unicode string
149
if isinstance(arg, unicode):
150
arg = arg.encode('utf8')
151
real_args.append(arg)
152
out = fmt % tuple(real_args)
156
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
157
out = timestamp + out + '\n'
158
_trace_file.write(out)
159
# We flush if we haven't flushed for a few seconds. We don't want to flush
160
# on every mutter, but when a command takes a while, it can be nice to see
161
# updates in the debug log.
162
if (_last_mutter_flush_time is None
163
or (now - _last_mutter_flush_time) > 2.0):
164
flush = getattr(_trace_file, 'flush', None)
165
if flush is not None:
167
_last_mutter_flush_time = now
170
def mutter_callsite(stacklevel, fmt, *args):
171
"""Perform a mutter of fmt and args, logging the call trace.
173
:param stacklevel: The number of frames to show. None will show all
175
:param fmt: The format string to pass to mutter.
176
:param args: A list of substitution variables.
179
if stacklevel is None:
182
limit = stacklevel + 1
183
traceback.print_stack(limit=limit, file=outf)
184
formatted_lines = outf.getvalue().splitlines()
185
formatted_stack = '\n'.join(formatted_lines[:-2])
186
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
189
def _rollover_trace_maybe(trace_fname):
192
size = os.stat(trace_fname)[stat.ST_SIZE]
195
old_fname = trace_fname + '.old'
196
osutils.rename(trace_fname, old_fname)
201
def _get_bzr_log_filename():
202
bzr_log = os.environ.get('BZR_LOG')
205
home = os.environ.get('BZR_HOME')
207
if sys.platform == 'win32':
208
from bzrlib import win32utils
209
home = win32utils.get_home_location()
211
home = os.path.expanduser('~')
212
return os.path.join(home, '.bzr.log')
216
"""Open the .bzr.log trace file.
218
If the log is more than a particular length, the old file is renamed to
219
.bzr.log.old and a new file is started. Otherwise, we append to the
222
This sets the global _bzr_log_filename.
224
global _bzr_log_filename
225
_bzr_log_filename = _get_bzr_log_filename()
226
_rollover_trace_maybe(_bzr_log_filename)
228
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
229
# bzr_log_file.tell() on windows always return 0 until some writing done
230
bzr_log_file.write('\n')
231
if bzr_log_file.tell() <= 2:
232
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
233
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
234
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
237
warning("failed to open trace file: %s" % (e))
238
# TODO: What should happen if we fail to open the trace file? Maybe the
239
# objects should be pointed at /dev/null or the equivalent? Currently
240
# returns None which will cause failures later.
244
def enable_default_logging():
245
"""Configure default logging: messages to stderr and debug to .bzr.log
247
This should only be called once per process.
249
Non-command-line programs embedding bzrlib do not need to call this. They
250
can instead either pass a file to _push_log_file, or act directly on
251
logging.getLogger("bzr").
253
Output can be redirected away by calling _push_log_file.
255
# Do this before we open the log file, so we prevent
256
# get_terminal_encoding() from mutter()ing multiple times
257
term_encoding = osutils.get_terminal_encoding()
258
start_time = osutils.format_local_date(_bzr_log_start_time,
260
# create encoded wrapper around stderr
261
bzr_log_file = _open_bzr_log()
262
if bzr_log_file is not None:
263
bzr_log_file.write(start_time.encode('utf-8') + '\n')
264
push_log_file(bzr_log_file,
265
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
266
r'%Y-%m-%d %H:%M:%S')
267
# after hooking output into bzr_log, we also need to attach a stderr
268
# handler, writing only at level info and with encoding
269
writer_factory = codecs.getwriter(term_encoding)
270
encoded_stderr = writer_factory(sys.stderr, errors='replace')
271
stderr_handler = logging.StreamHandler(encoded_stderr)
272
stderr_handler.setLevel(logging.INFO)
273
logging.getLogger('bzr').addHandler(stderr_handler)
276
def push_log_file(to_file, log_format=None, date_format=None):
277
"""Intercept log and trace messages and send them to a file.
279
:param to_file: A file-like object to which messages will be sent.
281
:returns: A memento that should be passed to _pop_log_file to restore the
282
previously active logging.
286
new_handler = logging.StreamHandler(to_file)
287
new_handler.setLevel(logging.DEBUG)
288
if log_format is None:
289
log_format = '%(levelname)8s %(message)s'
290
new_handler.setFormatter(logging.Formatter(log_format, date_format))
291
# save and remove any existing log handlers
292
bzr_logger = logging.getLogger('bzr')
293
old_handlers = bzr_logger.handlers[:]
294
del bzr_logger.handlers[:]
295
# set that as the default logger
296
bzr_logger.addHandler(new_handler)
297
bzr_logger.setLevel(logging.DEBUG)
298
# TODO: check if any changes are needed to the root logger
300
# TODO: also probably need to save and restore the level on bzr_logger.
301
# but maybe we can avoid setting the logger level altogether, and just set
302
# the level on the handler?
304
# save the old trace file
305
old_trace_file = _trace_file
306
# send traces to the new one
307
_trace_file = to_file
308
result = new_handler, _trace_file
309
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
312
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
313
"""Undo changes to logging/tracing done by _push_log_file.
315
This flushes, but does not close the trace file.
317
Takes the memento returned from _push_log_file."""
319
_trace_file = old_trace_file
320
bzr_logger = logging.getLogger('bzr')
321
bzr_logger.removeHandler(new_handler)
322
# must be closed, otherwise logging will try to close it atexit, and the
323
# file will likely already be closed underneath.
325
bzr_logger.handlers = old_handlers
326
new_trace_file.flush()
329
def log_exception_quietly():
330
"""Log the last exception to the trace file only.
332
Used for exceptions that occur internally and that may be
333
interesting to developers but not to users. For example,
334
errors loading plugins.
336
mutter(traceback.format_exc())
339
def set_verbosity_level(level):
340
"""Set the verbosity level.
342
:param level: -ve for quiet, 0 for normal, +ve for verbose
344
global _verbosity_level
345
_verbosity_level = level
346
_update_logging_level(level < 0)
349
def get_verbosity_level():
350
"""Get the verbosity level.
352
See set_verbosity_level() for values.
354
return _verbosity_level
357
def be_quiet(quiet=True):
358
# Perhaps this could be deprecated now ...
360
set_verbosity_level(-1)
362
set_verbosity_level(0)
365
def _update_logging_level(quiet=True):
366
"""Hide INFO messages if quiet."""
368
_bzr_logger.setLevel(logging.WARNING)
370
_bzr_logger.setLevel(logging.INFO)
374
"""Is the verbosity level negative?"""
375
return _verbosity_level < 0
379
"""Is the verbosity level positive?"""
380
return _verbosity_level > 0
383
def debug_memory(message='', short=True):
384
"""Write out a memory dump."""
385
if sys.platform == 'win32':
386
from bzrlib import win32utils
387
win32utils.debug_memory_win32api(message=message, short=short)
389
_debug_memory_proc(message=message, short=short)
392
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
394
def _debug_memory_proc(message='', short=True):
396
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
400
status = status_file.read()
405
for line in status.splitlines():
409
for field in _short_fields:
410
if line.startswith(field):
415
def report_exception(exc_info, err_file):
416
"""Report an exception to err_file (typically stderr) and to .bzr.log.
418
This will show either a full traceback or a short message as appropriate.
420
:return: The appropriate exit code for this error.
422
exc_type, exc_object, exc_tb = exc_info
423
# Log the full traceback to ~/.bzr.log
424
log_exception_quietly()
425
if (isinstance(exc_object, IOError)
426
and getattr(exc_object, 'errno', None) == errno.EPIPE):
427
err_file.write("bzr: broken pipe\n")
428
return errors.EXIT_ERROR
429
elif isinstance(exc_object, KeyboardInterrupt):
430
err_file.write("bzr: interrupted\n")
431
return errors.EXIT_ERROR
432
elif isinstance(exc_object, MemoryError):
433
err_file.write("bzr: out of memory\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
