1
# Copyright (C) 2005, Canonical Ltd
3
"""Messages and logging for bazaar-ng.
5
Messages are supplied by callers as a string-formatting template, plus values
6
to be inserted into it. The actual %-formatting is deferred to the log
7
library so that it doesn't need to be done for messages that won't be emitted.
9
Messages are classified by severity levels: critical, error, warning, info,
12
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
13
such as running the test suite, they can also be redirected away from both of
14
those two places to another location.
16
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
17
This trace file is always in UTF-8, regardless of the user's default encoding,
18
so that we can always rely on writing any message.
20
Output to stderr depends on the mode chosen by the user. By default, messages
21
of info and above are sent out, which results in progress messages such as the
22
list of files processed by add and commit. In quiet mode, only warnings and
23
above are shown. In debug mode, stderr gets debug messages too.
25
Errors that terminate an operation are generally passed back as exceptions;
26
others may be just emitted as messages.
28
Exceptions are reported in a brief form to stderr so as not to look scary.
29
BzrErrors are required to be able to format themselves into a properly
30
explanatory message. This is not true for builtin excexceptions such as
31
KeyError, which typically just str to "0". They're printed in a different
1
# This program is free software; you can redistribute it and/or modify
2
# it under the terms of the GNU General Public License as published by
3
# the Free Software Foundation; either version 2 of the License, or
4
# (at your option) any later version.
6
# This program is distributed in the hope that it will be useful,
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
# GNU General Public License for more details.
11
# You should have received a copy of the GNU General Public License
12
# 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
"""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.
35
30
# TODO: in debug mode, stderr should get full tracebacks and also
36
31
# debug messages. (Is this really needed?)
38
# FIXME: Unfortunately it turns out that python's logging module
39
# is quite expensive, even when the message is not printed by any handlers.
40
# We should perhaps change back to just simply doing it here.
33
# TODO: When running the test suites, we should add an additional
34
# logger that sends messages into the test log file.
48
from bzrlib.errors import BzrError, BzrNewError
51
43
_file_handler = None
52
44
_stderr_handler = None
58
47
class QuietFormatter(logging.Formatter):
65
54
# can get the exception details is we suppress them here.
67
56
def format(self, record):
68
58
if record.levelno >= logging.WARNING:
69
s = 'bzr: ' + record.levelname + ': '
59
s += record.levelname + ': '
72
61
s += record.getMessage()
73
66
if record.exc_info:
74
s += '\n' + format_exception_short(record.exc_info)
67
# give just a summary of the exception, not the whole thing
68
exinfo = traceback.extract_tb(record.exc_info[2])
69
# the format of this string matches one of the REs
71
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
72
s += ' see ~/.bzr.log for debug information'
77
80
# configure convenient aliases for output routines
79
82
_bzr_logger = logging.getLogger('bzr')
83
_bzr_logger.setLevel(logging.DEBUG)
81
85
info = note = _bzr_logger.info
82
86
warning = _bzr_logger.warning
83
87
log_error = _bzr_logger.error
84
88
error = _bzr_logger.error
87
def mutter(fmt, *args):
88
if _trace_file is None:
90
if hasattr(_trace_file, 'closed') and _trace_file.closed:
97
_trace_file.write(out)
89
mutter = _bzr_logger.debug
90
debug = _bzr_logger.debug
95
# we do the rollover using this code, rather than the default from python
96
# logging, because we only want to rollover at program startup, not on each
97
# message. maybe that's not a good enough reason.
101
99
def _rollover_trace_maybe(trace_fname):
105
103
if size <= 4 << 20:
107
105
old_fname = trace_fname + '.old'
108
from osutils import rename
109
rename(trace_fname, old_fname)
108
# must remove before rename on windows
114
# might fail if in use on windows
115
os.rename(trace_fname, old_fname)
114
123
def open_tracefile(tracefilename='~/.bzr.log'):
115
124
# Messages are always written to here, so that we have some
116
125
# information if something goes wrong. In a future version this
117
126
# file will be removed on successful completion.
118
global _file_handler, _bzr_log_file
119
128
import stat, codecs
121
130
trace_fname = os.path.join(os.path.expanduser(tracefilename))
122
131
_rollover_trace_maybe(trace_fname)
133
# buffering=1 means line buffered
125
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
135
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
137
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
128
138
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
129
139
tf.write("you can delete or truncate this file, or include sections in\n")
130
140
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
131
142
_file_handler = logging.StreamHandler(tf)
132
143
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
133
144
datefmt = r'%a %H:%M:%S'
134
145
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
135
146
_file_handler.setLevel(logging.DEBUG)
136
147
logging.getLogger('').addHandler(_file_handler)
137
149
except IOError, e:
138
150
warning("failed to open trace file: %s" % (e))
141
153
def log_startup(argv):
142
debug('\n\nbzr %s invoked on python %s (%s)',
156
debug('bzr %s invoked on python %s (%s)',
143
157
bzrlib.__version__,
144
158
'.'.join(map(str, sys.version_info)),
146
161
debug(' arguments: %r', argv)
147
debug(' working dir: %r', os.getcwdu())
162
debug(' working dir: %s', os.getcwdu())
150
165
def log_exception(msg=None):
151
"""Log the last exception to stderr and the trace file.
166
"""Log the last exception into the trace file.
153
168
The exception string representation is used as the error
154
169
summary, unless msg is given.
159
exc_str = format_exception_short(sys.exc_info())
161
log_exception_quietly()
164
def log_exception_quietly():
165
"""Log the last exception to the trace file only.
167
Used for exceptions that occur internally and that may be
168
interesting to developers but not to users. For example,
169
errors loading plugins.
172
debug(traceback.format_exc())
175
if msg and (msg[-1] == '\n'):
178
_bzr_logger.exception(msg)
175
182
def enable_default_logging():
176
183
"""Configure default logging to stderr and .bzr.log"""
177
# FIXME: if this is run twice, things get confused
178
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
184
global _stderr_handler, _file_handler
179
186
_stderr_handler = logging.StreamHandler()
180
_stderr_handler.setFormatter(QuietFormatter())
188
if not _file_handler:
189
open_tracefile() # also adds it
193
debug_flag = bool(os.environ['BZR_DEBUG'])
198
level = logging.DEBUG
199
fmt = '%(levelname)8s: %(message)s'
200
_stderr_handler.setFormatter(logging.Formatter(fmt))
203
# show only summary of exceptions
204
_stderr_handler.setFormatter(QuietFormatter())
206
_stderr_handler.setLevel(level)
207
_file_handler.setLevel(level)
181
209
logging.getLogger('').addHandler(_stderr_handler)
182
_stderr_handler.setLevel(logging.INFO)
183
if not _file_handler:
185
_trace_file = _bzr_log_file
187
_file_handler.setLevel(logging.DEBUG)
188
_bzr_logger.setLevel(logging.DEBUG)
192
def be_quiet(quiet=True):
193
global _stderr_handler, _stderr_quiet
195
_stderr_quiet = quiet
197
_stderr_handler.setLevel(logging.WARNING)
199
_stderr_handler.setLevel(logging.INFO)
207
213
def disable_default_logging():
215
221
l.removeHandler(_stderr_handler)
216
222
if _file_handler:
217
223
l.removeHandler(_file_handler)
221
def enable_test_log(to_file):
222
"""Redirect logging to a temporary file for a test
224
returns an opaque reference that should be passed to disable_test_log
225
after the test complete.
227
disable_default_logging()
229
hdlr = logging.StreamHandler(to_file)
230
hdlr.setLevel(logging.DEBUG)
231
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
232
_bzr_logger.addHandler(hdlr)
233
_bzr_logger.setLevel(logging.DEBUG)
234
result = hdlr, _trace_file
235
_trace_file = to_file
239
def disable_test_log((test_log_hdlr, old_trace_file)):
240
_bzr_logger.removeHandler(test_log_hdlr)
241
_trace_file = old_trace_file
242
enable_default_logging()
245
def format_exception_short(exc_info):
246
"""Make a short string form of an exception.
248
This is used for display to stderr. It specially handles exception
249
classes without useful string methods.
251
The result has no trailing newline.
253
exc_info - typically an exception from sys.exc_info()
255
exc_type, exc_object, exc_tb = exc_info
258
return '(no exception)'
259
if isinstance(exc_object, (BzrError, BzrNewError)):
260
return str(exc_object)
263
tb = traceback.extract_tb(exc_tb)
264
msg = '%s: %s' % (exc_type, exc_object)
268
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
270
except Exception, formatting_exc:
271
# XXX: is this really better than just letting it run up?
272
return '(error formatting exception of type %s: %s)' \
273
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
