1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
1
# This program is free software; you can redistribute it and/or modify
4
2
# it under the terms of the GNU General Public License as published by
5
3
# the Free Software Foundation; either version 2 of the License, or
6
4
# (at your option) any later version.
8
6
# This program is distributed in the hope that it will be useful,
9
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
9
# GNU General Public License for more details.
13
11
# You should have received a copy of the GNU General Public License
14
12
# along with this program; if not, write to the Free Software
15
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
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.
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
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.
65
from bzrlib.lazy_import import lazy_import
66
lazy_import(globals(), """
67
from cStringIO import StringIO
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.
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
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
106
79
_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)
126
# configure convenient aliases for output routines
128
# TODO: deprecate them, have one name for each.
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
130
84
log_error = _bzr_logger.error
131
85
error = _bzr_logger.error
134
_last_mutter_flush_time = None
136
def mutter(fmt, *args):
137
global _last_mutter_flush_time
138
if _trace_file is None:
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'
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,)))
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.
192
96
def _rollover_trace_maybe(trace_fname):
196
100
if size <= 4 << 20:
198
102
old_fname = trace_fname + '.old'
199
osutils.rename(trace_fname, old_fname)
105
# must remove before rename on windows
111
# might fail if in use on windows
112
os.rename(trace_fname, old_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)
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
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")
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)
239
146
except IOError, e:
240
147
warning("failed to open trace file: %s" % (e))
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.
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)
247
179
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()
332
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
333
def enable_test_log(to_file):
334
"""Redirect logging to a temporary file for a test
336
:returns: an opaque reference that should be passed to disable_test_log
337
after the test completes.
339
return push_log_file(to_file)
342
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
343
def disable_test_log(memento):
344
return pop_log_file(memento)
347
def log_exception_quietly():
348
"""Log the last exception to the trace file only.
350
Used for exceptions that occur internally and that may be
351
interesting to developers but not to users. For example,
352
errors loading plugins.
354
mutter(traceback.format_exc())
357
def set_verbosity_level(level):
358
"""Set the verbosity level.
360
:param level: -ve for quiet, 0 for normal, +ve for verbose
362
global _verbosity_level
363
_verbosity_level = level
364
_update_logging_level(level < 0)
367
def get_verbosity_level():
368
"""Get the verbosity level.
370
See set_verbosity_level() for values.
372
return _verbosity_level
375
def be_quiet(quiet=True):
376
# Perhaps this could be deprecated now ...
378
set_verbosity_level(-1)
380
set_verbosity_level(0)
383
def _update_logging_level(quiet=True):
384
"""Hide INFO messages if quiet."""
386
_bzr_logger.setLevel(logging.WARNING)
388
_bzr_logger.setLevel(logging.INFO)
392
"""Is the verbosity level negative?"""
393
return _verbosity_level < 0
397
"""Is the verbosity level positive?"""
398
return _verbosity_level > 0
401
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
180
"""Configure default logging to stderr and .bzr.log"""
181
global _stderr_handler, _file_handler
183
_stderr_handler = logging.StreamHandler()
184
_stderr_handler.setFormatter(QuietFormatter())
186
if not _file_handler:
189
if os.environ.get('BZR_DEBUG'):
190
level = logging.DEBUG
194
_stderr_handler.setLevel(logging.INFO)
195
_file_handler.setLevel(level)
197
logging.getLogger('').addHandler(_stderr_handler)
402
200
def disable_default_logging():
403
201
"""Turn off default log handlers.
405
Don't call this method, use _push_log_file and _pop_log_file instead.
410
def debug_memory(message='', short=True):
411
"""Write out a memory dump."""
412
if sys.platform == 'win32':
413
from bzrlib import win32utils
414
win32utils.debug_memory_win32api(message=message, short=short)
416
_debug_memory_proc(message=message, short=short)
419
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
421
def _debug_memory_proc(message='', short=True):
423
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
427
status = status_file.read()
432
for line in status.splitlines():
436
for field in _short_fields:
437
if line.startswith(field):
442
def report_exception(exc_info, err_file):
443
"""Report an exception to err_file (typically stderr) and to .bzr.log.
445
This will show either a full traceback or a short message as appropriate.
447
:return: The appropriate exit code for this error.
449
exc_type, exc_object, exc_tb = exc_info
450
# Log the full traceback to ~/.bzr.log
451
log_exception_quietly()
452
if (isinstance(exc_object, IOError)
453
and getattr(exc_object, 'errno', None) == errno.EPIPE):
454
err_file.write("bzr: broken pipe\n")
455
return errors.EXIT_ERROR
456
elif isinstance(exc_object, KeyboardInterrupt):
457
err_file.write("bzr: interrupted\n")
458
return errors.EXIT_ERROR
459
elif isinstance(exc_object, ImportError) \
460
and str(exc_object).startswith("No module named "):
461
report_user_error(exc_info, err_file,
462
'You may need to install this Python library separately.')
463
return errors.EXIT_ERROR
464
elif not getattr(exc_object, 'internal_error', True):
465
report_user_error(exc_info, err_file)
466
return errors.EXIT_ERROR
467
elif isinstance(exc_object, (OSError, IOError)):
468
# Might be nice to catch all of these and show them as something more
469
# specific, but there are too many cases at the moment.
470
report_user_error(exc_info, err_file)
471
return errors.EXIT_ERROR
473
report_bug(exc_info, err_file)
474
return errors.EXIT_INTERNAL_ERROR
477
def print_exception(exc_info, err_file):
478
exc_type, exc_object, exc_tb = exc_info
479
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
480
exc_type.__module__, exc_type.__name__, exc_object))
482
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
485
# TODO: Should these be specially encoding the output?
486
def report_user_error(exc_info, err_file, advice=None):
487
"""Report to err_file an error that's not an internal error.
489
These don't get a traceback unless -Derror was given.
491
:param exc_info: 3-tuple from sys.exc_info()
492
:param advice: Extra advice to the user to be printed following the
495
if 'error' in debug.debug_flags:
496
print_exception(exc_info, err_file)
498
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
500
err_file.write("%s\n" % (advice,))
503
def report_bug(exc_info, err_file):
504
"""Report an exception that probably indicates a bug in bzr"""
505
print_exception(exc_info, err_file)
507
err_file.write('bzr %s on python %s (%s)\n' % \
509
bzrlib._format_version_tuple(sys.version_info),
511
err_file.write('arguments: %r\n' % sys.argv)
513
'encoding: %r, fsenc: %r, lang: %r\n' % (
514
osutils.get_user_encoding(), sys.getfilesystemencoding(),
515
os.environ.get('LANG')))
516
err_file.write("plugins:\n")
517
for name, a_plugin in sorted(plugin.plugins().items()):
518
err_file.write(" %-20s %s [%s]\n" %
519
(name, a_plugin.path(), a_plugin.__version__))
522
*** Bazaar has encountered an internal error.
523
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
524
including this traceback, and a description of what you
525
were doing when the error occurred.
203
This is intended to be used by the test framework, which doesn't
204
want leakage from the code-under-test into the main logs.
207
l = logging.getLogger('')
208
l.removeHandler(_stderr_handler)
210
l.removeHandler(_file_handler)
added
removed
bzrlib/trace.py
