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
def mutter(fmt, *args):
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)
155
timestamp = '%0.3f ' % (time.time() - _bzr_log_start_time,)
156
out = timestamp + out + '\n'
157
_trace_file.write(out)
158
# no need to flush here, the trace file is now linebuffered when it's
162
def mutter_callsite(stacklevel, fmt, *args):
163
"""Perform a mutter of fmt and args, logging the call trace.
165
:param stacklevel: The number of frames to show. None will show all
167
:param fmt: The format string to pass to mutter.
168
:param args: A list of substitution variables.
171
if stacklevel is None:
174
limit = stacklevel + 1
175
traceback.print_stack(limit=limit, file=outf)
176
formatted_lines = outf.getvalue().splitlines()
177
formatted_stack = '\n'.join(formatted_lines[:-2])
178
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.
181
96
def _rollover_trace_maybe(trace_fname):
185
100
if size <= 4 << 20:
187
102
old_fname = trace_fname + '.old'
188
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)
193
def _get_bzr_log_filename():
194
bzr_log = os.environ.get('BZR_LOG')
197
home = os.environ.get('BZR_HOME')
199
if sys.platform == 'win32':
200
from bzrlib import win32utils
201
home = win32utils.get_home_location()
203
home = os.path.expanduser('~')
204
return os.path.join(home, '.bzr.log')
208
"""Open the .bzr.log trace file.
210
If the log is more than a particular length, the old file is renamed to
211
.bzr.log.old and a new file is started. Otherwise, we append to the
214
This sets the global _bzr_log_filename.
216
global _bzr_log_filename
217
_bzr_log_filename = _get_bzr_log_filename()
218
_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
220
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
221
# bzr_log_file.tell() on windows always return 0 until some writing done
222
bzr_log_file.write('\n')
223
if bzr_log_file.tell() <= 2:
224
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
225
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
226
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)
228
146
except IOError, e:
229
147
warning("failed to open trace file: %s" % (e))
230
# TODO: What should happen if we fail to open the trace file? Maybe the
231
# objects should be pointed at /dev/null or the equivalent? Currently
232
# 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)
235
179
def enable_default_logging():
236
"""Configure default logging: messages to stderr and debug to .bzr.log
238
This should only be called once per process.
240
Non-command-line programs embedding bzrlib do not need to call this. They
241
can instead either pass a file to _push_log_file, or act directly on
242
logging.getLogger("bzr").
244
Output can be redirected away by calling _push_log_file.
246
# create encoded wrapper around stderr
247
bzr_log_file = _open_bzr_log()
248
push_log_file(bzr_log_file,
249
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
250
r'%Y-%m-%d %H:%M:%S')
251
# after hooking output into bzr_log, we also need to attach a stderr
252
# handler, writing only at level info and with encoding
253
writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
254
encoded_stderr = writer_factory(sys.stderr, errors='replace')
255
stderr_handler = logging.StreamHandler(encoded_stderr)
256
stderr_handler.setLevel(logging.INFO)
257
logging.getLogger('bzr').addHandler(stderr_handler)
260
def push_log_file(to_file, log_format=None, date_format=None):
261
"""Intercept log and trace messages and send them to a file.
263
:param to_file: A file-like object to which messages will be sent.
265
:returns: A memento that should be passed to _pop_log_file to restore the
266
previously active logging.
270
new_handler = logging.StreamHandler(to_file)
271
new_handler.setLevel(logging.DEBUG)
272
if log_format is None:
273
log_format = '%(levelname)8s %(message)s'
274
new_handler.setFormatter(logging.Formatter(log_format, date_format))
275
# save and remove any existing log handlers
276
bzr_logger = logging.getLogger('bzr')
277
old_handlers = bzr_logger.handlers[:]
278
del bzr_logger.handlers[:]
279
# set that as the default logger
280
bzr_logger.addHandler(new_handler)
281
bzr_logger.setLevel(logging.DEBUG)
282
# TODO: check if any changes are needed to the root logger
284
# TODO: also probably need to save and restore the level on bzr_logger.
285
# but maybe we can avoid setting the logger level altogether, and just set
286
# the level on the handler?
288
# save the old trace file
289
old_trace_file = _trace_file
290
# send traces to the new one
291
_trace_file = to_file
292
result = new_handler, _trace_file
293
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
296
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
297
"""Undo changes to logging/tracing done by _push_log_file.
299
This flushes, but does not close the trace file.
301
Takes the memento returned from _push_log_file."""
303
_trace_file = old_trace_file
304
bzr_logger = logging.getLogger('bzr')
305
bzr_logger.removeHandler(new_handler)
306
# must be closed, otherwise logging will try to close it atexit, and the
307
# file will likely already be closed underneath.
309
bzr_logger.handlers = old_handlers
310
new_trace_file.flush()
313
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
314
def enable_test_log(to_file):
315
"""Redirect logging to a temporary file for a test
317
:returns: an opaque reference that should be passed to disable_test_log
318
after the test completes.
320
return push_log_file(to_file)
323
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
324
def disable_test_log(memento):
325
return pop_log_file(memento)
328
def log_exception_quietly():
329
"""Log the last exception to the trace file only.
331
Used for exceptions that occur internally and that may be
332
interesting to developers but not to users. For example,
333
errors loading plugins.
335
mutter(traceback.format_exc())
338
def set_verbosity_level(level):
339
"""Set the verbosity level.
341
:param level: -ve for quiet, 0 for normal, +ve for verbose
343
global _verbosity_level
344
_verbosity_level = level
345
_update_logging_level(level < 0)
348
def get_verbosity_level():
349
"""Get the verbosity level.
351
See set_verbosity_level() for values.
353
return _verbosity_level
356
def be_quiet(quiet=True):
357
# Perhaps this could be deprecated now ...
359
set_verbosity_level(-1)
361
set_verbosity_level(0)
364
def _update_logging_level(quiet=True):
365
"""Hide INFO messages if quiet."""
367
_bzr_logger.setLevel(logging.WARNING)
369
_bzr_logger.setLevel(logging.INFO)
373
"""Is the verbosity level negative?"""
374
return _verbosity_level < 0
378
"""Is the verbosity level positive?"""
379
return _verbosity_level > 0
382
@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)
383
201
def disable_default_logging():
384
202
"""Turn off default log handlers.
386
Don't call this method, use _push_log_file and _pop_log_file instead.
391
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
393
def debug_memory(message='', short=True):
394
"""Write out a memory dump."""
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, ImportError) \
433
and str(exc_object).startswith("No module named "):
434
report_user_error(exc_info, err_file,
435
'You may need to install this Python library separately.')
436
return errors.EXIT_ERROR
437
elif not getattr(exc_object, 'internal_error', True):
438
report_user_error(exc_info, err_file)
439
return errors.EXIT_ERROR
440
elif isinstance(exc_object, (OSError, IOError)):
441
# Might be nice to catch all of these and show them as something more
442
# specific, but there are too many cases at the moment.
443
report_user_error(exc_info, err_file)
444
return errors.EXIT_ERROR
446
report_bug(exc_info, err_file)
447
return errors.EXIT_INTERNAL_ERROR
450
def print_exception(exc_info, err_file):
451
exc_type, exc_object, exc_tb = exc_info
452
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
453
exc_type.__module__, exc_type.__name__, exc_object))
455
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
458
# TODO: Should these be specially encoding the output?
459
def report_user_error(exc_info, err_file, advice=None):
460
"""Report to err_file an error that's not an internal error.
462
These don't get a traceback unless -Derror was given.
464
:param exc_info: 3-tuple from sys.exc_info()
465
:param advice: Extra advice to the user to be printed following the
468
if 'error' in debug.debug_flags:
469
print_exception(exc_info, err_file)
471
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
473
err_file.write("%s\n" % (advice,))
476
def report_bug(exc_info, err_file):
477
"""Report an exception that probably indicates a bug in bzr"""
478
print_exception(exc_info, err_file)
480
err_file.write('bzr %s on python %s (%s)\n' % \
482
bzrlib._format_version_tuple(sys.version_info),
484
err_file.write('arguments: %r\n' % sys.argv)
486
'encoding: %r, fsenc: %r, lang: %r\n' % (
487
osutils.get_user_encoding(), sys.getfilesystemencoding(),
488
os.environ.get('LANG')))
489
err_file.write("plugins:\n")
490
for name, a_plugin in sorted(plugin.plugins().items()):
491
err_file.write(" %-20s %s [%s]\n" %
492
(name, a_plugin.path(), a_plugin.__version__))
495
*** Bazaar has encountered an internal error.
496
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
497
including this traceback, and a description of what you
498
were doing when the error occurred.
204
This is intended to be used by the test framework, which doesn't
205
want leakage from the code-under-test into the main logs.
208
l = logging.getLogger('')
209
l.removeHandler(_stderr_handler)
211
l.removeHandler(_file_handler)
added
removed
bzrlib/trace.py
