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.
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.
104
def _rollover_trace_maybe(trace_fname):
107
size = os.stat(trace_fname)[stat.ST_SIZE]
110
old_fname = trace_fname + '.old'
112
from osutils import rename
113
rename(trace_fname, old_fname)
120
def open_tracefile(tracefilename='~/.bzr.log'):
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?
48
b = 'bzr: warning: ' + msg + '\n'
55
_tracefile.write('\n')
58
sys.stderr.write('- ' + msg + '\n')
62
b = '* ' + str(msg) + '\n'
76
def create_tracefile(argv):
77
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
78
# Perhaps that should eventually go into the platform library?
79
# TODO: If the file doesn't exist, add a note describing it.
121
81
# Messages are always written to here, so that we have some
122
82
# information if something goes wrong. In a future version this
123
83
# file will be removed on successful completion.
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
_rollover_trace_maybe(trace_fname)
130
# 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: %r', os.getcwdu())
162
def log_exception(msg=None):
163
"""Log the last exception to stderr and the trace file.
165
The exception string representation is used as the error
166
summary, unless msg is given.
171
if msg and (msg[-1] == '\n'):
173
msg += '\n command: %s' % ' '.join(repr(arg) for arg in sys.argv)
174
msg += '\n pwd: %r' % os.getcwdu()
175
msg += '\n error: %s' % ei[0] # exception type
176
_bzr_logger.exception(msg)
179
def log_exception_quietly():
180
"""Log the last exception to the trace file only.
182
Used for exceptions that occur internally and that may be
183
interesting to developers but not to users. For example,
184
errors loading plugins.
186
debug(traceback.format_exc())
189
def enable_default_logging():
190
"""Configure default logging to stderr and .bzr.log"""
191
global _stderr_handler, _file_handler
193
_stderr_handler = logging.StreamHandler()
194
_stderr_handler.setFormatter(QuietFormatter())
196
if not _file_handler:
199
if os.environ.get('BZR_DEBUG'):
200
level = logging.DEBUG
204
_stderr_handler.setLevel(logging.INFO)
205
_file_handler.setLevel(level)
207
logging.getLogger('').addHandler(_stderr_handler)
210
def disable_default_logging():
211
"""Turn off default log handlers.
213
This is intended to be used by the test framework, which doesn't
214
want leakage from the code-under-test into the main logs.
217
l = logging.getLogger('')
218
l.removeHandler(_stderr_handler)
220
l.removeHandler(_file_handler)
84
global _starttime, _tracefile
86
_starttime = os.times()[4]
88
# XXX: Does this always work on Windows?
89
trace_fname = os.path.join(os.path.expanduser('~/.bzr.log'))
90
_tracefile = codecs.open(trace_fname, 'at', 'utf8')
93
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
94
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
95
t.write("you can delete or truncate this file, or include sections in\n")
96
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
98
# TODO: If we failed to create the file, perhaps give a warning
99
# but don't abort; send things to /dev/null instead?
102
t.write('-' * 60 + '\n')
103
t.write('bzr invoked at %s\n' % bzrlib.osutils.format_date(time.time()))
104
t.write(' version: %s\n' % bzrlib.__version__)
105
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
106
t.write(' arguments: %r\n' % argv)
107
t.write(' working dir: %s\n' % os.getcwdu())
109
t.write(' platform: %s\n' % sys.platform)
110
t.write(' python: %s\n' % (sys.version_info,))
113
atexit.register(_close_trace)
118
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
119
% (times[:4] + ((times[4] - _starttime),)))
added
removed
bzrlib/trace.py
