13
16
# 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.
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.
44
_stderr_handler = None
47
class QuietFormatter(logging.Formatter):
48
"""Formatter that supresses the details of errors.
50
This is used by default on stderr so as not to scare the user.
52
# At first I tried overriding formatException to suppress the
53
# exception details, but that has global effect: no loggers
54
# can get the exception details is we suppress them here.
56
def format(self, record):
58
if record.levelno >= logging.WARNING:
59
s += record.levelname + ': '
61
s += record.getMessage()
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'
77
# configure convenient aliases for output routines
79
_bzr_logger = logging.getLogger('bzr')
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
84
log_error = _bzr_logger.error
85
error = _bzr_logger.error
86
mutter = _bzr_logger.debug
87
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.
19
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
__author__ = "Martin Pool <mbp@canonical.com>"
23
import sys, os, time, socket, stat, codecs
26
######################################################################
27
# messages and logging
29
## TODO: If --verbose is given then write to both stderr and
30
## _tracefile; perhaps replace _tracefile with a tee thing.
32
global _tracefile, _starttime
35
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
38
# If false, notes also go to stdout; should replace this with --silent
43
# TODO: Somehow tie this to the --verbose option?
47
# fix this if we ever fork within python
49
_logprefix = '[%d] ' % _mypid
52
def _write_trace(msg):
53
_tracefile.write(_logprefix + msg + '\n')
57
sys.stderr.write('bzr: warning: ' + msg + '\n')
58
_write_trace('warning: ' + msg)
65
b = '* ' + str(msg) + '\n'
68
_write_trace('note: ' + msg)
72
sys.stderr.write(msg + '\n')
76
# TODO: Something to log exceptions in here.
96
80
def _rollover_trace_maybe(trace_fname):
99
82
size = os.stat(trace_fname)[stat.ST_SIZE]
102
85
old_fname = trace_fname + '.old'
120
def open_tracefile(tracefilename='~/.bzr.log'):
103
def create_tracefile(argv):
104
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
105
# Perhaps that should eventually go into the platform library?
106
# TODO: If the file doesn't exist, add a note describing it.
121
108
# Messages are always written to here, so that we have some
122
109
# information if something goes wrong. In a future version this
123
110
# file will be removed on successful completion.
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
111
global _starttime, _tracefile
113
_starttime = os.times()[4]
115
trace_fname = os.path.join(os.path.expanduser('~/.bzr.log'))
128
116
_rollover_trace_maybe(trace_fname)
130
118
# buffering=1 means line buffered
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)
147
warning("failed to open trace file: %s" % (e))
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: %s', 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.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
179
def enable_default_logging():
180
"""Configure default logging to stderr and .bzr.log"""
181
global _stderr_handler, _file_handler
183
_stderr_handler = logging.StreamHandler()
184
_stderr_handler.setFormatter(QuietFormatter())
186
if not _file_handler:
189
if os.environ.get('BZR_DEBUG'):
190
level = logging.DEBUG
194
_stderr_handler.setLevel(logging.INFO)
195
_file_handler.setLevel(level)
197
logging.getLogger('').addHandler(_stderr_handler)
200
def disable_default_logging():
201
"""Turn off default log handlers.
203
This is intended to be used by the test framework, which doesn't
204
want leakage from the code-under-test into the main logs.
207
l = logging.getLogger('')
208
l.removeHandler(_stderr_handler)
210
l.removeHandler(_file_handler)
119
_tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
122
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
123
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
124
t.write("you can delete or truncate this file, or include sections in\n")
125
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
127
# TODO: If we failed to create the file, perhaps give a warning
128
# but don't abort; send things to /dev/null instead?
130
_write_trace('bzr %s invoked on python %s (%s)'
131
% (bzrlib.__version__,
132
'.'.join(map(str, sys.version_info)),
135
_write_trace(' arguments: %r' % argv)
136
_write_trace(' working dir: ' + os.getcwdu())
141
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
142
% (times[:4] + ((times[4] - _starttime),)))
146
def log_exception(e):
147
import traceback, cStringIO
148
s = cStringIO.StringIO()
149
traceback.print_exc(None, s)
150
for l in s.getvalue().split('\n'):
added
removed
bzrlib/trace.py
