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
59
47
class QuietFormatter(logging.Formatter):
66
54
# can get the exception details is we suppress them here.
68
56
def format(self, record):
69
58
if record.levelno >= logging.WARNING:
70
s = 'bzr: ' + record.levelname + ': '
73
s += record.getMessage()
59
s += record.levelname + ': '
61
s += record.getMessage()
74
63
if record.exc_info:
75
s += '\n' + format_exception_short(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'
78
77
# configure convenient aliases for output routines
80
79
_bzr_logger = logging.getLogger('bzr')
82
def note(*args, **kwargs):
84
bzrlib.ui.ui_factory.clear_term()
85
_bzr_logger.info(*args, **kwargs)
87
def warning(*args, **kwargs):
89
bzrlib.ui.ui_factory.clear_term()
90
_bzr_logger.warning(*args, **kwargs)
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
93
84
log_error = _bzr_logger.error
94
85
error = _bzr_logger.error
97
def mutter(fmt, *args):
98
if _trace_file is None:
100
if hasattr(_trace_file, 'closed') and _trace_file.closed:
107
_trace_file.write(out)
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.
111
96
def _rollover_trace_maybe(trace_fname):
115
100
if size <= 4 << 20:
117
102
old_fname = trace_fname + '.old'
118
from osutils import rename
119
rename(trace_fname, old_fname)
105
# must remove before rename on windows
111
# might fail if in use on windows
112
os.rename(trace_fname, old_fname)
124
120
def open_tracefile(tracefilename='~/.bzr.log'):
125
121
# Messages are always written to here, so that we have some
126
122
# information if something goes wrong. In a future version this
127
123
# file will be removed on successful completion.
128
global _file_handler, _bzr_log_file
129
125
import stat, codecs
131
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
132
128
_rollover_trace_maybe(trace_fname)
130
# buffering=1 means line buffered
135
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
132
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
134
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
138
135
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
139
136
tf.write("you can delete or truncate this file, or include sections in\n")
140
137
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
141
139
_file_handler = logging.StreamHandler(tf)
142
140
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
143
141
datefmt = r'%a %H:%M:%S'
144
142
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
145
143
_file_handler.setLevel(logging.DEBUG)
146
144
logging.getLogger('').addHandler(_file_handler)
147
146
except IOError, e:
148
147
warning("failed to open trace file: %s" % (e))
151
150
def log_startup(argv):
152
debug('\n\nbzr %s invoked on python %s (%s)',
153
debug('bzr %s invoked on python %s (%s)',
153
154
bzrlib.__version__,
154
155
'.'.join(map(str, sys.version_info)),
156
158
debug(' arguments: %r', argv)
157
debug(' working dir: %r', os.getcwdu())
159
debug(' working dir: %s', os.getcwdu())
160
162
def log_exception(msg=None):
161
"""Log the last exception to stderr and the trace file.
163
"""Log the last exception into the trace file.
163
165
The exception string representation is used as the error
164
166
summary, unless msg is given.
169
exc_str = format_exception_short(sys.exc_info())
171
log_exception_quietly()
174
def log_exception_quietly():
175
"""Log the last exception to the trace file only.
177
Used for exceptions that occur internally and that may be
178
interesting to developers but not to users. For example,
179
errors loading plugins.
182
debug(traceback.format_exc())
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
185
179
def enable_default_logging():
186
180
"""Configure default logging to stderr and .bzr.log"""
187
# FIXME: if this is run twice, things get confused
188
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
181
global _stderr_handler, _file_handler
189
183
_stderr_handler = logging.StreamHandler()
190
_stderr_handler.setFormatter(QuietFormatter())
185
if not _file_handler:
186
open_tracefile() # also adds it
190
debug_flag = bool(os.environ['BZR_DEBUG'])
195
level = logging.DEBUG
198
# show only summary of exceptions
199
_stderr_handler.setFormatter(QuietFormatter())
201
_stderr_handler.setLevel(level)
202
_file_handler.setLevel(level)
191
204
logging.getLogger('').addHandler(_stderr_handler)
192
_stderr_handler.setLevel(logging.INFO)
193
if not _file_handler:
195
_trace_file = _bzr_log_file
197
_file_handler.setLevel(logging.DEBUG)
198
_bzr_logger.setLevel(logging.DEBUG)
202
def be_quiet(quiet=True):
203
global _stderr_handler, _stderr_quiet
205
_stderr_quiet = quiet
207
_stderr_handler.setLevel(logging.WARNING)
209
_stderr_handler.setLevel(logging.INFO)
217
208
def disable_default_logging():
225
216
l.removeHandler(_stderr_handler)
226
217
if _file_handler:
227
218
l.removeHandler(_file_handler)
231
def enable_test_log(to_file):
232
"""Redirect logging to a temporary file for a test
234
returns an opaque reference that should be passed to disable_test_log
235
after the test completes.
237
disable_default_logging()
240
hdlr = logging.StreamHandler(to_file)
241
hdlr.setLevel(logging.DEBUG)
242
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
243
_bzr_logger.addHandler(hdlr)
244
_bzr_logger.setLevel(logging.DEBUG)
245
result = hdlr, _trace_file, _trace_depth
246
_trace_file = to_file
251
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
252
_bzr_logger.removeHandler(test_log_hdlr)
253
test_log_hdlr.close()
256
_trace_file = old_trace_file
257
_trace_depth = old_trace_depth
259
enable_default_logging()
262
def format_exception_short(exc_info):
263
"""Make a short string form of an exception.
265
This is used for display to stderr. It specially handles exception
266
classes without useful string methods.
268
The result has no trailing newline.
270
exc_info - typically an exception from sys.exc_info()
272
exc_type, exc_object, exc_tb = exc_info
275
return '(no exception)'
276
if isinstance(exc_object, (BzrError, BzrNewError)):
277
return str(exc_object)
280
tb = traceback.extract_tb(exc_tb)
281
msg = '%s: %s' % (exc_type, exc_object)
285
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
287
except Exception, formatting_exc:
288
# XXX: is this really better than just letting it run up?
289
return '(error formatting exception of type %s: %s)' \
290
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
