79
_stderr_handler = None
86
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
87
# is quiet; >0 is verbose.
80
88
_verbosity_level = 0
90
# File-like object where mutter/debug output is currently sent. Can be
91
# changed by _push_log_file etc. This is directly manipulated by some
92
# external code; maybe there should be functions to do that more precisely
93
# than push/pop_log_file.
96
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
97
# redirected elsewhere. Used to show the location in --version.
84
98
_bzr_log_filename = None
87
# configure convenient aliases for output routines
100
# The time the first message was written to the trace file, so that we can
101
# show relative times since startup.
102
_bzr_log_start_time = bzrlib._start_time
105
# held in a global for quick reference
89
106
_bzr_logger = logging.getLogger('bzr')
92
109
def note(*args, **kwargs):
93
110
# FIXME note always emits utf-8, regardless of the terminal encoding
112
# FIXME: clearing the ui and then going through the abstract logging
113
# framework is whack; we should probably have a logging Handler that
114
# deals with terminal output if needed.
95
116
bzrlib.ui.ui_factory.clear_term()
96
117
_bzr_logger.info(*args, **kwargs)
98
120
def warning(*args, **kwargs):
100
122
bzrlib.ui.ui_factory.clear_term()
101
123
_bzr_logger.warning(*args, **kwargs)
126
# configure convenient aliases for output routines
128
# TODO: deprecate them, have one name for each.
104
130
log_error = _bzr_logger.error
105
131
error = _bzr_logger.error
162
def open_tracefile(tracefilename=None):
163
# Messages are always written to here, so that we have some
164
# information if something goes wrong. In a future version this
165
# file will be removed on successful completion.
166
global _file_handler, _bzr_log_file, _bzr_log_filename
169
if tracefilename is None:
170
if sys.platform == 'win32':
171
from bzrlib import win32utils
172
home = win32utils.get_home_location()
174
home = os.path.expanduser('~')
175
_bzr_log_filename = os.path.join(home, '.bzr.log')
189
def _get_bzr_log_filename():
190
# TODO: should this be overridden by $BZR_HOME?
191
if sys.platform == 'win32':
192
from bzrlib import win32utils
193
home = win32utils.get_home_location()
177
_bzr_log_filename = tracefilename
179
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
195
home = os.path.expanduser('~')
196
return os.path.join(home, '.bzr.log')
200
"""Open the .bzr.log trace file.
202
If the log is more than a particular length, the old file is renamed to
203
.bzr.log.old and a new file is started. Otherwise, we append to the
206
This sets the global _bzr_log_filename.
208
global _bzr_log_filename
209
_bzr_log_filename = _get_bzr_log_filename()
180
210
_rollover_trace_maybe(_bzr_log_filename)
183
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
184
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
186
# tf.tell() on windows always return 0 until some writing done
189
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
190
tf.write("you can delete or truncate this file, or include sections in\n")
191
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
192
_file_handler = logging.StreamHandler(tf)
193
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
194
datefmt = r'%a %H:%M:%S'
195
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
196
_file_handler.setLevel(logging.DEBUG)
197
logging.getLogger('').addHandler(_file_handler)
212
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
213
# bzr_log_file.tell() on windows always return 0 until some writing done
214
bzr_log_file.write('\n')
215
if bzr_log_file.tell() <= 2:
216
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
217
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
218
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
198
220
except IOError, e:
199
221
warning("failed to open trace file: %s" % (e))
222
# TODO: What should happen if we fail to open the trace file? Maybe the
223
# objects should be pointed at /dev/null or the equivalent? Currently
224
# returns None which will cause failures later.
227
def enable_default_logging():
228
"""Configure default logging: messages to stderr and debug to .bzr.log
230
This should only be called once per process.
232
Non-command-line programs embedding bzrlib do not need to call this. They
233
can instead either pass a file to _push_log_file, or act directly on
234
logging.getLogger("bzr").
236
Output can be redirected away by calling _push_log_file.
238
# create encoded wrapper around stderr
239
bzr_log_file = _open_bzr_log()
240
push_log_file(bzr_log_file,
241
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
242
r'%Y-%m-%d %H:%M:%S')
243
# after hooking output into bzr_log, we also need to attach a stderr
244
# handler, writing only at level info and with encoding
245
writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
246
encoded_stderr = writer_factory(sys.stderr, errors='replace')
247
stderr_handler = logging.StreamHandler(encoded_stderr)
248
stderr_handler.setLevel(logging.INFO)
249
logging.getLogger('bzr').addHandler(stderr_handler)
252
def push_log_file(to_file, log_format=None, date_format=None):
253
"""Intercept log and trace messages and send them to a file.
255
:param to_file: A file-like object to which messages will be sent.
257
:returns: A memento that should be passed to _pop_log_file to restore the
258
previously active logging.
262
new_handler = logging.StreamHandler(to_file)
263
new_handler.setLevel(logging.DEBUG)
264
if log_format is None:
265
log_format = '%(levelname)8s %(message)s'
266
new_handler.setFormatter(logging.Formatter(log_format, date_format))
267
# save and remove any existing log handlers
268
bzr_logger = logging.getLogger('bzr')
269
old_handlers = bzr_logger.handlers[:]
270
del bzr_logger.handlers[:]
271
# set that as the default logger
272
bzr_logger.addHandler(new_handler)
273
bzr_logger.setLevel(logging.DEBUG)
274
# TODO: check if any changes are needed to the root logger
276
# TODO: also probably need to save and restore the level on bzr_logger.
277
# but maybe we can avoid setting the logger level altogether, and just set
278
# the level on the handler?
280
# save the old trace file
281
old_trace_file = _trace_file
282
# send traces to the new one
283
_trace_file = to_file
284
result = new_handler, _trace_file
285
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
288
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
289
"""Undo changes to logging/tracing done by _push_log_file.
291
This flushes, but does not close the trace file.
293
Takes the memento returned from _push_log_file."""
294
assert magic == 'log_memento'
296
_trace_file = old_trace_file
297
bzr_logger = logging.getLogger('bzr')
298
bzr_logger.removeHandler(new_handler)
299
# must be closed, otherwise logging will try to close it atexit, and the
300
# file will likely already be closed underneath.
302
bzr_logger.handlers = old_handlers
303
new_trace_file.flush()
306
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
307
def enable_test_log(to_file):
308
"""Redirect logging to a temporary file for a test
310
:returns: an opaque reference that should be passed to disable_test_log
311
after the test completes.
313
return push_log_file(to_file)
316
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
317
def disable_test_log(memento):
318
return pop_log_file(memento)
202
321
def log_exception_quietly():
272
372
return _verbosity_level > 0
375
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
275
376
def disable_default_logging():
276
377
"""Turn off default log handlers.
278
This is intended to be used by the test framework, which doesn't
279
want leakage from the code-under-test into the main logs.
282
l = logging.getLogger('')
283
l.removeHandler(_stderr_handler)
285
l.removeHandler(_file_handler)
289
def enable_test_log(to_file):
290
"""Redirect logging to a temporary file for a test
292
returns an opaque reference that should be passed to disable_test_log
293
after the test completes.
295
disable_default_logging()
298
hdlr = logging.StreamHandler(to_file)
299
hdlr.setLevel(logging.DEBUG)
300
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
301
_bzr_logger.addHandler(hdlr)
302
_bzr_logger.setLevel(logging.DEBUG)
303
result = hdlr, _trace_file, _trace_depth
304
_trace_file = to_file
309
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
310
_bzr_logger.removeHandler(test_log_hdlr)
311
test_log_hdlr.close()
314
_trace_file = old_trace_file
315
_trace_depth = old_trace_depth
317
enable_default_logging()
379
Don't call this method, use _push_log_file and _pop_log_file instead.
320
384
def report_exception(exc_info, err_file):
added
removed
bzrlib/trace.py
