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
52
_stderr_handler = None
46
58
class QuietFormatter(logging.Formatter):
53
65
# can get the exception details is we suppress them here.
55
67
def format(self, record):
57
68
if record.levelno >= logging.WARNING:
58
s += record.levelname + ': '
60
s += record.getMessage()
69
s = 'bzr: ' + record.levelname + ': '
72
s += record.getMessage()
62
73
if record.exc_info:
63
# give just a summary of the exception, not the whole thing
64
exinfo = traceback.extract_tb(record.exc_info[2])
65
# the format of this string matches one of the REs
67
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
68
s += ' see ~/.bzr.log for debug information'
74
s += '\n' + format_exception_short(record.exc_info)
73
# configure default handler to stderr
75
_stderr_handler = logging.StreamHandler()
76
_stderr_handler.setFormatter(QuietFormatter())
78
if os.environ.get('BZR_DEBUG'):
79
_stderr_handler.setLevel(logging.DEBUG)
81
_stderr_handler.setLevel(logging.INFO)
83
logging.getLogger('').addHandler(_stderr_handler)
88
77
# configure convenient aliases for output routines
90
79
_bzr_logger = logging.getLogger('bzr')
91
_bzr_logger.setLevel(logging.DEBUG)
93
note = _bzr_logger.info
81
info = note = _bzr_logger.info
94
82
warning = _bzr_logger.warning
95
83
log_error = _bzr_logger.error
96
84
error = _bzr_logger.error
97
mutter = _bzr_logger.debug
98
debug = _bzr_logger.debug
103
# we do the rollover using this code, rather than the default from python
104
# logging, because we only want to rollover at program startup, not on each
105
# 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
_trace_file.write(out)
107
101
def _rollover_trace_maybe(trace_fname):
111
105
if size <= 4 << 20:
113
107
old_fname = trace_fname + '.old'
116
# must remove before rename on windows
122
# might fail if in use on windows
123
os.rename(trace_fname, old_fname)
108
from osutils import rename
109
rename(trace_fname, old_fname)
131
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
114
def open_tracefile(tracefilename='~/.bzr.log'):
132
115
# Messages are always written to here, so that we have some
133
116
# information if something goes wrong. In a future version this
134
117
# file will be removed on successful completion.
118
global _file_handler, _bzr_log_file
136
119
import stat, codecs
138
121
trace_fname = os.path.join(os.path.expanduser(tracefilename))
139
122
_rollover_trace_maybe(trace_fname)
141
# buffering=1 means line buffered
143
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
145
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
125
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
146
128
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
147
129
tf.write("you can delete or truncate this file, or include sections in\n")
148
130
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
150
131
_file_handler = logging.StreamHandler(tf)
151
132
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
152
133
datefmt = r'%a %H:%M:%S'
153
134
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
154
135
_file_handler.setLevel(logging.DEBUG)
155
136
logging.getLogger('').addHandler(_file_handler)
159
debug('bzr %s invoked on python %s (%s)'
160
% (bzrlib.__version__,
161
'.'.join(map(str, sys.version_info)),
164
debug(' arguments: %r' % argv)
165
debug(' working dir: ' + os.getcwdu())
166
137
except IOError, e:
167
138
warning("failed to open trace file: %s" % (e))
141
def log_startup(argv):
142
debug('\n\nbzr %s invoked on python %s (%s)',
144
'.'.join(map(str, sys.version_info)),
146
debug(' arguments: %r', argv)
147
debug(' working dir: %r', os.getcwdu())
171
150
def log_exception(msg=None):
172
"""Log the last exception into the trace file.
151
"""Log the last exception to stderr and the trace file.
174
153
The exception string representation is used as the error
175
154
summary, unless msg is given.
184
_bzr_logger.exception(msg)
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
def enable_default_logging():
176
"""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
179
_stderr_handler = logging.StreamHandler()
180
_stderr_handler.setFormatter(QuietFormatter())
181
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
def disable_default_logging():
208
"""Turn off default log handlers.
210
This is intended to be used by the test framework, which doesn't
211
want leakage from the code-under-test into the main logs.
214
l = logging.getLogger('')
215
l.removeHandler(_stderr_handler)
217
l.removeHandler(_file_handler)
221
def enable_test_log(to_file):
222
"""Redirect logging to a temporary file for a test"""
223
disable_default_logging()
224
global _test_log_hdlr, _trace_file
225
hdlr = logging.StreamHandler(to_file)
226
hdlr.setLevel(logging.DEBUG)
227
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
228
_bzr_logger.addHandler(hdlr)
229
_bzr_logger.setLevel(logging.DEBUG)
230
_test_log_hdlr = hdlr
231
_trace_file = to_file
234
def disable_test_log():
235
_bzr_logger.removeHandler(_test_log_hdlr)
237
enable_default_logging()
240
def format_exception_short(exc_info):
241
"""Make a short string form of an exception.
243
This is used for display to stderr. It specially handles exception
244
classes without useful string methods.
246
The result has no trailing newline.
248
exc_info - typically an exception from sys.exc_info()
250
exc_type, exc_object, exc_tb = exc_info
253
return '(no exception)'
254
if isinstance(exc_object, (BzrError, BzrNewError)):
255
return str(exc_object)
258
tb = traceback.extract_tb(exc_tb)
259
msg = '%s: %s' % (exc_type, exc_object)
263
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
265
except Exception, formatting_exc:
266
# XXX: is this really better than just letting it run up?
267
return '(error formatting exception of type %s: %s)' \
268
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
