1
# Copyright (C) 2005-2011 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
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging.
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 debug mode, stderr gets debug messages too.
38
Errors that terminate an operation are generally passed back as exceptions;
39
others may be just emitted as messages.
41
Exceptions are reported in a brief form to stderr so as not to look scary.
42
BzrErrors are required to be able to format themselves into a properly
43
explanatory message. This is not true for builtin exceptions such as
44
KeyError, which typically just str to "0". They're printed in a different
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.
48
from __future__ import absolute_import
50
# FIXME: Unfortunately it turns out that python's logging module
51
# is quite expensive, even when the message is not printed by any handlers.
52
# We should perhaps change back to just simply doing it here.
54
# On the other hand, as of 1.2 we generally only call the mutter() statement
55
# if (according to debug_flags) we actually intend to write it. So the
56
# 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.
64
from bzrlib.lazy_import import lazy_import
65
lazy_import(globals(), """
66
from cStringIO import StringIO
75
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
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
105
79
_bzr_logger = logging.getLogger('bzr')
108
def note(*args, **kwargs):
109
"""Output a note to the user.
111
Takes the same parameters as logging.info.
115
# FIXME: clearing the ui and then going through the abstract logging
116
# framework is whack; we should probably have a logging Handler that
117
# deals with terminal output if needed.
118
ui.ui_factory.clear_term()
119
_bzr_logger.info(*args, **kwargs)
122
def warning(*args, **kwargs):
123
ui.ui_factory.clear_term()
124
_bzr_logger.warning(*args, **kwargs)
127
def show_error(*args, **kwargs):
128
"""Show an error message to the user.
130
Don't use this for exceptions, use report_exception instead.
132
_bzr_logger.error(*args, **kwargs)
135
def mutter(fmt, *args):
136
if _trace_file is None:
138
# XXX: Don't check this every time; instead anyone who closes the file
139
# ought to deregister it. We can tolerate 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
# there's no explicit flushing; the file is typically line buffered.
165
def mutter_callsite(stacklevel, fmt, *args):
166
"""Perform a mutter of fmt and args, logging the call trace.
168
:param stacklevel: The number of frames to show. None will show all
170
:param fmt: The format string to pass to mutter.
171
:param args: A list of substitution variables.
174
if stacklevel is None:
177
limit = stacklevel + 1
178
traceback.print_stack(limit=limit, file=outf)
179
formatted_lines = outf.getvalue().splitlines()
180
formatted_stack = '\n'.join(formatted_lines[:-2])
181
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
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.
184
96
def _rollover_trace_maybe(trace_fname):
188
100
if size <= 4 << 20:
190
102
old_fname = trace_fname + '.old'
191
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)
196
def _get_bzr_log_filename():
197
bzr_log = osutils.path_from_environ('BZR_LOG')
200
home = osutils.path_from_environ('BZR_HOME')
202
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
203
# over what would be better. On windows, bug 240550
204
# suggests LOCALAPPDATA be used instead.
205
home = osutils._get_home_dir()
206
return os.path.join(home, '.bzr.log')
210
"""Open the .bzr.log trace file.
212
If the log is more than a particular length, the old file is renamed to
213
.bzr.log.old and a new file is started. Otherwise, we append to the
216
This sets the global _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
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)
147
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.
218
global _bzr_log_filename
220
def _open_or_create_log_file(filename):
221
"""Open existing log file, or create with ownership and permissions
223
It inherits the ownership and permissions (masked by umask) from
224
the containing directory to cope better with being run under sudo
225
with $HOME still set to the user's homedir.
227
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
230
fd = os.open(filename, flags)
233
if e.errno != errno.ENOENT:
236
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
238
if e.errno != errno.EEXIST:
241
osutils.copy_ownership_from_path(filename)
243
return os.fdopen(fd, 'at', 0) # unbuffered
246
_bzr_log_filename = _get_bzr_log_filename()
247
_rollover_trace_maybe(_bzr_log_filename)
249
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
250
bzr_log_file.write('\n')
251
if bzr_log_file.tell() <= 2:
252
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
253
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
254
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
258
except EnvironmentError, e:
259
# If we are failing to open the log, then most likely logging has not
260
# been set up yet. So we just write to stderr rather than using
261
# 'warning()'. If we using warning(), users get the unhelpful 'no
262
# handlers registered for "bzr"' when something goes wrong on the
263
# server. (bug #503886)
264
sys.stderr.write("failed to open trace file: %s\n" % (e,))
265
# TODO: What should happen if we fail to open the trace file? Maybe the
266
# objects should be pointed at /dev/null or the equivalent? Currently
267
# returns None which will cause failures later.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
271
179
def enable_default_logging():
272
"""Configure default logging: messages to stderr and debug to .bzr.log
274
This should only be called once per process.
276
Non-command-line programs embedding bzrlib do not need to call this. They
277
can instead either pass a file to _push_log_file, or act directly on
278
logging.getLogger("bzr").
280
Output can be redirected away by calling _push_log_file.
282
:return: A memento from push_log_file for restoring the log state.
284
start_time = osutils.format_local_date(_bzr_log_start_time,
286
bzr_log_file = _open_bzr_log()
287
if bzr_log_file is not None:
288
bzr_log_file.write(start_time.encode('utf-8') + '\n')
289
memento = push_log_file(bzr_log_file,
290
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
291
r'%Y-%m-%d %H:%M:%S')
292
# after hooking output into bzr_log, we also need to attach a stderr
293
# handler, writing only at level info and with encoding
294
stderr_handler = EncodedStreamHandler(sys.stderr,
295
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
296
logging.getLogger('bzr').addHandler(stderr_handler)
300
def push_log_file(to_file, log_format=None, date_format=None):
301
"""Intercept log and trace messages and send them to a file.
303
:param to_file: A file-like object to which messages will be sent.
305
:returns: A memento that should be passed to _pop_log_file to restore the
306
previously active logging.
310
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
311
if log_format is None:
312
log_format = '%(levelname)8s %(message)s'
313
new_handler.setFormatter(logging.Formatter(log_format, date_format))
314
# save and remove any existing log handlers
315
bzr_logger = logging.getLogger('bzr')
316
old_handlers = bzr_logger.handlers[:]
317
del bzr_logger.handlers[:]
318
# set that as the default logger
319
bzr_logger.addHandler(new_handler)
320
bzr_logger.setLevel(logging.DEBUG)
321
# TODO: check if any changes are needed to the root logger
323
# TODO: also probably need to save and restore the level on bzr_logger.
324
# but maybe we can avoid setting the logger level altogether, and just set
325
# the level on the handler?
327
# save the old trace file
328
old_trace_file = _trace_file
329
# send traces to the new one
330
_trace_file = to_file
331
result = new_handler, _trace_file
332
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
335
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
336
"""Undo changes to logging/tracing done by _push_log_file.
338
This flushes, but does not close the trace file (so that anything that was
341
Takes the memento returned from _push_log_file."""
343
_trace_file = old_trace_file
344
bzr_logger = logging.getLogger('bzr')
345
bzr_logger.removeHandler(new_handler)
346
# must be closed, otherwise logging will try to close it at exit, and the
347
# file will likely already be closed underneath.
349
bzr_logger.handlers = old_handlers
350
if new_trace_file is not None:
351
new_trace_file.flush()
354
def log_exception_quietly():
355
"""Log the last exception to the trace file only.
357
Used for exceptions that occur internally and that may be
358
interesting to developers but not to users. For example,
359
errors loading plugins.
361
mutter(traceback.format_exc())
364
def set_verbosity_level(level):
365
"""Set the verbosity level.
367
:param level: -ve for quiet, 0 for normal, +ve for verbose
369
global _verbosity_level
370
_verbosity_level = level
371
_update_logging_level(level < 0)
372
ui.ui_factory.be_quiet(level < 0)
375
def get_verbosity_level():
376
"""Get the verbosity level.
378
See set_verbosity_level() for values.
380
return _verbosity_level
383
def be_quiet(quiet=True):
385
set_verbosity_level(-1)
387
set_verbosity_level(0)
390
def _update_logging_level(quiet=True):
391
"""Hide INFO messages if quiet."""
393
_bzr_logger.setLevel(logging.WARNING)
395
_bzr_logger.setLevel(logging.INFO)
399
"""Is the verbosity level negative?"""
400
return _verbosity_level < 0
404
"""Is the verbosity level positive?"""
405
return _verbosity_level > 0
408
def debug_memory(message='', short=True):
409
"""Write out a memory dump."""
410
if sys.platform == 'win32':
411
from bzrlib import win32utils
412
win32utils.debug_memory_win32api(message=message, short=short)
414
_debug_memory_proc(message=message, short=short)
417
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
419
def _debug_memory_proc(message='', short=True):
421
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
425
status = status_file.read()
430
for line in status.splitlines():
434
for field in _short_fields:
435
if line.startswith(field):
439
def _dump_memory_usage(err_file):
442
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
443
dump_file = os.fdopen(fd, 'w')
444
from meliae import scanner
445
scanner.dump_gc_objects(dump_file)
446
err_file.write("Memory dumped to %s\n" % name)
448
err_file.write("Dumping memory requires meliae module.\n")
449
log_exception_quietly()
451
err_file.write("Exception while dumping memory.\n")
452
log_exception_quietly()
454
if dump_file is not None:
460
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
461
"""Give name of error class including module for non-builtin exceptions
463
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
464
also omit the module prefix.
466
class_name = eclass.__name__
467
module_name = eclass.__module__
468
if module_name in ("exceptions", "__main__") or (
469
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
471
return "%s.%s" % (module_name, class_name)
474
def report_exception(exc_info, err_file):
475
"""Report an exception to err_file (typically stderr) and to .bzr.log.
477
This will show either a full traceback or a short message as appropriate.
479
:return: The appropriate exit code for this error.
481
# Log the full traceback to ~/.bzr.log
482
log_exception_quietly()
483
if 'error' in debug.debug_flags:
484
print_exception(exc_info, err_file)
485
return errors.EXIT_ERROR
486
exc_type, exc_object, exc_tb = exc_info
487
if 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
if 'mem_dump' in debug.debug_flags:
493
_dump_memory_usage(err_file)
495
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
496
return errors.EXIT_ERROR
497
elif isinstance(exc_object, ImportError) \
498
and str(exc_object).startswith("No module named "):
499
report_user_error(exc_info, err_file,
500
'You may need to install this Python library separately.')
501
return errors.EXIT_ERROR
502
elif not getattr(exc_object, 'internal_error', True):
503
report_user_error(exc_info, err_file)
504
return errors.EXIT_ERROR
505
elif osutils.is_environment_error(exc_object):
506
if getattr(exc_object, 'errno', None) == errno.EPIPE:
507
err_file.write("bzr: broken pipe\n")
508
return errors.EXIT_ERROR
509
# Might be nice to catch all of these and show them as something more
510
# specific, but there are too many cases at the moment.
511
report_user_error(exc_info, err_file)
512
return errors.EXIT_ERROR
514
report_bug(exc_info, err_file)
515
return errors.EXIT_INTERNAL_ERROR
518
def print_exception(exc_info, err_file):
519
exc_type, exc_object, exc_tb = exc_info
520
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
521
exc_type.__module__, exc_type.__name__, exc_object))
523
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
526
# TODO: Should these be specially encoding the output?
527
def report_user_error(exc_info, err_file, advice=None):
528
"""Report to err_file an error that's not an internal error.
530
These don't get a traceback unless -Derror was given.
532
:param exc_info: 3-tuple from sys.exc_info()
533
:param advice: Extra advice to the user to be printed following the
536
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
538
err_file.write("%s\n" % (advice,))
541
def report_bug(exc_info, err_file):
542
"""Report an exception that probably indicates a bug in bzr"""
543
from bzrlib.crash import report_bug
544
report_bug(exc_info, err_file)
547
def _flush_stdout_stderr():
548
# called from the bzrlib library finalizer returned by bzrlib.initialize()
552
except ValueError, e:
553
# On Windows, I get ValueError calling stdout.flush() on a closed
558
if e.errno in [errno.EINVAL, errno.EPIPE]:
565
# called from the bzrlib library finalizer returned by bzrlib.initialize()
571
class EncodedStreamHandler(logging.Handler):
572
"""Robustly write logging events to a stream using the specified encoding
574
Messages are expected to be formatted to unicode, but UTF-8 byte strings
575
are also accepted. An error during formatting or a str message in another
576
encoding will be quitely noted as an error in the Bazaar log file.
578
The stream is not closed so sys.stdout or sys.stderr may be passed.
581
def __init__(self, stream, encoding=None, errors='strict', level=0):
582
logging.Handler.__init__(self, level)
585
encoding = getattr(stream, "encoding", "ascii")
586
self.encoding = encoding
590
flush = getattr(self.stream, "flush", None)
591
if flush is not None:
594
def emit(self, record):
596
line = self.format(record)
597
if not isinstance(line, unicode):
598
line = line.decode("utf-8")
599
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
601
log_exception_quietly()
602
# Try saving the details that would have been logged in some form
603
msg = args = "<Unformattable>"
605
msg = repr(record.msg).encode("ascii")
606
args = repr(record.args).encode("ascii")
609
# Using mutter() bypasses the logging module and writes directly
610
# to the file so there's no danger of getting into a loop here.
611
mutter("Logging record unformattable: %s %% %s", msg, args)
614
class Config(object):
615
"""Configuration of message tracing in bzrlib.
617
This implements the context manager protocol and should manage any global
618
variables still used. The default config used is DefaultConfig, but
619
embedded uses of bzrlib may wish to use a custom manager.
623
return self # This is bound to the 'as' clause in a with statement.
625
def __exit__(self, exc_type, exc_val, exc_tb):
626
return False # propogate exceptions.
629
class DefaultConfig(Config):
630
"""A default configuration for tracing of messages in bzrlib.
632
This implements the context manager protocol.
636
self._original_filename = _bzr_log_filename
637
self._original_state = enable_default_logging()
638
return self # This is bound to the 'as' clause in a with statement.
640
def __exit__(self, exc_type, exc_val, exc_tb):
641
pop_log_file(self._original_state)
642
global _bzr_log_filename
643
_bzr_log_filename = self._original_filename
644
return False # propogate exceptions.
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)
200
def disable_default_logging():
201
"""Turn off default log handlers.
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
