1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging.
19
Messages are supplied by callers as a string-formatting template, plus values
20
to be inserted into it. The actual %-formatting is deferred to the log
21
library so that it doesn't need to be done for messages that won't be emitted.
23
Messages are classified by severity levels: critical, error, warning, info,
26
They can be sent to two places: to stderr, and to ~/.brz.log. For purposes
27
such as running the test suite, they can also be redirected away from both of
28
those two places to another location.
30
~/.brz.log gets all messages, and full tracebacks for uncaught exceptions.
31
This trace file is always in UTF-8, regardless of the user's default encoding,
32
so that we can always rely on writing any message.
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
of info and above are sent out, which results in progress messages such as the
36
list of files processed by add and commit. In debug mode, stderr gets debug messages too.
38
Errors that terminate an operation are generally passed back as exceptions;
39
others may be just emitted as messages.
41
Exceptions are reported in a brief form to stderr so as not to look scary.
42
BzrErrors are required to be able to format themselves into a properly
43
explanatory message. This is not true for builtin exceptions such as
44
KeyError, which typically just str to "0". They're printed in a different
48
from __future__ import absolute_import
50
# FIXME: Unfortunately it turns out that python's logging module
51
# is quite expensive, even when the message is not printed by any handlers.
52
# We should perhaps change back to just simply doing it here.
54
# On the other hand, as of 1.2 we generally only call the mutter() statement
55
# if (according to debug_flags) we actually intend to write it. So the
56
# increased cost of logging.py is not so bad, and we could standardize on
65
from .lazy_import import lazy_import
66
lazy_import(globals(), """
73
lazy_import(globals(), """
89
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
90
# is quiet; >0 is verbose.
93
# File-like object where mutter/debug output is currently sent. Can be
94
# changed by _push_log_file etc. This is directly manipulated by some
95
# external code; maybe there should be functions to do that more precisely
96
# than push/pop_log_file.
99
# Absolute path for ~/.brz.log. Not changed even if the log/trace output is
100
# redirected elsewhere. Used to show the location in --version.
101
_brz_log_filename = None
103
# The time the first message was written to the trace file, so that we can
104
# show relative times since startup.
105
_brz_log_start_time = breezy._start_time
108
# held in a global for quick reference
109
_brz_logger = logging.getLogger('brz')
112
def note(*args, **kwargs):
113
"""Output a note to the user.
115
Takes the same parameters as logging.info.
119
# FIXME: clearing the ui and then going through the abstract logging
120
# framework is whack; we should probably have a logging Handler that
121
# deals with terminal output if needed.
122
ui.ui_factory.clear_term()
123
_brz_logger.info(*args, **kwargs)
126
def warning(*args, **kwargs):
127
ui.ui_factory.clear_term()
128
_brz_logger.warning(*args, **kwargs)
131
def show_error(*args, **kwargs):
132
"""Show an error message to the user.
134
Don't use this for exceptions, use report_exception instead.
136
_brz_logger.error(*args, **kwargs)
140
"""Compat class for displaying bytes on Python 2."""
143
return 'b' + str.__repr__(self)
145
def __unicode__(self):
146
return self.decode('ascii', 'replace')
149
def mutter(fmt, *args):
150
if _trace_file is None:
152
# XXX: Don't check this every time; instead anyone who closes the file
153
# ought to deregister it. We can tolerate None.
154
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
157
# Let format strings be specified as ascii bytes to help Python 2
158
if isinstance(fmt, bytes):
159
fmt = fmt.decode('ascii', 'replace')
164
_Bytes(arg) if isinstance(arg, bytes) else arg for arg in args)
169
out = '%0.3f %s\n' % (now - _brz_log_start_time, out)
170
_trace_file.write(out.encode('utf-8'))
171
# there's no explicit flushing; the file is typically line buffered.
174
def mutter_callsite(stacklevel, fmt, *args):
175
"""Perform a mutter of fmt and args, logging the call trace.
177
:param stacklevel: The number of frames to show. None will show all
179
:param fmt: The format string to pass to mutter.
180
:param args: A list of substitution variables.
183
if stacklevel is None:
186
limit = stacklevel + 1
187
traceback.print_stack(limit=limit, file=outf)
188
formatted_lines = outf.getvalue().splitlines()
189
formatted_stack = '\n'.join(formatted_lines[:-2])
190
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
193
def _rollover_trace_maybe(trace_fname):
196
size = os.stat(trace_fname)[stat.ST_SIZE]
199
old_fname = trace_fname + '.old'
200
osutils.rename(trace_fname, old_fname)
205
def _get_brz_log_filename():
206
brz_log = osutils.path_from_environ('BRZ_LOG')
209
home = osutils.path_from_environ('BRZ_HOME')
211
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
212
# over what would be better. On windows, bug 240550
213
# suggests LOCALAPPDATA be used instead.
214
home = osutils._get_home_dir()
215
return os.path.join(home, '.brz.log')
219
"""Open the .brz.log trace file.
221
If the log is more than a particular length, the old file is renamed to
222
.brz.log.old and a new file is started. Otherwise, we append to the
225
This sets the global _brz_log_filename.
227
global _brz_log_filename
229
def _open_or_create_log_file(filename):
230
"""Open existing log file, or create with ownership and permissions
232
It inherits the ownership and permissions (masked by umask) from
233
the containing directory to cope better with being run under sudo
234
with $HOME still set to the user's homedir.
236
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
239
fd = os.open(filename, flags)
242
if e.errno != errno.ENOENT:
245
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
247
if e.errno != errno.EEXIST:
250
osutils.copy_ownership_from_path(filename)
252
return os.fdopen(fd, 'ab', 0) # unbuffered
254
_brz_log_filename = _get_brz_log_filename()
255
_rollover_trace_maybe(_brz_log_filename)
257
brz_log_file = _open_or_create_log_file(_brz_log_filename)
258
brz_log_file.write(b'\n')
259
if brz_log_file.tell() <= 2:
261
b"this is a debug log for diagnosing/reporting problems in brz\n")
263
b"you can delete or truncate this file, or include sections in\n")
265
b"bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
269
except EnvironmentError as e:
270
# If we are failing to open the log, then most likely logging has not
271
# been set up yet. So we just write to stderr rather than using
272
# 'warning()'. If we using warning(), users get the unhelpful 'no
273
# handlers registered for "brz"' when something goes wrong on the
274
# server. (bug #503886)
275
sys.stderr.write("failed to open trace file: %s\n" % (e,))
276
# TODO: What should happen if we fail to open the trace file? Maybe the
277
# objects should be pointed at /dev/null or the equivalent? Currently
278
# returns None which will cause failures later.
282
def enable_default_logging():
283
"""Configure default logging: messages to stderr and debug to .brz.log
285
This should only be called once per process.
287
Non-command-line programs embedding breezy do not need to call this. They
288
can instead either pass a file to _push_log_file, or act directly on
289
logging.getLogger("brz").
291
Output can be redirected away by calling _push_log_file.
293
:return: A memento from push_log_file for restoring the log state.
295
start_time = osutils.format_local_date(_brz_log_start_time,
297
brz_log_file = _open_brz_log()
298
if brz_log_file is not None:
299
brz_log_file.write(start_time.encode('utf-8') + b'\n')
300
memento = push_log_file(
302
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
303
r'%Y-%m-%d %H:%M:%S')
304
# after hooking output into brz_log, we also need to attach a stderr
305
# handler, writing only at level info and with encoding
306
if sys.version_info[0] == 2:
307
stderr_handler = EncodedStreamHandler(
308
sys.stderr, osutils.get_terminal_encoding(), 'replace',
311
stderr_handler = logging.StreamHandler(stream=sys.stderr)
312
logging.getLogger('brz').addHandler(stderr_handler)
316
def push_log_file(to_file, log_format=None, date_format=None):
317
"""Intercept log and trace messages and send them to a file.
319
:param to_file: A file-like object to which messages will be sent.
321
:returns: A memento that should be passed to _pop_log_file to restore the
322
previously active logging.
326
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
327
if log_format is None:
328
log_format = '%(levelname)8s %(message)s'
329
new_handler.setFormatter(logging.Formatter(log_format, date_format))
330
# save and remove any existing log handlers
331
brz_logger = logging.getLogger('brz')
332
old_handlers = brz_logger.handlers[:]
333
del brz_logger.handlers[:]
334
# set that as the default logger
335
brz_logger.addHandler(new_handler)
336
brz_logger.setLevel(logging.DEBUG)
337
# TODO: check if any changes are needed to the root logger
339
# TODO: also probably need to save and restore the level on brz_logger.
340
# but maybe we can avoid setting the logger level altogether, and just set
341
# the level on the handler?
343
# save the old trace file
344
old_trace_file = _trace_file
345
# send traces to the new one
346
_trace_file = to_file
347
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
350
def pop_log_file(entry):
351
"""Undo changes to logging/tracing done by _push_log_file.
353
This flushes, but does not close the trace file (so that anything that was
356
Takes the memento returned from _push_log_file."""
357
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
359
_trace_file = old_trace_file
360
brz_logger = logging.getLogger('brz')
361
brz_logger.removeHandler(new_handler)
362
# must be closed, otherwise logging will try to close it at exit, and the
363
# file will likely already be closed underneath.
365
brz_logger.handlers = old_handlers
366
if new_trace_file is not None:
367
new_trace_file.flush()
370
def log_exception_quietly():
371
"""Log the last exception to the trace file only.
373
Used for exceptions that occur internally and that may be
374
interesting to developers but not to users. For example,
375
errors loading plugins.
377
mutter(traceback.format_exc())
380
def set_verbosity_level(level):
381
"""Set the verbosity level.
383
:param level: -ve for quiet, 0 for normal, +ve for verbose
385
global _verbosity_level
386
_verbosity_level = level
387
_update_logging_level(level < 0)
388
ui.ui_factory.be_quiet(level < 0)
391
def get_verbosity_level():
392
"""Get the verbosity level.
394
See set_verbosity_level() for values.
396
return _verbosity_level
399
def be_quiet(quiet=True):
401
set_verbosity_level(-1)
403
set_verbosity_level(0)
406
def _update_logging_level(quiet=True):
407
"""Hide INFO messages if quiet."""
409
_brz_logger.setLevel(logging.WARNING)
411
_brz_logger.setLevel(logging.INFO)
415
"""Is the verbosity level negative?"""
416
return _verbosity_level < 0
420
"""Is the verbosity level positive?"""
421
return _verbosity_level > 0
424
def debug_memory(message='', short=True):
425
"""Write out a memory dump."""
426
if sys.platform == 'win32':
427
from breezy import win32utils
428
win32utils.debug_memory_win32api(message=message, short=short)
430
_debug_memory_proc(message=message, short=short)
433
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
436
def _debug_memory_proc(message='', short=True):
438
status_file = open('/proc/%s/status' % os.getpid(), 'rb')
442
status = status_file.read()
447
for line in status.splitlines():
451
for field in _short_fields:
452
if line.startswith(field):
457
def _dump_memory_usage(err_file):
460
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
461
dump_file = os.fdopen(fd, 'w')
462
from meliae import scanner
463
scanner.dump_gc_objects(dump_file)
464
err_file.write("Memory dumped to %s\n" % name)
466
err_file.write("Dumping memory requires meliae module.\n")
467
log_exception_quietly()
468
except BaseException:
469
err_file.write("Exception while dumping memory.\n")
470
log_exception_quietly()
472
if dump_file is not None:
478
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
479
"""Give name of error class including module for non-builtin exceptions
481
If `unqualified_breezy_errors` is True, errors specific to breezy will
482
also omit the module prefix.
484
class_name = eclass.__name__
485
module_name = eclass.__module__
486
if module_name in ("builtins", "exceptions", "__main__") or (
487
unqualified_breezy_errors and module_name == "breezy.errors"):
489
return "%s.%s" % (module_name, class_name)
492
def report_exception(exc_info, err_file):
493
"""Report an exception to err_file (typically stderr) and to .brz.log.
495
This will show either a full traceback or a short message as appropriate.
497
:return: The appropriate exit code for this error.
499
# Log the full traceback to ~/.brz.log
500
log_exception_quietly()
501
if 'error' in debug.debug_flags:
502
print_exception(exc_info, err_file)
503
return errors.EXIT_ERROR
504
exc_type, exc_object, exc_tb = exc_info
505
if isinstance(exc_object, KeyboardInterrupt):
506
err_file.write("brz: interrupted\n")
507
return errors.EXIT_ERROR
508
elif isinstance(exc_object, MemoryError):
509
err_file.write("brz: out of memory\n")
510
if 'mem_dump' in debug.debug_flags:
511
_dump_memory_usage(err_file)
513
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
514
return errors.EXIT_ERROR
515
elif isinstance(exc_object, ImportError) \
516
and str(exc_object).startswith("No module named "):
519
'You may need to install this Python library separately.')
520
return errors.EXIT_ERROR
521
elif not getattr(exc_object, 'internal_error', True):
522
report_user_error(exc_info, err_file)
523
return errors.EXIT_ERROR
524
elif osutils.is_environment_error(exc_object):
525
if getattr(exc_object, 'errno', None) == errno.EPIPE:
526
err_file.write("brz: broken pipe\n")
527
return errors.EXIT_ERROR
528
# Might be nice to catch all of these and show them as something more
529
# specific, but there are too many cases at the moment.
530
report_user_error(exc_info, err_file)
531
return errors.EXIT_ERROR
533
report_bug(exc_info, err_file)
534
return errors.EXIT_INTERNAL_ERROR
537
def print_exception(exc_info, err_file):
538
exc_type, exc_object, exc_tb = exc_info
539
err_file.write("brz: ERROR: %s: %s\n" % (
540
_qualified_exception_name(exc_type), exc_object))
542
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
545
# TODO: Should these be specially encoding the output?
546
def report_user_error(exc_info, err_file, advice=None):
547
"""Report to err_file an error that's not an internal error.
549
These don't get a traceback unless -Derror was given.
551
:param exc_info: 3-tuple from sys.exc_info()
552
:param advice: Extra advice to the user to be printed following the
555
err_file.write(("brz: ERROR: %s\n" % (str(exc_info[1]),)))
557
err_file.write(("%s\n" % advice))
560
def report_bug(exc_info, err_file):
561
"""Report an exception that probably indicates a bug in brz"""
562
from breezy.crash import report_bug
563
report_bug(exc_info, err_file)
566
def _flush_stdout_stderr():
567
# called from the breezy library finalizer returned by breezy.initialize()
572
# On Windows, I get ValueError calling stdout.flush() on a closed
577
if e.errno in [errno.EINVAL, errno.EPIPE]:
584
# called from the breezy library finalizer returned by breezy.initialize()
590
class EncodedStreamHandler(logging.Handler):
591
"""Robustly write logging events to a stream using the specified encoding
593
Messages are expected to be formatted to unicode, but UTF-8 byte strings
594
are also accepted. An error during formatting or a str message in another
595
encoding will be quitely noted as an error in the Bazaar log file.
597
The stream is not closed so sys.stdout or sys.stderr may be passed.
600
def __init__(self, stream, encoding=None, errors='strict', level=0):
601
logging.Handler.__init__(self, level)
604
encoding = getattr(stream, "encoding", "ascii")
605
self.encoding = encoding
609
flush = getattr(self.stream, "flush", None)
610
if flush is not None:
613
def emit(self, record):
615
if not isinstance(record.msg, text_type):
616
msg = record.msg.decode("utf-8")
619
line = self.format(record)
620
if not isinstance(line, text_type):
621
line = line.decode("utf-8")
622
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
624
log_exception_quietly()
625
# Try saving the details that would have been logged in some form
626
msg = args = "<Unformattable>"
628
msg = repr(record.msg)
629
args = repr(record.args)
632
# Using mutter() bypasses the logging module and writes directly
633
# to the file so there's no danger of getting into a loop here.
634
mutter("Logging record unformattable: %s %% %s", msg, args)
637
class Config(object):
638
"""Configuration of message tracing in breezy.
640
This implements the context manager protocol and should manage any global
641
variables still used. The default config used is DefaultConfig, but
642
embedded uses of breezy may wish to use a custom manager.
646
return self # This is bound to the 'as' clause in a with statement.
648
def __exit__(self, exc_type, exc_val, exc_tb):
649
return False # propogate exceptions.
652
class DefaultConfig(Config):
653
"""A default configuration for tracing of messages in breezy.
655
This implements the context manager protocol.
659
self._original_filename = _brz_log_filename
660
self._original_state = enable_default_logging()
661
return self # This is bound to the 'as' clause in a with statement.
663
def __exit__(self, exc_type, exc_val, exc_tb):
664
pop_log_file(self._original_state)
665
global _brz_log_filename
666
_brz_log_filename = self._original_filename
667
return False # propogate exceptions.
added
removed
breezy/trace.py
