13
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
16
"""Messages and logging for bazaar-ng
29
Nothing is actually logged unless you call bzrlib.open_tracefile().
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
######################################################################
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):
56
_tracefile.write(_logprefix + msg + '\n')
60
sys.stderr.write('bzr: warning: ' + msg + '\n')
61
_write_trace('warning: ' + msg)
68
b = '* ' + str(msg) + '\n'
71
_write_trace('note: ' + msg)
75
sys.stderr.write(msg + '\n')
30
# TODO: in debug mode, stderr should get full tracebacks and also
31
# 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.
36
# FIXME: Unfortunately it turns out that python's logging module
37
# is quite expensive, even when the message is not printed by any handlers.
38
# We should perhaps change back to just simply doing it here.
48
_stderr_handler = None
51
class QuietFormatter(logging.Formatter):
52
"""Formatter that supresses the details of errors.
54
This is used by default on stderr so as not to scare the user.
56
# At first I tried overriding formatException to suppress the
57
# exception details, but that has global effect: no loggers
58
# can get the exception details is we suppress them here.
60
def format(self, record):
61
if record.levelno >= logging.WARNING:
62
s = 'bzr: ' + record.levelname + ': '
66
s += record.getMessage()
69
##s = textwrap.fill(s)
72
# give just a summary of the exception, not the whole thing
73
exinfo = traceback.extract_tb(record.exc_info[2])
74
# the format of this string matches one of the REs
76
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
77
s += ' see ~/.bzr.log for debug information'
85
# configure convenient aliases for output routines
87
_bzr_logger = logging.getLogger('bzr')
88
_bzr_logger.setLevel(logging.DEBUG)
90
info = note = _bzr_logger.info
91
warning = _bzr_logger.warning
92
log_error = _bzr_logger.error
93
error = _bzr_logger.error
94
mutter = _bzr_logger.debug
95
debug = _bzr_logger.debug
100
# we do the rollover using this code, rather than the default from python
101
# logging, because we only want to rollover at program startup, not on each
102
# message. maybe that's not a good enough reason.
79
104
def _rollover_trace_maybe(trace_fname):
85
110
old_fname = trace_fname + '.old'
88
# must remove before rename on windows
112
from osutils import rename
113
rename(trace_fname, old_fname)
94
# might fail if in use on windows
95
os.rename(trace_fname, old_fname)
103
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
120
def open_tracefile(tracefilename='~/.bzr.log'):
104
121
# Messages are always written to here, so that we have some
105
122
# information if something goes wrong. In a future version this
106
123
# file will be removed on successful completion.
107
global _starttime, _tracefile
108
125
import stat, codecs
110
_starttime = os.times()[4]
112
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
113
128
_rollover_trace_maybe(trace_fname)
115
130
# buffering=1 means line buffered
117
_tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
120
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
121
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
122
t.write("you can delete or truncate this file, or include sections in\n")
123
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
126
_write_trace('bzr %s invoked on python %s (%s)'
127
% (bzrlib.__version__,
128
'.'.join(map(str, sys.version_info)),
131
_write_trace(' arguments: %r' % argv)
132
_write_trace(' working dir: ' + os.getcwdu())
132
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
134
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
135
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
tf.write("you can delete or truncate this file, or include sections in\n")
137
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
139
_file_handler = logging.StreamHandler(tf)
140
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
datefmt = r'%a %H:%M:%S'
142
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
_file_handler.setLevel(logging.DEBUG)
144
logging.getLogger('').addHandler(_file_handler)
133
146
except IOError, e:
134
147
warning("failed to open trace file: %s" % (e))
138
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
139
% (times[:4] + ((times[4] - _starttime),)))
144
"""Log the last exception into the trace file."""
146
s = cgitb.text(sys.exc_info())
147
for l in s.split('\n'):
150
def log_startup(argv):
153
debug('bzr %s invoked on python %s (%s)',
155
'.'.join(map(str, sys.version_info)),
158
debug(' arguments: %r', argv)
159
debug(' working dir: %r', os.getcwdu())
162
def log_exception(msg=None):
163
"""Log the last exception into the trace file.
165
The exception string representation is used as the error
166
summary, unless msg is given.
168
cmd_repr = ' '.join(repr(arg) for arg in sys.argv)
169
cmd_info = '\n command: %s\n pwd: %s' \
170
% (cmd_repr, os.getcwd())
174
if msg and (msg[-1] == '\n'):
176
## msg = "(%s) %s" % (str(type(ei[1])), msg)
177
_bzr_logger.exception(msg + cmd_info)
181
def enable_default_logging():
182
"""Configure default logging to stderr and .bzr.log"""
183
global _stderr_handler, _file_handler
185
_stderr_handler = logging.StreamHandler()
186
_stderr_handler.setFormatter(QuietFormatter())
188
if not _file_handler:
191
if os.environ.get('BZR_DEBUG'):
192
level = logging.DEBUG
196
_stderr_handler.setLevel(logging.INFO)
197
_file_handler.setLevel(level)
199
logging.getLogger('').addHandler(_stderr_handler)
202
def disable_default_logging():
203
"""Turn off default log handlers.
205
This is intended to be used by the test framework, which doesn't
206
want leakage from the code-under-test into the main logs.
209
l = logging.getLogger('')
210
l.removeHandler(_stderr_handler)
212
l.removeHandler(_file_handler)
added
removed
bzrlib/trace.py
