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.
61
from bzrlib.errors import BzrError, BzrNewError
62
from bzrlib.symbol_versioning import (deprecated_function,
43
66
_file_handler = None
44
67
_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):
58
if record.levelno >= logging.WARNING:
59
s += record.levelname + ': '
61
s += record.getMessage()
64
# give just a summary of the exception, not the whole thing
65
exinfo = traceback.extract_tb(record.exc_info[2])
66
# the format of this string matches one of the REs
68
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
69
s += ' see ~/.bzr.log for debug information'
77
74
# configure convenient aliases for output routines
79
76
_bzr_logger = logging.getLogger('bzr')
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
78
def note(*args, **kwargs):
79
# FIXME note always emits utf-8, regardless of the terminal encoding
81
bzrlib.ui.ui_factory.clear_term()
82
_bzr_logger.info(*args, **kwargs)
84
def warning(*args, **kwargs):
86
bzrlib.ui.ui_factory.clear_term()
87
_bzr_logger.warning(*args, **kwargs)
84
90
log_error = _bzr_logger.error
85
91
error = _bzr_logger.error
86
mutter = _bzr_logger.debug
87
debug = _bzr_logger.debug
92
# we do the rollover using this code, rather than the default from python
93
# logging, because we only want to rollover at program startup, not on each
94
# message. maybe that's not a good enough reason.
94
def mutter(fmt, *args):
95
if _trace_file is None:
97
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
100
if isinstance(fmt, unicode):
101
fmt = fmt.encode('utf8')
104
# It seems that if we do ascii % (unicode, ascii) we can
105
# get a unicode cannot encode ascii error, so make sure that "fmt"
106
# is a unicode string
109
if isinstance(arg, unicode):
110
arg = arg.encode('utf8')
111
real_args.append(arg)
112
out = fmt % tuple(real_args)
116
_trace_file.write(out)
117
# TODO: jam 20051227 Consider flushing the trace file to help debugging
96
122
def _rollover_trace_maybe(trace_fname):
100
126
if size <= 4 << 20:
102
128
old_fname = trace_fname + '.old'
105
# must remove before rename on windows
111
# might fail if in use on windows
112
os.rename(trace_fname, old_fname)
129
from osutils import rename
130
rename(trace_fname, old_fname)
120
135
def open_tracefile(tracefilename='~/.bzr.log'):
121
136
# Messages are always written to here, so that we have some
122
137
# information if something goes wrong. In a future version this
123
138
# file will be removed on successful completion.
139
global _file_handler, _bzr_log_file
127
142
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
143
_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:
146
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
147
tf = open(trace_fname, 'at', LINE_BUFFERED)
135
150
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
151
tf.write("you can delete or truncate this file, or include sections in\n")
137
152
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
139
153
_file_handler = logging.StreamHandler(tf)
140
154
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
155
datefmt = r'%a %H:%M:%S'
142
156
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
157
_file_handler.setLevel(logging.DEBUG)
144
158
logging.getLogger('').addHandler(_file_handler)
146
159
except IOError, e:
147
160
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: %s', os.getcwdu())
163
@deprecated_function(zero_nine)
162
164
def log_exception(msg=None):
163
"""Log the last exception into the trace file.
165
"""Log the last exception to stderr and the trace file.
165
167
The exception string representation is used as the error
166
168
summary, unless msg is given.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
172
log_exception_quietly()
175
def log_exception_quietly():
176
"""Log the last exception to the trace file only.
178
Used for exceptions that occur internally and that may be
179
interesting to developers but not to users. For example,
180
errors loading plugins.
183
debug(traceback.format_exc())
179
186
def enable_default_logging():
180
187
"""Configure default logging to stderr and .bzr.log"""
181
global _stderr_handler, _file_handler
188
# FIXME: if this is run twice, things get confused
189
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
183
190
_stderr_handler = logging.StreamHandler()
191
logging.getLogger('').addHandler(_stderr_handler)
192
_stderr_handler.setLevel(logging.INFO)
185
193
if not _file_handler:
186
open_tracefile() # also adds it
190
debug_flag = bool(os.environ['BZR_DEBUG'])
195
level = logging.DEBUG
196
fmt = '%(levelname)8s: %(message)s'
197
_stderr_handler.setFormatter(logging.Formatter(fmt))
195
_trace_file = _bzr_log_file
197
_file_handler.setLevel(logging.DEBUG)
198
_bzr_logger.setLevel(logging.DEBUG)
201
def be_quiet(quiet=True):
202
global _stderr_handler, _stderr_quiet
204
_stderr_quiet = quiet
206
_stderr_handler.setLevel(logging.WARNING)
200
# show only summary of exceptions
201
_stderr_handler.setFormatter(QuietFormatter())
203
_stderr_handler.setLevel(level)
204
_file_handler.setLevel(level)
206
logging.getLogger('').addHandler(_stderr_handler)
208
_stderr_handler.setLevel(logging.INFO)
210
216
def disable_default_logging():
218
224
l.removeHandler(_stderr_handler)
219
225
if _file_handler:
220
226
l.removeHandler(_file_handler)
230
def enable_test_log(to_file):
231
"""Redirect logging to a temporary file for a test
233
returns an opaque reference that should be passed to disable_test_log
234
after the test completes.
236
disable_default_logging()
239
hdlr = logging.StreamHandler(to_file)
240
hdlr.setLevel(logging.DEBUG)
241
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
242
_bzr_logger.addHandler(hdlr)
243
_bzr_logger.setLevel(logging.DEBUG)
244
result = hdlr, _trace_file, _trace_depth
245
_trace_file = to_file
250
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
251
_bzr_logger.removeHandler(test_log_hdlr)
252
test_log_hdlr.close()
255
_trace_file = old_trace_file
256
_trace_depth = old_trace_depth
258
enable_default_logging()
261
def report_exception(exc_info, err_file):
262
exc_type, exc_object, exc_tb = exc_info
263
# Log the full traceback to ~/.bzr.log
264
log_exception_quietly()
265
if (isinstance(exc_object, IOError)
266
and getattr(exc_object, 'errno', None) == errno.EPIPE):
267
print >>err_file, "bzr: broken pipe"
268
elif isinstance(exc_object, KeyboardInterrupt):
269
print >>err_file, "bzr: interrupted"
270
elif getattr(exc_object, 'is_user_error', False):
271
report_user_error(exc_info, err_file)
272
elif isinstance(exc_object, (OSError, IOError)):
273
# Might be nice to catch all of these and show them as something more
274
# specific, but there are too many cases at the moment.
275
report_user_error(exc_info, err_file)
277
report_bug(exc_info, err_file)
280
# TODO: Should these be specially encoding the output?
281
def report_user_error(exc_info, err_file):
282
print >>err_file, "bzr: ERROR:", str(exc_info[1])
285
def report_bug(exc_info, err_file):
286
"""Report an exception that probably indicates a bug in bzr"""
288
exc_type, exc_object, exc_tb = exc_info
289
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
290
exc_type.__module__, exc_type.__name__, exc_object)
292
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
294
print >>err_file, 'bzr %s on python %s (%s)' % \
296
'.'.join(map(str, sys.version_info)),
298
print >>err_file, 'arguments: %r' % sys.argv
300
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
