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 BzrNewError
51
43
_file_handler = None
52
44
_stderr_handler = None
57
47
class QuietFormatter(logging.Formatter):
58
48
"""Formatter that supresses the details of errors.
68
58
s = 'bzr: ' + record.levelname + ': '
71
62
s += record.getMessage()
65
##s = textwrap.fill(s)
72
67
if record.exc_info:
73
s += '\n' + format_exception_short(record.exc_info)
68
# give just a summary of the exception, not the whole thing
69
exinfo = traceback.extract_tb(record.exc_info[2])
70
# the format of this string matches one of the REs
72
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
73
s += ' see ~/.bzr.log for debug information'
76
81
# configure convenient aliases for output routines
78
83
_bzr_logger = logging.getLogger('bzr')
84
_bzr_logger.setLevel(logging.DEBUG)
80
86
info = note = _bzr_logger.info
81
87
warning = _bzr_logger.warning
82
88
log_error = _bzr_logger.error
83
89
error = _bzr_logger.error
86
def mutter(fmt, *args):
87
if _trace_file is None:
89
if hasattr(_trace_file, 'closed') and _trace_file.closed:
96
if isinstance(out, unicode):
97
out = out.encode('utf-8')
98
_trace_file.write(out)
90
mutter = _bzr_logger.debug
91
debug = _bzr_logger.debug
96
# we do the rollover using this code, rather than the default from python
97
# logging, because we only want to rollover at program startup, not on each
98
# message. maybe that's not a good enough reason.
102
100
def _rollover_trace_maybe(trace_fname):
106
104
if size <= 4 << 20:
108
106
old_fname = trace_fname + '.old'
109
108
from osutils import rename
110
109
rename(trace_fname, old_fname)
115
116
def open_tracefile(tracefilename='~/.bzr.log'):
116
117
# Messages are always written to here, so that we have some
117
118
# information if something goes wrong. In a future version this
118
119
# file will be removed on successful completion.
119
global _file_handler, _bzr_log_file
120
121
import stat, codecs
122
123
trace_fname = os.path.join(os.path.expanduser(tracefilename))
123
124
_rollover_trace_maybe(trace_fname)
126
# buffering=1 means line buffered
126
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
128
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
130
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
129
131
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
130
132
tf.write("you can delete or truncate this file, or include sections in\n")
131
133
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
132
135
_file_handler = logging.StreamHandler(tf)
133
136
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
134
137
datefmt = r'%a %H:%M:%S'
135
138
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
136
139
_file_handler.setLevel(logging.DEBUG)
137
140
logging.getLogger('').addHandler(_file_handler)
138
142
except IOError, e:
139
143
warning("failed to open trace file: %s" % (e))
142
146
def log_startup(argv):
143
debug('\n\nbzr %s invoked on python %s (%s)',
149
debug('bzr %s invoked on python %s (%s)',
144
150
bzrlib.__version__,
145
151
'.'.join(map(str, sys.version_info)),
147
154
debug(' arguments: %r', argv)
148
debug(' working dir: %r', os.getcwdu())
155
debug(' working dir: %s', os.getcwdu())
151
158
def log_exception(msg=None):
152
"""Log the last exception to stderr and the trace file.
159
"""Log the last exception into the trace file.
154
161
The exception string representation is used as the error
155
162
summary, unless msg is given.
160
exc_str = format_exception_short(sys.exc_info())
162
log_exception_quietly()
165
def log_exception_quietly():
166
"""Log the last exception to the trace file only.
168
Used for exceptions that occur internally and that may be
169
interesting to developers but not to users. For example,
170
errors loading plugins.
173
debug(traceback.format_exc())
164
command = ' '.join(repr(arg) for arg in sys.argv)
165
prefix = "command: %s\npwd: %s\n" % (command, os.getcwd())
169
if msg and (msg[-1] == '\n'):
171
## msg = "(%s) %s" % (str(type(ei[1])), msg)
172
_bzr_logger.exception(prefix + msg)
176
176
def enable_default_logging():
177
177
"""Configure default logging to stderr and .bzr.log"""
178
# FIXME: if this is run twice, things get confused
179
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
178
global _stderr_handler, _file_handler
180
180
_stderr_handler = logging.StreamHandler()
181
181
_stderr_handler.setFormatter(QuietFormatter())
182
logging.getLogger('').addHandler(_stderr_handler)
183
_stderr_handler.setLevel(logging.INFO)
184
183
if not _file_handler:
186
_trace_file = _bzr_log_file
188
_file_handler.setLevel(logging.DEBUG)
189
_bzr_logger.setLevel(logging.DEBUG)
193
def be_quiet(quiet=True):
194
global _stderr_handler, _stderr_quiet
196
_stderr_quiet = quiet
198
_stderr_handler.setLevel(logging.WARNING)
186
if os.environ.get('BZR_DEBUG'):
187
level = logging.DEBUG
200
_stderr_handler.setLevel(logging.INFO)
191
_stderr_handler.setLevel(logging.INFO)
192
_file_handler.setLevel(level)
194
logging.getLogger('').addHandler(_stderr_handler)
208
197
def disable_default_logging():
216
205
l.removeHandler(_stderr_handler)
217
206
if _file_handler:
218
207
l.removeHandler(_file_handler)
222
def enable_test_log(to_file):
223
"""Redirect logging to a temporary file for a test"""
224
disable_default_logging()
225
global _test_log_hdlr, _trace_file
226
hdlr = logging.StreamHandler(to_file)
227
hdlr.setLevel(logging.DEBUG)
228
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
229
_bzr_logger.addHandler(hdlr)
230
_bzr_logger.setLevel(logging.DEBUG)
231
_test_log_hdlr = hdlr
232
_trace_file = to_file
235
def disable_test_log():
236
_bzr_logger.removeHandler(_test_log_hdlr)
238
enable_default_logging()
241
def format_exception_short(exc_info):
242
"""Make a short string form of an exception.
244
This is used for display to stderr. It specially handles exception
245
classes without useful string methods.
247
The result has no trailing newline.
249
exc_info - typically an exception from sys.exc_info()
251
exc_type, exc_object, exc_tb = exc_info
254
return '(no exception)'
255
if isinstance(exc_object, BzrNewError):
256
return str(exc_object)
259
tb = traceback.extract_tb(exc_tb)
260
msg = '%s: %s' % (exc_type, exc_object)
264
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
267
return '(error formatting exception of type %s)' % exc_type
added
removed
bzrlib/trace.py
