13
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.
16
"""Messages and logging for bazaar-ng.
18
Messages are supplied by callers as a string-formatting template, plus values
19
to be inserted into it. The actual %-formatting is deferred to the log
20
library so that it doesn't need to be done for messages that won't be emitted.
22
Messages are classified by severity levels: critical, error, warning, info,
25
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
26
such as running the test suite, they can also be redirected away from both of
27
those two places to another location.
29
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
31
Output to stderr depends on the mode chosen by the user. By default, messages
32
of info and above are sent out, which results in progress messages such as the
33
list of files processed by add and commit. In quiet mode, only warnings and
34
above are shown. In debug mode, stderr gets debug messages too.
36
Errors that terminate an operation are generally passed back as exceptions;
37
others may be just emitted as messages.
39
Exceptions are reported in a brief form to stderr so as not to look scary.
40
BzrErrors are required to be able to format themselves into a properly
41
explanatory message. This is not true for builtin excexceptions such as
42
KeyError, which typically just str to "0". They're printed in a different
33
50
# TODO: When running the test suites, we should add an additional
34
51
# logger that sends messages into the test log file.
53
# FIXME: Unfortunately it turns out that python's logging module
54
# is quite expensive, even when the message is not printed by any handlers.
55
# We should perhaps change back to just simply doing it here.
63
from bzrlib.errors import BzrNewError
43
66
_file_handler = None
44
67
_stderr_handler = None
47
69
class QuietFormatter(logging.Formatter):
48
70
"""Formatter that supresses the details of errors.
54
76
# can get the exception details is we suppress them here.
56
78
def format(self, record):
58
79
if record.levelno >= logging.WARNING:
59
s += record.levelname + ': '
61
s += record.getMessage()
80
s = 'bzr: ' + record.levelname + ': '
83
s += record.getMessage()
63
84
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'
85
s += '\n' + format_exception_short(record.exc_info)
77
92
# configure convenient aliases for output routines
79
94
_bzr_logger = logging.getLogger('bzr')
80
_bzr_logger.setLevel(logging.DEBUG)
82
96
info = note = _bzr_logger.info
83
97
warning = _bzr_logger.warning
87
101
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.
96
104
def _rollover_trace_maybe(trace_fname):
100
108
if size <= 4 << 20:
102
110
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)
111
from osutils import rename
112
rename(trace_fname, old_fname)
120
117
def open_tracefile(tracefilename='~/.bzr.log'):
121
118
# Messages are always written to here, so that we have some
122
119
# information if something goes wrong. In a future version this
127
124
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
125
_rollover_trace_maybe(trace_fname)
130
# buffering=1 means line buffered
132
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
128
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
134
130
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
135
131
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
142
138
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
139
_file_handler.setLevel(logging.DEBUG)
144
140
logging.getLogger('').addHandler(_file_handler)
146
141
except IOError, e:
147
142
warning("failed to open trace file: %s" % (e))
150
145
def log_startup(argv):
153
146
debug('bzr %s invoked on python %s (%s)',
154
147
bzrlib.__version__,
155
148
'.'.join(map(str, sys.version_info)),
158
150
debug(' arguments: %r', argv)
159
debug(' working dir: %s', os.getcwdu())
151
debug(' working dir: %r', os.getcwdu())
162
154
def log_exception(msg=None):
163
"""Log the last exception into the trace file.
155
"""Log the last exception to stderr and the trace file.
165
157
The exception string representation is used as the error
166
158
summary, unless msg is given.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
160
exc_str = format_exception_short(sys.exc_info())
162
_bzr_logger.exception(msg)
163
_bzr_logger.error(exc_str)
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():
181
179
global _stderr_handler, _file_handler
183
181
_stderr_handler = logging.StreamHandler()
185
if not _file_handler:
186
open_tracefile() # also adds it
190
debug_flag = bool(os.environ['BZR_DEBUG'])
182
_stderr_handler.setFormatter(QuietFormatter())
183
logging.getLogger('').addHandler(_stderr_handler)
185
if os.environ.get('BZR_DEBUG'):
195
186
level = logging.DEBUG
196
fmt = '%(levelname)8s: %(message)s'
197
_stderr_handler.setFormatter(logging.Formatter(fmt))
199
188
level = logging.INFO
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)
190
_stderr_handler.setLevel(logging.INFO)
192
if not _file_handler:
196
_file_handler.setLevel(level)
198
_bzr_logger.setLevel(level)
210
200
def disable_default_logging():
211
201
"""Turn off default log handlers.
218
208
l.removeHandler(_stderr_handler)
219
209
if _file_handler:
220
210
l.removeHandler(_file_handler)
213
def enable_test_log(to_file):
214
"""Redirect logging to a temporary file for a test"""
215
disable_default_logging()
216
global _test_log_hdlr
217
hdlr = logging.StreamHandler(to_file)
218
hdlr.setLevel(logging.DEBUG)
219
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
220
logging.getLogger('').addHandler(hdlr)
221
logging.getLogger('').setLevel(logging.DEBUG)
222
_test_log_hdlr = hdlr
225
def disable_test_log():
226
logging.getLogger('').removeHandler(_test_log_hdlr)
227
enable_default_logging()
230
def format_exception_short(exc_info):
231
"""Make a short string form of an exception.
233
This is used for display to stderr. It specially handles exception
234
classes without useful string methods.
236
The result has no trailing newline.
238
exc_info - typically an exception from sys.exc_info()
240
exc_type, exc_object, exc_tb = exc_info
243
return '(no exception)'
244
if isinstance(exc_object, BzrNewError):
245
return str(exc_object)
248
tb = traceback.extract_tb(exc_tb)
249
msg = '%s: %s' % (exc_type, exc_object)
253
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
256
return '(error formatting exception of type %s)' % exc_type
added
removed
bzrlib/trace.py
