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
17
# TODO: Could probably replace this with something based on Python logging
23
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
24
__author__ = "Martin Pool <mbp@canonical.com>"
27
"""Messages and logging for bazaar-ng
29
Nothing is actually logged unless you call bzrlib.open_tracefile().
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
35
######################################################################
36
# messages and logging
38
global _tracefile, _starttime
41
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
44
# If false, notes also go to stdout; should replace this with --silent
49
# fix this if we ever fork within python
51
_logprefix = '[%d] ' % _mypid
54
def _write_trace(msg):
57
_tracefile.write(_logprefix + msg + '\n')
61
sys.stderr.write('bzr: warning: ' + msg + '\n')
62
_write_trace('warning: ' + msg)
69
b = '* ' + str(msg) + '\n'
72
_write_trace('note: ' + msg)
76
sys.stderr.write(msg + '\n')
35
# TODO: in debug mode, stderr should get full tracebacks and also
36
# 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.
48
from bzrlib.errors import BzrError, BzrNewError
52
_stderr_handler = None
58
class QuietFormatter(logging.Formatter):
59
"""Formatter that supresses the details of errors.
61
This is used by default on stderr so as not to scare the user.
63
# At first I tried overriding formatException to suppress the
64
# exception details, but that has global effect: no loggers
65
# can get the exception details is we suppress them here.
67
def format(self, record):
68
if record.levelno >= logging.WARNING:
69
s = 'bzr: ' + record.levelname + ': '
72
s += record.getMessage()
74
s += '\n' + format_exception_short(record.exc_info)
77
# configure convenient aliases for output routines
79
_bzr_logger = logging.getLogger('bzr')
81
info = note = _bzr_logger.info
82
warning = _bzr_logger.warning
83
log_error = _bzr_logger.error
84
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:
98
_trace_file.write(out)
99
except UnicodeError, e:
100
warning('UnicodeError: %s', e)
101
_trace_file.write(repr(out))
102
# TODO: jam 20051227 Consider flushing the trace file to help debugging
80
107
def _rollover_trace_maybe(trace_fname):
84
111
if size <= 4 << 20:
86
113
old_fname = trace_fname + '.old'
89
# must remove before rename on windows
95
# might fail if in use on windows
96
os.rename(trace_fname, old_fname)
114
from osutils import rename
115
rename(trace_fname, old_fname)
104
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
120
def open_tracefile(tracefilename='~/.bzr.log'):
105
121
# Messages are always written to here, so that we have some
106
122
# information if something goes wrong. In a future version this
107
123
# file will be removed on successful completion.
108
global _starttime, _tracefile
124
global _file_handler, _bzr_log_file
109
125
import stat, codecs
111
_starttime = os.times()[4]
113
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
114
128
_rollover_trace_maybe(trace_fname)
116
# buffering=1 means line buffered
118
_tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
121
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
122
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
123
t.write("you can delete or truncate this file, or include sections in\n")
124
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
127
_write_trace('bzr %s invoked on python %s (%s)'
128
% (bzrlib.__version__,
129
'.'.join(map(str, sys.version_info)),
132
_write_trace(' arguments: %r' % argv)
133
_write_trace(' working dir: ' + os.getcwdu())
131
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
134
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
135
tf.write("you can delete or truncate this file, or include sections in\n")
136
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
137
_file_handler = logging.StreamHandler(tf)
138
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
139
datefmt = r'%a %H:%M:%S'
140
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
141
_file_handler.setLevel(logging.DEBUG)
142
logging.getLogger('').addHandler(_file_handler)
134
143
except IOError, e:
135
144
warning("failed to open trace file: %s" % (e))
139
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
140
% (times[:4] + ((times[4] - _starttime),)))
145
"""Log the last exception into the trace file."""
147
s = cgitb.text(sys.exc_info())
148
for l in s.split('\n'):
147
def log_startup(argv):
148
debug('\n\nbzr %s invoked on python %s (%s)',
150
'.'.join(map(str, sys.version_info)),
152
debug(' arguments: %r', argv)
153
debug(' working dir: %r', os.getcwdu())
156
def log_exception(msg=None):
157
"""Log the last exception to stderr and the trace file.
159
The exception string representation is used as the error
160
summary, unless msg is given.
165
exc_str = format_exception_short(sys.exc_info())
167
log_exception_quietly()
170
def log_exception_quietly():
171
"""Log the last exception to the trace file only.
173
Used for exceptions that occur internally and that may be
174
interesting to developers but not to users. For example,
175
errors loading plugins.
178
debug(traceback.format_exc())
181
def enable_default_logging():
182
"""Configure default logging to stderr and .bzr.log"""
183
# FIXME: if this is run twice, things get confused
184
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
185
_stderr_handler = logging.StreamHandler()
186
_stderr_handler.setFormatter(QuietFormatter())
187
logging.getLogger('').addHandler(_stderr_handler)
188
_stderr_handler.setLevel(logging.INFO)
189
if not _file_handler:
191
_trace_file = _bzr_log_file
193
_file_handler.setLevel(logging.DEBUG)
194
_bzr_logger.setLevel(logging.DEBUG)
198
def be_quiet(quiet=True):
199
global _stderr_handler, _stderr_quiet
201
_stderr_quiet = quiet
203
_stderr_handler.setLevel(logging.WARNING)
205
_stderr_handler.setLevel(logging.INFO)
213
def disable_default_logging():
214
"""Turn off default log handlers.
216
This is intended to be used by the test framework, which doesn't
217
want leakage from the code-under-test into the main logs.
220
l = logging.getLogger('')
221
l.removeHandler(_stderr_handler)
223
l.removeHandler(_file_handler)
227
def enable_test_log(to_file):
228
"""Redirect logging to a temporary file for a test"""
229
disable_default_logging()
230
global _test_log_hdlr, _trace_file
231
hdlr = logging.StreamHandler(to_file)
232
hdlr.setLevel(logging.DEBUG)
233
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
234
_bzr_logger.addHandler(hdlr)
235
_bzr_logger.setLevel(logging.DEBUG)
236
_test_log_hdlr = hdlr
237
_trace_file = to_file
240
def disable_test_log():
241
_bzr_logger.removeHandler(_test_log_hdlr)
243
enable_default_logging()
246
def format_exception_short(exc_info):
247
"""Make a short string form of an exception.
249
This is used for display to stderr. It specially handles exception
250
classes without useful string methods.
252
The result has no trailing newline.
254
exc_info - typically an exception from sys.exc_info()
256
exc_type, exc_object, exc_tb = exc_info
259
return '(no exception)'
260
if isinstance(exc_object, (BzrError, BzrNewError)):
261
return str(exc_object)
264
tb = traceback.extract_tb(exc_tb)
265
msg = '%s: %s' % (exc_type, exc_object)
269
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
271
except Exception, formatting_exc:
272
# XXX: is this really better than just letting it run up?
273
return '(error formatting exception of type %s: %s)' \
274
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
