1
# Copyright (C) 2005, 2006 by 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
15
# 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.
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
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.
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.
60
from bzrlib.errors import BzrError, BzrNewError
61
from bzrlib.symbol_versioning import (deprecated_function,
43
65
_file_handler = None
44
66
_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):
57
if record.levelno >= logging.WARNING:
58
s = 'bzr: ' + record.levelname + ': '
62
s += record.getMessage()
65
##s = textwrap.fill(s)
68
# give just a summary of the exception, not the whole thing
69
exinfo = traceback.extract_tb(record.exc_info[2])
70
# the format of this string matches one of the REs
72
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
73
s += ' see ~/.bzr.log for debug information'
81
73
# configure convenient aliases for output routines
83
75
_bzr_logger = logging.getLogger('bzr')
84
_bzr_logger.setLevel(logging.DEBUG)
86
info = note = _bzr_logger.info
87
warning = _bzr_logger.warning
77
def note(*args, **kwargs):
79
bzrlib.ui.ui_factory.clear_term()
80
_bzr_logger.info(*args, **kwargs)
82
def warning(*args, **kwargs):
84
bzrlib.ui.ui_factory.clear_term()
85
_bzr_logger.warning(*args, **kwargs)
88
88
log_error = _bzr_logger.error
89
89
error = _bzr_logger.error
90
mutter = _bzr_logger.debug
91
debug = _bzr_logger.debug
96
# we do the rollover using this code, rather than the default from python
97
# logging, because we only want to rollover at program startup, not on each
98
# message. maybe that's not a good enough reason.
92
def mutter(fmt, *args):
93
if _trace_file is None:
95
if hasattr(_trace_file, 'closed') and _trace_file.closed:
98
# It seems that if we do ascii % (unicode, ascii) we can
99
# get a unicode cannot encode ascii error, so make sure that "fmt"
100
# is a unicode string
101
out = unicode(fmt) % args
106
_trace_file.write(out)
107
except UnicodeError, e:
108
warning('UnicodeError: %s', e)
109
_trace_file.write(repr(out))
110
# TODO: jam 20051227 Consider flushing the trace file to help debugging
100
115
def _rollover_trace_maybe(trace_fname):
104
119
if size <= 4 << 20:
106
121
old_fname = trace_fname + '.old'
108
122
from osutils import rename
109
123
rename(trace_fname, old_fname)
116
128
def open_tracefile(tracefilename='~/.bzr.log'):
117
129
# Messages are always written to here, so that we have some
118
130
# information if something goes wrong. In a future version this
119
131
# file will be removed on successful completion.
132
global _file_handler, _bzr_log_file
123
135
trace_fname = os.path.join(os.path.expanduser(tracefilename))
124
136
_rollover_trace_maybe(trace_fname)
126
# buffering=1 means line buffered
128
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
130
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
139
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
131
142
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
132
143
tf.write("you can delete or truncate this file, or include sections in\n")
133
144
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
135
145
_file_handler = logging.StreamHandler(tf)
136
146
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
137
147
datefmt = r'%a %H:%M:%S'
138
148
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
139
149
_file_handler.setLevel(logging.DEBUG)
140
150
logging.getLogger('').addHandler(_file_handler)
142
151
except IOError, e:
143
152
warning("failed to open trace file: %s" % (e))
146
def log_startup(argv):
149
debug('bzr %s invoked on python %s (%s)',
151
'.'.join(map(str, sys.version_info)),
154
debug(' arguments: %r', argv)
155
debug(' working dir: %s', os.getcwdu())
155
@deprecated_function(zero_nine)
158
156
def log_exception(msg=None):
159
"""Log the last exception into the trace file.
157
"""Log the last exception to stderr and the trace file.
161
159
The exception string representation is used as the error
162
160
summary, unless msg is given.
167
if msg and (msg[-1] == '\n'):
169
## msg = "(%s) %s" % (str(type(ei[1])), msg)
170
_bzr_logger.exception(msg)
165
exc_str = format_exception_short(sys.exc_info())
167
log_exception_quietly()
170
def log_exception_quietly():
171
"""Log the last exception to the trace file only.
173
Used for exceptions that occur internally and that may be
174
interesting to developers but not to users. For example,
175
errors loading plugins.
178
debug(traceback.format_exc())
174
181
def enable_default_logging():
175
182
"""Configure default logging to stderr and .bzr.log"""
176
global _stderr_handler, _file_handler
183
# FIXME: if this is run twice, things get confused
184
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
178
185
_stderr_handler = logging.StreamHandler()
179
_stderr_handler.setFormatter(QuietFormatter())
186
logging.getLogger('').addHandler(_stderr_handler)
187
_stderr_handler.setLevel(logging.INFO)
181
188
if not _file_handler:
184
if os.environ.get('BZR_DEBUG'):
185
level = logging.DEBUG
190
_trace_file = _bzr_log_file
192
_file_handler.setLevel(logging.DEBUG)
193
_bzr_logger.setLevel(logging.DEBUG)
196
def be_quiet(quiet=True):
197
global _stderr_handler, _stderr_quiet
199
_stderr_quiet = quiet
201
_stderr_handler.setLevel(logging.WARNING)
189
_stderr_handler.setLevel(logging.INFO)
190
_file_handler.setLevel(level)
192
logging.getLogger('').addHandler(_stderr_handler)
203
_stderr_handler.setLevel(logging.INFO)
195
211
def disable_default_logging():
203
219
l.removeHandler(_stderr_handler)
204
220
if _file_handler:
205
221
l.removeHandler(_file_handler)
225
def enable_test_log(to_file):
226
"""Redirect logging to a temporary file for a test
228
returns an opaque reference that should be passed to disable_test_log
229
after the test completes.
231
disable_default_logging()
234
hdlr = logging.StreamHandler(to_file)
235
hdlr.setLevel(logging.DEBUG)
236
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
237
_bzr_logger.addHandler(hdlr)
238
_bzr_logger.setLevel(logging.DEBUG)
239
result = hdlr, _trace_file, _trace_depth
240
_trace_file = to_file
245
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
246
_bzr_logger.removeHandler(test_log_hdlr)
247
test_log_hdlr.close()
250
_trace_file = old_trace_file
251
_trace_depth = old_trace_depth
253
enable_default_logging()
256
def report_exception(exc_info, err_file):
257
exc_type, exc_object, exc_tb = exc_info
258
if (isinstance(exc_object, IOError)
259
and getattr(exc_object, 'errno', None) == errno.EPIPE):
260
print >>err_file, "bzr: broken pipe"
261
elif isinstance(exc_object, KeyboardInterrupt):
262
print >>err_file, "bzr: interrupted"
263
elif getattr(exc_object, 'is_user_error', False):
264
report_user_error(exc_info, err_file)
265
elif isinstance(exc_object, (OSError, IOError)):
266
# Might be nice to catch all of these and show them as something more
267
# specific, but there are too many cases at the moment.
268
report_user_error(exc_info, err_file)
270
report_bug(exc_info, err_file)
273
# TODO: Should these be specially encoding the output?
274
def report_user_error(exc_info, err_file):
275
print >>err_file, "bzr: ERROR:", str(exc_info[1])
278
def report_bug(exc_info, err_file):
279
"""Report an exception that probably indicates a bug in bzr"""
281
exc_type, exc_object, exc_tb = exc_info
282
print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
284
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
286
print >>err_file, 'bzr %s on python %s (%s)' % \
288
'.'.join(map(str, sys.version_info)),
290
print >>err_file, 'arguments: %r' % sys.argv
292
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
