1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
# -*- coding: UTF-8 -*-
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
12
# GNU General Public License for more details.
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
16
# 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
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
65
from bzrlib.lazy_import import lazy_import
66
lazy_import(globals(), """
67
from cStringIO import StringIO
19
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
__author__ = "Martin Pool <mbp@canonical.com>"
23
import sys, os, time, socket, stat, codecs
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
106
_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.
130
log_error = _bzr_logger.error
131
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,)))
26
######################################################################
27
# messages and logging
29
## TODO: If --verbose is given then write to both stderr and
30
## _tracefile; perhaps replace _tracefile with a tee thing.
32
global _tracefile, _starttime
35
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
38
# If false, notes also go to stdout; should replace this with --silent
43
# TODO: Somehow tie this to the --verbose option?
47
# fix this if we ever fork within python
49
_logprefix = '[%d] ' % _mypid
52
def _write_trace(msg):
53
_tracefile.write(_logprefix + msg + '\n')
57
sys.stderr.write('bzr: warning: ' + msg + '\n')
58
_write_trace('warning: ' + msg)
65
b = '* ' + str(msg) + '\n'
68
_write_trace('note: ' + msg)
72
sys.stderr.write(msg + '\n')
76
# TODO: Something to log exceptions in here.
181
80
def _rollover_trace_maybe(trace_fname):
184
82
size = os.stat(trace_fname)[stat.ST_SIZE]
187
85
old_fname = trace_fname + '.old'
188
osutils.rename(trace_fname, old_fname)
88
# must remove before rename on windows
94
# might fail if in use on windows
95
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)
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")
229
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.
235
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
# Do this before we open the log file, so we prevent
247
# get_terminal_encoding() from mutter()ing multiple times
248
term_encoding = osutils.get_terminal_encoding()
249
start_time = osutils.format_local_date(_bzr_log_start_time,
251
# create encoded wrapper around stderr
252
bzr_log_file = _open_bzr_log()
253
bzr_log_file.write(start_time.encode('utf-8') + '\n')
254
push_log_file(bzr_log_file,
255
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
256
r'%Y-%m-%d %H:%M:%S')
257
# after hooking output into bzr_log, we also need to attach a stderr
258
# handler, writing only at level info and with encoding
259
writer_factory = codecs.getwriter(term_encoding)
260
encoded_stderr = writer_factory(sys.stderr, errors='replace')
261
stderr_handler = logging.StreamHandler(encoded_stderr)
262
stderr_handler.setLevel(logging.INFO)
263
logging.getLogger('bzr').addHandler(stderr_handler)
266
def push_log_file(to_file, log_format=None, date_format=None):
267
"""Intercept log and trace messages and send them to a file.
269
:param to_file: A file-like object to which messages will be sent.
271
:returns: A memento that should be passed to _pop_log_file to restore the
272
previously active logging.
276
new_handler = logging.StreamHandler(to_file)
277
new_handler.setLevel(logging.DEBUG)
278
if log_format is None:
279
log_format = '%(levelname)8s %(message)s'
280
new_handler.setFormatter(logging.Formatter(log_format, date_format))
281
# save and remove any existing log handlers
282
bzr_logger = logging.getLogger('bzr')
283
old_handlers = bzr_logger.handlers[:]
284
del bzr_logger.handlers[:]
285
# set that as the default logger
286
bzr_logger.addHandler(new_handler)
287
bzr_logger.setLevel(logging.DEBUG)
288
# TODO: check if any changes are needed to the root logger
290
# TODO: also probably need to save and restore the level on bzr_logger.
291
# but maybe we can avoid setting the logger level altogether, and just set
292
# the level on the handler?
294
# save the old trace file
295
old_trace_file = _trace_file
296
# send traces to the new one
297
_trace_file = to_file
298
result = new_handler, _trace_file
299
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
302
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
303
"""Undo changes to logging/tracing done by _push_log_file.
305
This flushes, but does not close the trace file.
307
Takes the memento returned from _push_log_file."""
309
_trace_file = old_trace_file
310
bzr_logger = logging.getLogger('bzr')
311
bzr_logger.removeHandler(new_handler)
312
# must be closed, otherwise logging will try to close it atexit, and the
313
# file will likely already be closed underneath.
315
bzr_logger.handlers = old_handlers
316
new_trace_file.flush()
319
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
320
def enable_test_log(to_file):
321
"""Redirect logging to a temporary file for a test
323
:returns: an opaque reference that should be passed to disable_test_log
324
after the test completes.
326
return push_log_file(to_file)
329
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
330
def disable_test_log(memento):
331
return pop_log_file(memento)
334
def log_exception_quietly():
335
"""Log the last exception to the trace file only.
337
Used for exceptions that occur internally and that may be
338
interesting to developers but not to users. For example,
339
errors loading plugins.
341
mutter(traceback.format_exc())
344
def set_verbosity_level(level):
345
"""Set the verbosity level.
347
:param level: -ve for quiet, 0 for normal, +ve for verbose
349
global _verbosity_level
350
_verbosity_level = level
351
_update_logging_level(level < 0)
354
def get_verbosity_level():
355
"""Get the verbosity level.
357
See set_verbosity_level() for values.
359
return _verbosity_level
362
def be_quiet(quiet=True):
363
# Perhaps this could be deprecated now ...
365
set_verbosity_level(-1)
367
set_verbosity_level(0)
370
def _update_logging_level(quiet=True):
371
"""Hide INFO messages if quiet."""
373
_bzr_logger.setLevel(logging.WARNING)
375
_bzr_logger.setLevel(logging.INFO)
379
"""Is the verbosity level negative?"""
380
return _verbosity_level < 0
384
"""Is the verbosity level positive?"""
385
return _verbosity_level > 0
388
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
389
def disable_default_logging():
390
"""Turn off default log handlers.
392
Don't call this method, use _push_log_file and _pop_log_file instead.
397
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
399
def debug_memory(message='', short=True):
400
"""Write out a memory dump."""
402
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
406
status = status_file.read()
411
for line in status.splitlines():
415
for field in _short_fields:
416
if line.startswith(field):
421
def report_exception(exc_info, err_file):
422
"""Report an exception to err_file (typically stderr) and to .bzr.log.
424
This will show either a full traceback or a short message as appropriate.
426
:return: The appropriate exit code for this error.
428
exc_type, exc_object, exc_tb = exc_info
429
# Log the full traceback to ~/.bzr.log
430
log_exception_quietly()
431
if (isinstance(exc_object, IOError)
432
and getattr(exc_object, 'errno', None) == errno.EPIPE):
433
err_file.write("bzr: broken pipe\n")
434
return errors.EXIT_ERROR
435
elif isinstance(exc_object, KeyboardInterrupt):
436
err_file.write("bzr: interrupted\n")
437
return errors.EXIT_ERROR
438
elif isinstance(exc_object, ImportError) \
439
and str(exc_object).startswith("No module named "):
440
report_user_error(exc_info, err_file,
441
'You may need to install this Python library separately.')
442
return errors.EXIT_ERROR
443
elif not getattr(exc_object, 'internal_error', True):
444
report_user_error(exc_info, err_file)
445
return errors.EXIT_ERROR
446
elif isinstance(exc_object, (OSError, IOError)):
447
# Might be nice to catch all of these and show them as something more
448
# specific, but there are too many cases at the moment.
449
report_user_error(exc_info, err_file)
450
return errors.EXIT_ERROR
452
report_bug(exc_info, err_file)
453
return errors.EXIT_INTERNAL_ERROR
456
def print_exception(exc_info, err_file):
457
exc_type, exc_object, exc_tb = exc_info
458
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
459
exc_type.__module__, exc_type.__name__, exc_object))
461
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
464
# TODO: Should these be specially encoding the output?
465
def report_user_error(exc_info, err_file, advice=None):
466
"""Report to err_file an error that's not an internal error.
468
These don't get a traceback unless -Derror was given.
470
:param exc_info: 3-tuple from sys.exc_info()
471
:param advice: Extra advice to the user to be printed following the
474
if 'error' in debug.debug_flags:
475
print_exception(exc_info, err_file)
477
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
479
err_file.write("%s\n" % (advice,))
482
def report_bug(exc_info, err_file):
483
"""Report an exception that probably indicates a bug in bzr"""
484
print_exception(exc_info, err_file)
486
err_file.write('bzr %s on python %s (%s)\n' % \
488
bzrlib._format_version_tuple(sys.version_info),
490
err_file.write('arguments: %r\n' % sys.argv)
492
'encoding: %r, fsenc: %r, lang: %r\n' % (
493
osutils.get_user_encoding(), sys.getfilesystemencoding(),
494
os.environ.get('LANG')))
495
err_file.write("plugins:\n")
496
for name, a_plugin in sorted(plugin.plugins().items()):
497
err_file.write(" %-20s %s [%s]\n" %
498
(name, a_plugin.path(), a_plugin.__version__))
501
*** Bazaar has encountered an internal error.
502
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
503
including this traceback, and a description of what you
504
were doing when the error occurred.
103
def create_tracefile(argv):
104
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
105
# Perhaps that should eventually go into the platform library?
106
# TODO: If the file doesn't exist, add a note describing it.
108
# Messages are always written to here, so that we have some
109
# information if something goes wrong. In a future version this
110
# file will be removed on successful completion.
111
global _starttime, _tracefile
113
_starttime = os.times()[4]
115
trace_fname = os.path.join(os.path.expanduser('~/.bzr.log'))
116
_rollover_trace_maybe(trace_fname)
118
# buffering=1 means line buffered
119
_tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
122
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
123
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
124
t.write("you can delete or truncate this file, or include sections in\n")
125
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
127
# TODO: If we failed to create the file, perhaps give a warning
128
# but don't abort; send things to /dev/null instead?
130
_write_trace('bzr %s invoked on python %s (%s)'
131
% (bzrlib.__version__,
132
'.'.join(map(str, sys.version_info)),
135
_write_trace(' arguments: %r' % argv)
136
_write_trace(' working dir: ' + os.getcwdu())
141
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
142
% (times[:4] + ((times[4] - _starttime),)))
146
def log_exception(e):
147
import traceback, cStringIO
148
s = cStringIO.StringIO()
149
traceback.print_exc(None, s)
150
for l in s.getvalue().split('\n'):
added
removed
bzrlib/trace.py
