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.
36
49
# FIXME: Unfortunately it turns out that python's logging module
37
50
# is quite expensive, even when the message is not printed by any handlers.
38
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,
47
65
_file_handler = None
48
66
_stderr_handler = None
51
class QuietFormatter(logging.Formatter):
52
"""Formatter that supresses the details of errors.
54
This is used by default on stderr so as not to scare the user.
56
# At first I tried overriding formatException to suppress the
57
# exception details, but that has global effect: no loggers
58
# can get the exception details is we suppress them here.
60
def format(self, record):
61
if record.levelno >= logging.WARNING:
62
s = 'bzr: ' + record.levelname + ': '
66
s += record.getMessage()
69
##s = textwrap.fill(s)
72
# give just a summary of the exception, not the whole thing
73
exinfo = traceback.extract_tb(record.exc_info[2])
74
# the format of this string matches one of the REs
76
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
77
s += ' see ~/.bzr.log for debug information'
85
73
# configure convenient aliases for output routines
87
75
_bzr_logger = logging.getLogger('bzr')
88
_bzr_logger.setLevel(logging.DEBUG)
90
info = note = _bzr_logger.info
91
warning = _bzr_logger.warning
77
def note(*args, **kwargs):
78
# FIXME note always emits utf-8, regardless of the terminal encoding
80
bzrlib.ui.ui_factory.clear_term()
81
_bzr_logger.info(*args, **kwargs)
83
def warning(*args, **kwargs):
85
bzrlib.ui.ui_factory.clear_term()
86
_bzr_logger.warning(*args, **kwargs)
92
89
log_error = _bzr_logger.error
93
90
error = _bzr_logger.error
94
mutter = _bzr_logger.debug
95
debug = _bzr_logger.debug
100
# we do the rollover using this code, rather than the default from python
101
# logging, because we only want to rollover at program startup, not on each
102
# message. maybe that's not a good enough reason.
93
def mutter(fmt, *args):
94
if _trace_file is None:
96
if hasattr(_trace_file, 'closed') and _trace_file.closed:
99
# It seems that if we do ascii % (unicode, ascii) we can
100
# get a unicode cannot encode ascii error, so make sure that "fmt"
101
# is a unicode string
102
out = unicode(fmt) % args
107
_trace_file.write(out)
108
except UnicodeError, e:
109
warning('UnicodeError: %s', e)
110
_trace_file.write(repr(out))
111
# TODO: jam 20051227 Consider flushing the trace file to help debugging
104
116
def _rollover_trace_maybe(trace_fname):
108
120
if size <= 4 << 20:
110
122
old_fname = trace_fname + '.old'
112
123
from osutils import rename
113
124
rename(trace_fname, old_fname)
120
129
def open_tracefile(tracefilename='~/.bzr.log'):
121
130
# Messages are always written to here, so that we have some
122
131
# information if something goes wrong. In a future version this
123
132
# file will be removed on successful completion.
133
global _file_handler, _bzr_log_file
127
136
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
137
_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:
140
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
135
143
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
144
tf.write("you can delete or truncate this file, or include sections in\n")
137
145
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
139
146
_file_handler = logging.StreamHandler(tf)
140
147
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
148
datefmt = r'%a %H:%M:%S'
142
149
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
150
_file_handler.setLevel(logging.DEBUG)
144
151
logging.getLogger('').addHandler(_file_handler)
146
152
except IOError, e:
147
153
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: %r', os.getcwdu())
156
@deprecated_function(zero_nine)
162
157
def log_exception(msg=None):
163
158
"""Log the last exception to stderr and the trace file.
165
160
The exception string representation is used as the error
166
161
summary, unless msg is given.
168
cmd_repr = ' '.join(repr(arg) for arg in sys.argv)
169
cmd_info = '\n command: %s\n pwd: %s' \
170
% (cmd_repr, os.getcwd())
174
if msg and (msg[-1] == '\n'):
176
## msg = "(%s) %s" % (str(type(ei[1])), msg)
177
_bzr_logger.exception(msg + cmd_info)
166
exc_str = format_exception_short(sys.exc_info())
168
log_exception_quietly()
181
171
def log_exception_quietly():
185
175
interesting to developers but not to users. For example,
186
176
errors loading plugins.
188
179
debug(traceback.format_exc())
191
182
def enable_default_logging():
192
183
"""Configure default logging to stderr and .bzr.log"""
193
global _stderr_handler, _file_handler
184
# FIXME: if this is run twice, things get confused
185
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
195
186
_stderr_handler = logging.StreamHandler()
196
_stderr_handler.setFormatter(QuietFormatter())
187
logging.getLogger('').addHandler(_stderr_handler)
188
_stderr_handler.setLevel(logging.INFO)
198
189
if not _file_handler:
201
if os.environ.get('BZR_DEBUG'):
202
level = logging.DEBUG
191
_trace_file = _bzr_log_file
193
_file_handler.setLevel(logging.DEBUG)
194
_bzr_logger.setLevel(logging.DEBUG)
197
def be_quiet(quiet=True):
198
global _stderr_handler, _stderr_quiet
200
_stderr_quiet = quiet
202
_stderr_handler.setLevel(logging.WARNING)
206
_stderr_handler.setLevel(logging.INFO)
207
_file_handler.setLevel(level)
209
logging.getLogger('').addHandler(_stderr_handler)
204
_stderr_handler.setLevel(logging.INFO)
212
212
def disable_default_logging():
220
220
l.removeHandler(_stderr_handler)
221
221
if _file_handler:
222
222
l.removeHandler(_file_handler)
226
def enable_test_log(to_file):
227
"""Redirect logging to a temporary file for a test
229
returns an opaque reference that should be passed to disable_test_log
230
after the test completes.
232
disable_default_logging()
235
hdlr = logging.StreamHandler(to_file)
236
hdlr.setLevel(logging.DEBUG)
237
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
238
_bzr_logger.addHandler(hdlr)
239
_bzr_logger.setLevel(logging.DEBUG)
240
result = hdlr, _trace_file, _trace_depth
241
_trace_file = to_file
246
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
247
_bzr_logger.removeHandler(test_log_hdlr)
248
test_log_hdlr.close()
251
_trace_file = old_trace_file
252
_trace_depth = old_trace_depth
254
enable_default_logging()
257
def report_exception(exc_info, err_file):
258
exc_type, exc_object, exc_tb = exc_info
259
# Log the full traceback to ~/.bzr.log
260
log_exception_quietly()
261
if (isinstance(exc_object, IOError)
262
and getattr(exc_object, 'errno', None) == errno.EPIPE):
263
print >>err_file, "bzr: broken pipe"
264
elif isinstance(exc_object, KeyboardInterrupt):
265
print >>err_file, "bzr: interrupted"
266
elif getattr(exc_object, 'is_user_error', False):
267
report_user_error(exc_info, err_file)
268
elif isinstance(exc_object, (OSError, IOError)):
269
# Might be nice to catch all of these and show them as something more
270
# specific, but there are too many cases at the moment.
271
report_user_error(exc_info, err_file)
273
report_bug(exc_info, err_file)
276
# TODO: Should these be specially encoding the output?
277
def report_user_error(exc_info, err_file):
278
print >>err_file, "bzr: ERROR:", str(exc_info[1])
281
def report_bug(exc_info, err_file):
282
"""Report an exception that probably indicates a bug in bzr"""
284
exc_type, exc_object, exc_tb = exc_info
285
print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
287
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
289
print >>err_file, 'bzr %s on python %s (%s)' % \
291
'.'.join(map(str, sys.version_info)),
293
print >>err_file, 'arguments: %r' % sys.argv
295
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
