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
81
info = note = _bzr_logger.info
83
82
warning = _bzr_logger.warning
84
83
log_error = _bzr_logger.error
85
84
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.
87
def mutter(fmt, *args):
88
if _trace_file is None:
90
if hasattr(_trace_file, 'closed') and _trace_file.closed:
97
if isinstance(out, unicode):
98
out = out.encode('utf-8')
99
_trace_file.write(out)
96
103
def _rollover_trace_maybe(trace_fname):
100
107
if size <= 4 << 20:
102
109
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)
110
from osutils import rename
111
rename(trace_fname, old_fname)
120
116
def open_tracefile(tracefilename='~/.bzr.log'):
121
117
# Messages are always written to here, so that we have some
122
118
# information if something goes wrong. In a future version this
123
119
# file will be removed on successful completion.
120
global _file_handler, _bzr_log_file
125
121
import stat, codecs
127
123
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
124
_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:
127
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
135
130
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
131
tf.write("you can delete or truncate this file, or include sections in\n")
137
132
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
139
133
_file_handler = logging.StreamHandler(tf)
140
134
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
135
datefmt = r'%a %H:%M:%S'
142
136
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
137
_file_handler.setLevel(logging.DEBUG)
144
138
logging.getLogger('').addHandler(_file_handler)
146
139
except IOError, e:
147
140
warning("failed to open trace file: %s" % (e))
150
143
def log_startup(argv):
153
debug('bzr %s invoked on python %s (%s)',
144
debug('\n\nbzr %s invoked on python %s (%s)',
154
145
bzrlib.__version__,
155
146
'.'.join(map(str, sys.version_info)),
158
148
debug(' arguments: %r', argv)
159
debug(' working dir: %s', os.getcwdu())
149
debug(' working dir: %r', os.getcwdu())
162
152
def log_exception(msg=None):
163
"""Log the last exception into the trace file.
153
"""Log the last exception to stderr and the trace file.
165
155
The exception string representation is used as the error
166
156
summary, unless msg is given.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
161
exc_str = format_exception_short(sys.exc_info())
163
log_exception_quietly()
166
def log_exception_quietly():
167
"""Log the last exception to the trace file only.
169
Used for exceptions that occur internally and that may be
170
interesting to developers but not to users. For example,
171
errors loading plugins.
174
debug(traceback.format_exc())
179
177
def enable_default_logging():
180
178
"""Configure default logging to stderr and .bzr.log"""
181
global _stderr_handler, _file_handler
179
# FIXME: if this is run twice, things get confused
180
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
183
181
_stderr_handler = logging.StreamHandler()
182
_stderr_handler.setFormatter(QuietFormatter())
183
logging.getLogger('').addHandler(_stderr_handler)
184
_stderr_handler.setLevel(logging.INFO)
185
185
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))
187
_trace_file = _bzr_log_file
189
_file_handler.setLevel(logging.DEBUG)
190
_bzr_logger.setLevel(logging.DEBUG)
194
def be_quiet(quiet=True):
195
global _stderr_handler, _stderr_quiet
197
_stderr_quiet = quiet
199
_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)
201
_stderr_handler.setLevel(logging.INFO)
210
209
def disable_default_logging():
218
217
l.removeHandler(_stderr_handler)
219
218
if _file_handler:
220
219
l.removeHandler(_file_handler)
223
def enable_test_log(to_file):
224
"""Redirect logging to a temporary file for a test"""
225
disable_default_logging()
226
global _test_log_hdlr, _trace_file
227
hdlr = logging.StreamHandler(to_file)
228
hdlr.setLevel(logging.DEBUG)
229
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
230
_bzr_logger.addHandler(hdlr)
231
_bzr_logger.setLevel(logging.DEBUG)
232
_test_log_hdlr = hdlr
233
_trace_file = to_file
236
def disable_test_log():
237
_bzr_logger.removeHandler(_test_log_hdlr)
239
enable_default_logging()
242
def format_exception_short(exc_info):
243
"""Make a short string form of an exception.
245
This is used for display to stderr. It specially handles exception
246
classes without useful string methods.
248
The result has no trailing newline.
250
exc_info - typically an exception from sys.exc_info()
252
exc_type, exc_object, exc_tb = exc_info
255
return '(no exception)'
256
if isinstance(exc_object, (BzrError, BzrNewError)):
257
return str(exc_object)
260
tb = traceback.extract_tb(exc_tb)
261
msg = '%s: %s' % (exc_type, exc_object)
265
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
267
except Exception, formatting_exc:
268
# XXX: is this really better than just letting it run up?
269
return '(error formatting exception of type %s: %s)' \
270
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
