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
63
from bzrlib.lazy_import import lazy_import
64
lazy_import(globals(), """
65
from cStringIO import StringIO
74
from bzrlib.symbol_versioning import (
79
lazy_import(globals(), """
89
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
90
# is quiet; >0 is verbose.
93
# File-like object where mutter/debug output is currently sent. Can be
94
# changed by _push_log_file etc. This is directly manipulated by some
95
# external code; maybe there should be functions to do that more precisely
96
# than push/pop_log_file.
99
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
100
# redirected elsewhere. Used to show the location in --version.
101
_bzr_log_filename = None
103
# The time the first message was written to the trace file, so that we can
104
# show relative times since startup.
105
_bzr_log_start_time = bzrlib._start_time
108
# held in a global for quick reference
109
_bzr_logger = logging.getLogger('bzr')
112
def note(*args, **kwargs):
113
"""Output a note to the user.
115
Takes the same parameters as logging.info.
119
# FIXME note always emits utf-8, regardless of the terminal encoding
121
# FIXME: clearing the ui and then going through the abstract logging
122
# framework is whack; we should probably have a logging Handler that
123
# deals with terminal output if needed.
124
ui.ui_factory.clear_term()
125
_bzr_logger.info(*args, **kwargs)
128
def warning(*args, **kwargs):
129
ui.ui_factory.clear_term()
130
_bzr_logger.warning(*args, **kwargs)
133
@deprecated_function(deprecated_in((2, 1, 0)))
134
def info(*args, **kwargs):
135
"""Deprecated: use trace.note instead."""
136
note(*args, **kwargs)
139
@deprecated_function(deprecated_in((2, 1, 0)))
140
def log_error(*args, **kwargs):
141
"""Deprecated: use bzrlib.trace.show_error instead"""
142
_bzr_logger.error(*args, **kwargs)
145
@deprecated_function(deprecated_in((2, 1, 0)))
146
def error(*args, **kwargs):
147
"""Deprecated: use bzrlib.trace.show_error instead"""
148
_bzr_logger.error(*args, **kwargs)
151
def show_error(*args, **kwargs):
152
"""Show an error message to the user.
154
Don't use this for exceptions, use report_exception instead.
156
_bzr_logger.error(*args, **kwargs)
159
def mutter(fmt, *args):
160
if _trace_file is None:
162
# XXX: Don't check this every time; instead anyone who closes the file
163
# ought to deregister it. We can tolerate None.
164
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
167
if isinstance(fmt, unicode):
168
fmt = fmt.encode('utf8')
171
# It seems that if we do ascii % (unicode, ascii) we can
172
# get a unicode cannot encode ascii error, so make sure that "fmt"
173
# is a unicode string
176
if isinstance(arg, unicode):
177
arg = arg.encode('utf8')
178
real_args.append(arg)
179
out = fmt % tuple(real_args)
183
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
184
out = timestamp + out + '\n'
185
_trace_file.write(out)
186
# there's no explicit flushing; the file is typically line buffered.
189
def mutter_callsite(stacklevel, fmt, *args):
190
"""Perform a mutter of fmt and args, logging the call trace.
192
:param stacklevel: The number of frames to show. None will show all
194
:param fmt: The format string to pass to mutter.
195
:param args: A list of substitution variables.
198
if stacklevel is None:
201
limit = stacklevel + 1
202
traceback.print_stack(limit=limit, file=outf)
203
formatted_lines = outf.getvalue().splitlines()
204
formatted_stack = '\n'.join(formatted_lines[:-2])
205
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
72
208
def _rollover_trace_maybe(trace_fname):
76
212
if size <= 4 << 20:
78
214
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)
215
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())
220
def _get_bzr_log_filename():
221
bzr_log = os.environ.get('BZR_LOG')
224
home = os.environ.get('BZR_HOME')
226
if sys.platform == 'win32':
227
from bzrlib import win32utils
228
home = win32utils.get_home_location()
230
home = os.path.expanduser('~')
231
return os.path.join(home, '.bzr.log')
235
"""Open the .bzr.log trace file.
237
If the log is more than a particular length, the old file is renamed to
238
.bzr.log.old and a new file is started. Otherwise, we append to the
241
This sets the global _bzr_log_filename.
243
global _bzr_log_filename
245
def _open_or_create_log_file(filename):
246
"""Open existing log file, or create with ownership and permissions
248
It inherits the ownership and permissions (masked by umask) from
249
the containing directory to cope better with being run under sudo
250
with $HOME still set to the user's homedir.
252
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
255
fd = os.open(filename, flags)
258
if e.errno != errno.ENOENT:
261
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
263
if e.errno != errno.EEXIST:
266
osutils.copy_ownership_from_path(filename)
268
return os.fdopen(fd, 'at', 0) # unbuffered
271
_bzr_log_filename = _get_bzr_log_filename()
272
_rollover_trace_maybe(_bzr_log_filename)
274
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
275
bzr_log_file.write('\n')
276
if bzr_log_file.tell() <= 2:
277
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
278
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
279
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
283
except EnvironmentError, e:
284
# If we are failing to open the log, then most likely logging has not
285
# been set up yet. So we just write to stderr rather than using
286
# 'warning()'. If we using warning(), users get the unhelpful 'no
287
# handlers registered for "bzr"' when something goes wrong on the
288
# server. (bug #503886)
289
sys.stderr.write("failed to open trace file: %s\n" % (e,))
290
# TODO: What should happen if we fail to open the trace file? Maybe the
291
# objects should be pointed at /dev/null or the equivalent? Currently
292
# returns None which will cause failures later.
296
def enable_default_logging():
297
"""Configure default logging: messages to stderr and debug to .bzr.log
299
This should only be called once per process.
301
Non-command-line programs embedding bzrlib do not need to call this. They
302
can instead either pass a file to _push_log_file, or act directly on
303
logging.getLogger("bzr").
305
Output can be redirected away by calling _push_log_file.
307
:return: A memento from push_log_file for restoring the log state.
309
start_time = osutils.format_local_date(_bzr_log_start_time,
311
# create encoded wrapper around stderr
312
bzr_log_file = _open_bzr_log()
313
if bzr_log_file is not None:
314
bzr_log_file.write(start_time.encode('utf-8') + '\n')
315
memento = push_log_file(bzr_log_file,
316
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
317
r'%Y-%m-%d %H:%M:%S')
318
# after hooking output into bzr_log, we also need to attach a stderr
319
# handler, writing only at level info and with encoding
320
term_encoding = osutils.get_terminal_encoding()
321
writer_factory = codecs.getwriter(term_encoding)
322
encoded_stderr = writer_factory(sys.stderr, errors='replace')
323
stderr_handler = logging.StreamHandler(encoded_stderr)
324
stderr_handler.setLevel(logging.INFO)
325
logging.getLogger('bzr').addHandler(stderr_handler)
329
def push_log_file(to_file, log_format=None, date_format=None):
330
"""Intercept log and trace messages and send them to a file.
332
:param to_file: A file-like object to which messages will be sent.
334
:returns: A memento that should be passed to _pop_log_file to restore the
335
previously active logging.
339
new_handler = logging.StreamHandler(to_file)
340
new_handler.setLevel(logging.DEBUG)
341
if log_format is None:
342
log_format = '%(levelname)8s %(message)s'
343
new_handler.setFormatter(logging.Formatter(log_format, date_format))
344
# save and remove any existing log handlers
345
bzr_logger = logging.getLogger('bzr')
346
old_handlers = bzr_logger.handlers[:]
347
del bzr_logger.handlers[:]
348
# set that as the default logger
349
bzr_logger.addHandler(new_handler)
350
bzr_logger.setLevel(logging.DEBUG)
351
# TODO: check if any changes are needed to the root logger
353
# TODO: also probably need to save and restore the level on bzr_logger.
354
# but maybe we can avoid setting the logger level altogether, and just set
355
# the level on the handler?
357
# save the old trace file
358
old_trace_file = _trace_file
359
# send traces to the new one
360
_trace_file = to_file
361
result = new_handler, _trace_file
362
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
365
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
366
"""Undo changes to logging/tracing done by _push_log_file.
368
This flushes, but does not close the trace file (so that anything that was
371
Takes the memento returned from _push_log_file."""
373
_trace_file = old_trace_file
374
bzr_logger = logging.getLogger('bzr')
375
bzr_logger.removeHandler(new_handler)
376
# must be closed, otherwise logging will try to close it at exit, and the
377
# file will likely already be closed underneath.
379
bzr_logger.handlers = old_handlers
380
if new_trace_file is not None:
381
new_trace_file.flush()
384
def log_exception_quietly():
385
"""Log the last exception to the trace file only.
387
Used for exceptions that occur internally and that may be
388
interesting to developers but not to users. For example,
389
errors loading plugins.
391
mutter(traceback.format_exc())
394
def set_verbosity_level(level):
395
"""Set the verbosity level.
397
:param level: -ve for quiet, 0 for normal, +ve for verbose
399
global _verbosity_level
400
_verbosity_level = level
401
_update_logging_level(level < 0)
402
ui.ui_factory.be_quiet(level < 0)
405
def get_verbosity_level():
406
"""Get the verbosity level.
408
See set_verbosity_level() for values.
410
return _verbosity_level
413
def be_quiet(quiet=True):
415
set_verbosity_level(-1)
417
set_verbosity_level(0)
420
def _update_logging_level(quiet=True):
421
"""Hide INFO messages if quiet."""
423
_bzr_logger.setLevel(logging.WARNING)
425
_bzr_logger.setLevel(logging.INFO)
429
"""Is the verbosity level negative?"""
430
return _verbosity_level < 0
434
"""Is the verbosity level positive?"""
435
return _verbosity_level > 0
438
def debug_memory(message='', short=True):
439
"""Write out a memory dump."""
440
if sys.platform == 'win32':
441
from bzrlib import win32utils
442
win32utils.debug_memory_win32api(message=message, short=short)
444
_debug_memory_proc(message=message, short=short)
447
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
449
def _debug_memory_proc(message='', short=True):
451
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
455
status = status_file.read()
460
for line in status.splitlines():
464
for field in _short_fields:
465
if line.startswith(field):
469
def _dump_memory_usage(err_file):
472
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
473
dump_file = os.fdopen(fd, 'w')
474
from meliae import scanner
475
scanner.dump_gc_objects(dump_file)
476
err_file.write("Memory dumped to %s\n" % name)
478
err_file.write("Dumping memory requires meliae module.\n")
479
log_exception_quietly()
481
err_file.write("Exception while dumping memory.\n")
482
log_exception_quietly()
484
if dump_file is not None:
490
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
491
"""Give name of error class including module for non-builtin exceptions
493
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
494
also omit the module prefix.
496
class_name = eclass.__name__
497
module_name = eclass.__module__
498
if module_name in ("exceptions", "__main__") or (
499
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
501
return "%s.%s" % (module_name, class_name)
504
def report_exception(exc_info, err_file):
505
"""Report an exception to err_file (typically stderr) and to .bzr.log.
507
This will show either a full traceback or a short message as appropriate.
509
:return: The appropriate exit code for this error.
511
# Log the full traceback to ~/.bzr.log
512
log_exception_quietly()
513
if 'error' in debug.debug_flags:
514
print_exception(exc_info, err_file)
515
return errors.EXIT_ERROR
516
exc_type, exc_object, exc_tb = exc_info
517
if (isinstance(exc_object, IOError)
518
and getattr(exc_object, 'errno', None) == errno.EPIPE):
519
err_file.write("bzr: broken pipe\n")
520
return errors.EXIT_ERROR
521
elif isinstance(exc_object, KeyboardInterrupt):
522
err_file.write("bzr: interrupted\n")
523
return errors.EXIT_ERROR
524
elif isinstance(exc_object, MemoryError):
525
err_file.write("bzr: out of memory\n")
526
if 'mem_dump' in debug.debug_flags:
527
_dump_memory_usage(err_file)
529
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
530
return errors.EXIT_ERROR
531
elif isinstance(exc_object, ImportError) \
532
and str(exc_object).startswith("No module named "):
533
report_user_error(exc_info, err_file,
534
'You may need to install this Python library separately.')
535
return errors.EXIT_ERROR
536
elif not getattr(exc_object, 'internal_error', True):
537
report_user_error(exc_info, err_file)
538
return errors.EXIT_ERROR
539
elif isinstance(exc_object, (OSError, IOError)) or (
540
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
541
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
542
# Might be nice to catch all of these and show them as something more
543
# specific, but there are too many cases at the moment.
544
report_user_error(exc_info, err_file)
545
return errors.EXIT_ERROR
547
report_bug(exc_info, err_file)
548
return errors.EXIT_INTERNAL_ERROR
551
def print_exception(exc_info, err_file):
552
exc_type, exc_object, exc_tb = exc_info
553
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
554
exc_type.__module__, exc_type.__name__, exc_object))
556
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
559
# TODO: Should these be specially encoding the output?
560
def report_user_error(exc_info, err_file, advice=None):
561
"""Report to err_file an error that's not an internal error.
563
These don't get a traceback unless -Derror was given.
565
:param exc_info: 3-tuple from sys.exc_info()
566
:param advice: Extra advice to the user to be printed following the
569
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
571
err_file.write("%s\n" % (advice,))
574
def report_bug(exc_info, err_file):
575
"""Report an exception that probably indicates a bug in bzr"""
576
from bzrlib.crash import report_bug
577
report_bug(exc_info, err_file)
580
def _flush_stdout_stderr():
581
# called from the bzrlib library finalizer returned by bzrlib.initialize()
126
585
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'):
587
if e.errno in [errno.EINVAL, errno.EPIPE]:
594
# called from the bzrlib library finalizer returned by bzrlib.initialize()
600
class Config(object):
601
"""Configuration of message tracing in bzrlib.
603
This implements the context manager protocol and should manage any global
604
variables still used. The default config used is DefaultConfig, but
605
embedded uses of bzrlib may wish to use a custom manager.
609
return self # This is bound to the 'as' clause in a with statement.
611
def __exit__(self, exc_type, exc_val, exc_tb):
612
return False # propogate exceptions.
615
class DefaultConfig(Config):
616
"""A default configuration for tracing of messages in bzrlib.
618
This implements the context manager protocol.
622
self._original_filename = _bzr_log_filename
623
self._original_state = enable_default_logging()
624
return self # This is bound to the 'as' clause in a with statement.
626
def __exit__(self, exc_type, exc_val, exc_tb):
627
pop_log_file(self._original_state)
628
global _bzr_log_filename
629
_bzr_log_filename = self._original_filename
630
return False # propogate exceptions.
added
removed
bzrlib/trace.py
