1
# Copyright (C) 2005-2011 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
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
17
__author__ = "Martin Pool <mbp@canonical.com>"
20
"""Messages and logging for bazaar-ng
22
Nothing is actually logged unless you call bzrlib.open_tracefile().
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
28
######################################################################
29
# messages and logging
31
global _tracefile, _starttime
34
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
37
# If false, notes also go to stdout; should replace this with --silent
42
# fix this if we ever fork within python
44
_logprefix = '[%d] ' % _mypid
47
def _write_trace(msg):
49
_tracefile.write(_logprefix + msg + '\n')
53
sys.stderr.write('bzr: warning: ' + msg + '\n')
54
_write_trace('warning: ' + msg)
61
b = '* ' + str(msg) + '\n'
64
_write_trace('note: ' + msg)
68
sys.stderr.write(msg + '\n')
48
# FIXME: Unfortunately it turns out that python's logging module
49
# is quite expensive, even when the message is not printed by any handlers.
50
# We should perhaps change back to just simply doing it here.
52
# On the other hand, as of 1.2 we generally only call the mutter() statement
53
# if (according to debug_flags) we actually intend to write it. So the
54
# increased cost of logging.py is not so bad, and we could standardize on
62
from bzrlib.lazy_import import lazy_import
63
lazy_import(globals(), """
64
from cStringIO import StringIO
73
lazy_import(globals(), """
83
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
84
# is quiet; >0 is verbose.
87
# File-like object where mutter/debug output is currently sent. Can be
88
# changed by _push_log_file etc. This is directly manipulated by some
89
# external code; maybe there should be functions to do that more precisely
90
# than push/pop_log_file.
93
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
94
# redirected elsewhere. Used to show the location in --version.
95
_bzr_log_filename = None
97
# The time the first message was written to the trace file, so that we can
98
# show relative times since startup.
99
_bzr_log_start_time = bzrlib._start_time
102
# held in a global for quick reference
103
_bzr_logger = logging.getLogger('bzr')
106
def note(*args, **kwargs):
107
"""Output a note to the user.
109
Takes the same parameters as logging.info.
113
# FIXME: clearing the ui and then going through the abstract logging
114
# framework is whack; we should probably have a logging Handler that
115
# deals with terminal output if needed.
116
ui.ui_factory.clear_term()
117
_bzr_logger.info(*args, **kwargs)
120
def warning(*args, **kwargs):
121
ui.ui_factory.clear_term()
122
_bzr_logger.warning(*args, **kwargs)
125
def show_error(*args, **kwargs):
126
"""Show an error message to the user.
128
Don't use this for exceptions, use report_exception instead.
130
_bzr_logger.error(*args, **kwargs)
133
def mutter(fmt, *args):
134
if _trace_file is None:
136
# XXX: Don't check this every time; instead anyone who closes the file
137
# ought to deregister it. We can tolerate None.
138
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
141
if isinstance(fmt, unicode):
142
fmt = fmt.encode('utf8')
145
# It seems that if we do ascii % (unicode, ascii) we can
146
# get a unicode cannot encode ascii error, so make sure that "fmt"
147
# is a unicode string
150
if isinstance(arg, unicode):
151
arg = arg.encode('utf8')
152
real_args.append(arg)
153
out = fmt % tuple(real_args)
157
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
158
out = timestamp + out + '\n'
159
_trace_file.write(out)
160
# there's no explicit flushing; the file is typically line buffered.
163
def mutter_callsite(stacklevel, fmt, *args):
164
"""Perform a mutter of fmt and args, logging the call trace.
166
:param stacklevel: The number of frames to show. None will show all
168
:param fmt: The format string to pass to mutter.
169
:param args: A list of substitution variables.
172
if stacklevel is None:
175
limit = stacklevel + 1
176
traceback.print_stack(limit=limit, file=outf)
177
formatted_lines = outf.getvalue().splitlines()
178
formatted_stack = '\n'.join(formatted_lines[:-2])
179
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
72
182
def _rollover_trace_maybe(trace_fname):
76
186
if size <= 4 << 20:
78
188
old_fname = trace_fname + '.old'
81
# must remove before rename on windows
87
# might fail if in use on windows
88
os.rename(trace_fname, old_fname)
189
osutils.rename(trace_fname, old_fname)
96
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
97
# Messages are always written to here, so that we have some
98
# information if something goes wrong. In a future version this
99
# file will be removed on successful completion.
100
global _starttime, _tracefile
103
_starttime = os.times()[4]
105
trace_fname = os.path.join(os.path.expanduser(tracefilename))
106
_rollover_trace_maybe(trace_fname)
108
# buffering=1 means line buffered
110
_tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
113
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
114
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
115
t.write("you can delete or truncate this file, or include sections in\n")
116
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
119
_write_trace('bzr %s invoked on python %s (%s)'
120
% (bzrlib.__version__,
121
'.'.join(map(str, sys.version_info)),
124
_write_trace(' arguments: %r' % argv)
125
_write_trace(' working dir: ' + os.getcwdu())
194
def _get_bzr_log_filename():
195
bzr_log = os.environ.get('BZR_LOG')
198
home = os.environ.get('BZR_HOME')
200
if sys.platform == 'win32':
201
from bzrlib import win32utils
202
home = win32utils.get_home_location()
204
home = os.path.expanduser('~')
205
return os.path.join(home, '.bzr.log')
209
"""Open the .bzr.log trace file.
211
If the log is more than a particular length, the old file is renamed to
212
.bzr.log.old and a new file is started. Otherwise, we append to the
215
This sets the global _bzr_log_filename.
217
global _bzr_log_filename
219
def _open_or_create_log_file(filename):
220
"""Open existing log file, or create with ownership and permissions
222
It inherits the ownership and permissions (masked by umask) from
223
the containing directory to cope better with being run under sudo
224
with $HOME still set to the user's homedir.
226
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
229
fd = os.open(filename, flags)
232
if e.errno != errno.ENOENT:
235
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
237
if e.errno != errno.EEXIST:
240
osutils.copy_ownership_from_path(filename)
242
return os.fdopen(fd, 'at', 0) # unbuffered
245
_bzr_log_filename = _get_bzr_log_filename()
246
_rollover_trace_maybe(_bzr_log_filename)
248
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
249
bzr_log_file.write('\n')
250
if bzr_log_file.tell() <= 2:
251
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
252
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
253
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
257
except EnvironmentError, e:
258
# If we are failing to open the log, then most likely logging has not
259
# been set up yet. So we just write to stderr rather than using
260
# 'warning()'. If we using warning(), users get the unhelpful 'no
261
# handlers registered for "bzr"' when something goes wrong on the
262
# server. (bug #503886)
263
sys.stderr.write("failed to open trace file: %s\n" % (e,))
264
# TODO: What should happen if we fail to open the trace file? Maybe the
265
# objects should be pointed at /dev/null or the equivalent? Currently
266
# returns None which will cause failures later.
270
def enable_default_logging():
271
"""Configure default logging: messages to stderr and debug to .bzr.log
273
This should only be called once per process.
275
Non-command-line programs embedding bzrlib do not need to call this. They
276
can instead either pass a file to _push_log_file, or act directly on
277
logging.getLogger("bzr").
279
Output can be redirected away by calling _push_log_file.
281
:return: A memento from push_log_file for restoring the log state.
283
start_time = osutils.format_local_date(_bzr_log_start_time,
285
bzr_log_file = _open_bzr_log()
286
if bzr_log_file is not None:
287
bzr_log_file.write(start_time.encode('utf-8') + '\n')
288
memento = push_log_file(bzr_log_file,
289
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
290
r'%Y-%m-%d %H:%M:%S')
291
# after hooking output into bzr_log, we also need to attach a stderr
292
# handler, writing only at level info and with encoding
293
stderr_handler = EncodedStreamHandler(sys.stderr,
294
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
295
logging.getLogger('bzr').addHandler(stderr_handler)
299
def push_log_file(to_file, log_format=None, date_format=None):
300
"""Intercept log and trace messages and send them to a file.
302
:param to_file: A file-like object to which messages will be sent.
304
:returns: A memento that should be passed to _pop_log_file to restore the
305
previously active logging.
309
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
310
if log_format is None:
311
log_format = '%(levelname)8s %(message)s'
312
new_handler.setFormatter(logging.Formatter(log_format, date_format))
313
# save and remove any existing log handlers
314
bzr_logger = logging.getLogger('bzr')
315
old_handlers = bzr_logger.handlers[:]
316
del bzr_logger.handlers[:]
317
# set that as the default logger
318
bzr_logger.addHandler(new_handler)
319
bzr_logger.setLevel(logging.DEBUG)
320
# TODO: check if any changes are needed to the root logger
322
# TODO: also probably need to save and restore the level on bzr_logger.
323
# but maybe we can avoid setting the logger level altogether, and just set
324
# the level on the handler?
326
# save the old trace file
327
old_trace_file = _trace_file
328
# send traces to the new one
329
_trace_file = to_file
330
result = new_handler, _trace_file
331
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
334
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
335
"""Undo changes to logging/tracing done by _push_log_file.
337
This flushes, but does not close the trace file (so that anything that was
340
Takes the memento returned from _push_log_file."""
342
_trace_file = old_trace_file
343
bzr_logger = logging.getLogger('bzr')
344
bzr_logger.removeHandler(new_handler)
345
# must be closed, otherwise logging will try to close it at exit, and the
346
# file will likely already be closed underneath.
348
bzr_logger.handlers = old_handlers
349
if new_trace_file is not None:
350
new_trace_file.flush()
353
def log_exception_quietly():
354
"""Log the last exception to the trace file only.
356
Used for exceptions that occur internally and that may be
357
interesting to developers but not to users. For example,
358
errors loading plugins.
360
mutter(traceback.format_exc())
363
def set_verbosity_level(level):
364
"""Set the verbosity level.
366
:param level: -ve for quiet, 0 for normal, +ve for verbose
368
global _verbosity_level
369
_verbosity_level = level
370
_update_logging_level(level < 0)
371
ui.ui_factory.be_quiet(level < 0)
374
def get_verbosity_level():
375
"""Get the verbosity level.
377
See set_verbosity_level() for values.
379
return _verbosity_level
382
def be_quiet(quiet=True):
384
set_verbosity_level(-1)
386
set_verbosity_level(0)
389
def _update_logging_level(quiet=True):
390
"""Hide INFO messages if quiet."""
392
_bzr_logger.setLevel(logging.WARNING)
394
_bzr_logger.setLevel(logging.INFO)
398
"""Is the verbosity level negative?"""
399
return _verbosity_level < 0
403
"""Is the verbosity level positive?"""
404
return _verbosity_level > 0
407
def debug_memory(message='', short=True):
408
"""Write out a memory dump."""
409
if sys.platform == 'win32':
410
from bzrlib import win32utils
411
win32utils.debug_memory_win32api(message=message, short=short)
413
_debug_memory_proc(message=message, short=short)
416
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
418
def _debug_memory_proc(message='', short=True):
420
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
424
status = status_file.read()
429
for line in status.splitlines():
433
for field in _short_fields:
434
if line.startswith(field):
438
def _dump_memory_usage(err_file):
441
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
442
dump_file = os.fdopen(fd, 'w')
443
from meliae import scanner
444
scanner.dump_gc_objects(dump_file)
445
err_file.write("Memory dumped to %s\n" % name)
447
err_file.write("Dumping memory requires meliae module.\n")
448
log_exception_quietly()
450
err_file.write("Exception while dumping memory.\n")
451
log_exception_quietly()
453
if dump_file is not None:
459
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
460
"""Give name of error class including module for non-builtin exceptions
462
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
463
also omit the module prefix.
465
class_name = eclass.__name__
466
module_name = eclass.__module__
467
if module_name in ("exceptions", "__main__") or (
468
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
470
return "%s.%s" % (module_name, class_name)
473
def report_exception(exc_info, err_file):
474
"""Report an exception to err_file (typically stderr) and to .bzr.log.
476
This will show either a full traceback or a short message as appropriate.
478
:return: The appropriate exit code for this error.
480
# Log the full traceback to ~/.bzr.log
481
log_exception_quietly()
482
if 'error' in debug.debug_flags:
483
print_exception(exc_info, err_file)
484
return errors.EXIT_ERROR
485
exc_type, exc_object, exc_tb = exc_info
486
if isinstance(exc_object, KeyboardInterrupt):
487
err_file.write("bzr: interrupted\n")
488
return errors.EXIT_ERROR
489
elif isinstance(exc_object, MemoryError):
490
err_file.write("bzr: out of memory\n")
491
if 'mem_dump' in debug.debug_flags:
492
_dump_memory_usage(err_file)
494
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
495
return errors.EXIT_ERROR
496
elif isinstance(exc_object, ImportError) \
497
and str(exc_object).startswith("No module named "):
498
report_user_error(exc_info, err_file,
499
'You may need to install this Python library separately.')
500
return errors.EXIT_ERROR
501
elif not getattr(exc_object, 'internal_error', True):
502
report_user_error(exc_info, err_file)
503
return errors.EXIT_ERROR
504
elif osutils.is_environment_error(exc_object):
505
if getattr(exc_object, 'errno', None) == errno.EPIPE:
506
err_file.write("bzr: broken pipe\n")
507
return errors.EXIT_ERROR
508
# Might be nice to catch all of these and show them as something more
509
# specific, but there are too many cases at the moment.
510
report_user_error(exc_info, err_file)
511
return errors.EXIT_ERROR
513
report_bug(exc_info, err_file)
514
return errors.EXIT_INTERNAL_ERROR
517
def print_exception(exc_info, err_file):
518
exc_type, exc_object, exc_tb = exc_info
519
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
520
exc_type.__module__, exc_type.__name__, exc_object))
522
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
525
# TODO: Should these be specially encoding the output?
526
def report_user_error(exc_info, err_file, advice=None):
527
"""Report to err_file an error that's not an internal error.
529
These don't get a traceback unless -Derror was given.
531
:param exc_info: 3-tuple from sys.exc_info()
532
:param advice: Extra advice to the user to be printed following the
535
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
537
err_file.write("%s\n" % (advice,))
540
def report_bug(exc_info, err_file):
541
"""Report an exception that probably indicates a bug in bzr"""
542
from bzrlib.crash import report_bug
543
report_bug(exc_info, err_file)
546
def _flush_stdout_stderr():
547
# called from the bzrlib library finalizer returned by bzrlib.initialize()
551
except ValueError, e:
552
# On Windows, I get ValueError calling stdout.flush() on a closed
126
555
except IOError, e:
127
warning("failed to open trace file: %s" % (e))
131
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
132
% (times[:4] + ((times[4] - _starttime),)))
137
"""Log the last exception into the trace file."""
139
s = cgitb.text(sys.exc_info())
140
for l in s.split('\n'):
557
if e.errno in [errno.EINVAL, errno.EPIPE]:
564
# called from the bzrlib library finalizer returned by bzrlib.initialize()
570
class EncodedStreamHandler(logging.Handler):
571
"""Robustly write logging events to a stream using the specified encoding
573
Messages are expected to be formatted to unicode, but UTF-8 byte strings
574
are also accepted. An error during formatting or a str message in another
575
encoding will be quitely noted as an error in the Bazaar log file.
577
The stream is not closed so sys.stdout or sys.stderr may be passed.
580
def __init__(self, stream, encoding=None, errors='strict', level=0):
581
logging.Handler.__init__(self, level)
584
encoding = getattr(stream, "encoding", "ascii")
585
self.encoding = encoding
589
flush = getattr(self.stream, "flush", None)
590
if flush is not None:
593
def emit(self, record):
595
line = self.format(record)
596
if not isinstance(line, unicode):
597
line = line.decode("utf-8")
598
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
600
log_exception_quietly()
601
# Try saving the details that would have been logged in some form
602
msg = args = "<Unformattable>"
604
msg = repr(record.msg).encode("ascii")
605
args = repr(record.args).encode("ascii")
608
# Using mutter() bypasses the logging module and writes directly
609
# to the file so there's no danger of getting into a loop here.
610
mutter("Logging record unformattable: %s %% %s", msg, args)
613
class Config(object):
614
"""Configuration of message tracing in bzrlib.
616
This implements the context manager protocol and should manage any global
617
variables still used. The default config used is DefaultConfig, but
618
embedded uses of bzrlib may wish to use a custom manager.
622
return self # This is bound to the 'as' clause in a with statement.
624
def __exit__(self, exc_type, exc_val, exc_tb):
625
return False # propogate exceptions.
628
class DefaultConfig(Config):
629
"""A default configuration for tracing of messages in bzrlib.
631
This implements the context manager protocol.
635
self._original_filename = _bzr_log_filename
636
self._original_state = enable_default_logging()
637
return self # This is bound to the 'as' clause in a with statement.
639
def __exit__(self, exc_type, exc_val, exc_tb):
640
pop_log_file(self._original_state)
641
global _bzr_log_filename
642
_bzr_log_filename = self._original_filename
643
return False # propogate exceptions.
added
removed
bzrlib/trace.py
