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.
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
30
35
# TODO: in debug mode, stderr should get full tracebacks and also
31
36
# 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.
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.
48
from bzrlib.errors import BzrError, BzrNewError
43
51
_file_handler = None
44
52
_stderr_handler = None
47
58
class QuietFormatter(logging.Formatter):
54
65
# can get the exception details is we suppress them here.
56
67
def format(self, record):
58
68
if record.levelno >= logging.WARNING:
59
s += record.levelname + ': '
61
s += record.getMessage()
69
s = 'bzr: ' + record.levelname + ': '
72
s += record.getMessage()
63
73
if record.exc_info:
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'
74
s += '\n' + format_exception_short(record.exc_info)
77
77
# configure convenient aliases for output routines
79
79
_bzr_logger = logging.getLogger('bzr')
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
81
def note(*args, **kwargs):
83
bzrlib.ui.ui_factory.clear_term()
84
_bzr_logger.info(*args, **kwargs)
86
def warning(*args, **kwargs):
88
bzrlib.ui.ui_factory.clear_term()
89
_bzr_logger.warning(*args, **kwargs)
84
92
log_error = _bzr_logger.error
85
93
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.
96
def mutter(fmt, *args):
97
if _trace_file is None:
99
if hasattr(_trace_file, 'closed') and _trace_file.closed:
106
_trace_file.write(out)
96
110
def _rollover_trace_maybe(trace_fname):
100
114
if size <= 4 << 20:
102
116
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)
117
from osutils import rename
118
rename(trace_fname, old_fname)
120
123
def open_tracefile(tracefilename='~/.bzr.log'):
121
124
# Messages are always written to here, so that we have some
122
125
# information if something goes wrong. In a future version this
123
126
# file will be removed on successful completion.
127
global _file_handler, _bzr_log_file
125
128
import stat, codecs
127
130
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
131
_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:
134
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
135
137
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
138
tf.write("you can delete or truncate this file, or include sections in\n")
137
139
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
139
140
_file_handler = logging.StreamHandler(tf)
140
141
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
142
datefmt = r'%a %H:%M:%S'
142
143
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
144
_file_handler.setLevel(logging.DEBUG)
144
145
logging.getLogger('').addHandler(_file_handler)
146
146
except IOError, e:
147
147
warning("failed to open trace file: %s" % (e))
150
150
def log_startup(argv):
153
debug('bzr %s invoked on python %s (%s)',
151
debug('\n\nbzr %s invoked on python %s (%s)',
154
152
bzrlib.__version__,
155
153
'.'.join(map(str, sys.version_info)),
158
155
debug(' arguments: %r', argv)
159
debug(' working dir: %s', os.getcwdu())
156
debug(' working dir: %r', os.getcwdu())
162
159
def log_exception(msg=None):
163
"""Log the last exception into the trace file.
160
"""Log the last exception to stderr and the trace file.
165
162
The exception string representation is used as the error
166
163
summary, unless msg is given.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
168
exc_str = format_exception_short(sys.exc_info())
170
log_exception_quietly()
173
def log_exception_quietly():
174
"""Log the last exception to the trace file only.
176
Used for exceptions that occur internally and that may be
177
interesting to developers but not to users. For example,
178
errors loading plugins.
181
debug(traceback.format_exc())
179
184
def enable_default_logging():
180
185
"""Configure default logging to stderr and .bzr.log"""
181
global _stderr_handler, _file_handler
186
# FIXME: if this is run twice, things get confused
187
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
183
188
_stderr_handler = logging.StreamHandler()
189
_stderr_handler.setFormatter(QuietFormatter())
190
logging.getLogger('').addHandler(_stderr_handler)
191
_stderr_handler.setLevel(logging.INFO)
185
192
if not _file_handler:
186
open_tracefile() # also adds it
190
debug_flag = bool(os.environ['BZR_DEBUG'])
195
level = logging.DEBUG
194
_trace_file = _bzr_log_file
196
_file_handler.setLevel(logging.DEBUG)
197
_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)
198
# show only summary of exceptions
199
_stderr_handler.setFormatter(QuietFormatter())
201
_stderr_handler.setLevel(level)
202
_file_handler.setLevel(level)
204
logging.getLogger('').addHandler(_stderr_handler)
208
_stderr_handler.setLevel(logging.INFO)
208
216
def disable_default_logging():
216
224
l.removeHandler(_stderr_handler)
217
225
if _file_handler:
218
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 complete.
236
disable_default_logging()
238
hdlr = logging.StreamHandler(to_file)
239
hdlr.setLevel(logging.DEBUG)
240
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
241
_bzr_logger.addHandler(hdlr)
242
_bzr_logger.setLevel(logging.DEBUG)
243
result = hdlr, _trace_file
244
_trace_file = to_file
248
def disable_test_log((test_log_hdlr, old_trace_file)):
249
_bzr_logger.removeHandler(test_log_hdlr)
250
test_log_hdlr.close()
251
_trace_file = old_trace_file
252
enable_default_logging()
255
def format_exception_short(exc_info):
256
"""Make a short string form of an exception.
258
This is used for display to stderr. It specially handles exception
259
classes without useful string methods.
261
The result has no trailing newline.
263
exc_info - typically an exception from sys.exc_info()
265
exc_type, exc_object, exc_tb = exc_info
268
return '(no exception)'
269
if isinstance(exc_object, (BzrError, BzrNewError)):
270
return str(exc_object)
273
tb = traceback.extract_tb(exc_tb)
274
msg = '%s: %s' % (exc_type, exc_object)
278
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
280
except Exception, formatting_exc:
281
# XXX: is this really better than just letting it run up?
282
return '(error formatting exception of type %s: %s)' \
283
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
