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.
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.
96
def _rollover_trace_maybe(trace_fname):
99
size = os.stat(trace_fname)[stat.ST_SIZE]
102
old_fname = trace_fname + '.old'
104
from osutils import rename
105
rename(trace_fname, old_fname)
112
def open_tracefile(tracefilename='~/.bzr.log'):
113
# Messages are always written to here, so that we have some
114
# information if something goes wrong. In a future version this
115
# file will be removed on successful completion.
119
trace_fname = os.path.join(os.path.expanduser(tracefilename))
120
_rollover_trace_maybe(trace_fname)
122
# buffering=1 means line buffered
124
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
126
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
127
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
128
tf.write("you can delete or truncate this file, or include sections in\n")
129
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
131
_file_handler = logging.StreamHandler(tf)
132
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
133
datefmt = r'%a %H:%M:%S'
134
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
135
_file_handler.setLevel(logging.DEBUG)
136
logging.getLogger('').addHandler(_file_handler)
139
warning("failed to open trace file: %s" % (e))
142
def log_startup(argv):
145
debug('bzr %s invoked on python %s (%s)',
147
'.'.join(map(str, sys.version_info)),
150
debug(' arguments: %r', argv)
151
debug(' working dir: %s', os.getcwdu())
154
def log_exception(msg=None):
155
"""Log the last exception into the trace file.
157
The exception string representation is used as the error
158
summary, unless msg is given.
164
if msg and (msg[-1] == '\n'):
167
_bzr_logger.exception(msg)
171
def enable_default_logging():
172
"""Configure default logging to stderr and .bzr.log"""
173
global _stderr_handler, _file_handler
175
_stderr_handler = logging.StreamHandler()
176
_stderr_handler.setFormatter(QuietFormatter())
178
if not _file_handler:
181
if os.environ.get('BZR_DEBUG'):
182
level = logging.DEBUG
186
_stderr_handler.setLevel(logging.INFO)
187
_file_handler.setLevel(level)
189
logging.getLogger('').addHandler(_stderr_handler)
192
def disable_default_logging():
193
"""Turn off default log handlers.
195
This is intended to be used by the test framework, which doesn't
196
want leakage from the code-under-test into the main logs.
199
l = logging.getLogger('')
200
l.removeHandler(_stderr_handler)
202
l.removeHandler(_file_handler)
added
removed
bzrlib/trace.py
