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(), """
74
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)
139
def mutter(fmt, *args):
140
if _trace_file is None:
142
# XXX: Don't check this every time; instead anyone who closes the file
143
# ought to deregister it. We can tolerate None.
144
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
147
if isinstance(fmt, text_type):
148
fmt = fmt.encode('utf8')
151
# It seems that if we do ascii % (unicode, ascii) we can
152
# get a unicode cannot encode ascii error, so make sure that "fmt"
153
# is a unicode string
156
if isinstance(arg, text_type):
157
arg = arg.encode('utf8')
158
real_args.append(arg)
159
out = fmt % tuple(real_args)
163
out = b'%0.3f %s\n' % (now - _brz_log_start_time, out)
164
_trace_file.write(out)
165
# there's no explicit flushing; the file is typically line buffered.
168
def mutter_callsite(stacklevel, fmt, *args):
169
"""Perform a mutter of fmt and args, logging the call trace.
171
:param stacklevel: The number of frames to show. None will show all
173
:param fmt: The format string to pass to mutter.
174
:param args: A list of substitution variables.
177
if stacklevel is None:
180
limit = stacklevel + 1
181
traceback.print_stack(limit=limit, file=outf)
182
formatted_lines = outf.getvalue().splitlines()
183
formatted_stack = '\n'.join(formatted_lines[:-2])
184
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
187
def _rollover_trace_maybe(trace_fname):
190
size = os.stat(trace_fname)[stat.ST_SIZE]
193
old_fname = trace_fname + '.old'
194
osutils.rename(trace_fname, old_fname)
199
def _get_brz_log_filename():
200
brz_log = osutils.path_from_environ('BRZ_LOG')
203
home = osutils.path_from_environ('BRZ_HOME')
205
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
206
# over what would be better. On windows, bug 240550
207
# suggests LOCALAPPDATA be used instead.
208
home = osutils._get_home_dir()
209
return os.path.join(home, '.brz.log')
213
"""Open the .brz.log trace file.
215
If the log is more than a particular length, the old file is renamed to
216
.brz.log.old and a new file is started. Otherwise, we append to the
219
This sets the global _brz_log_filename.
221
global _brz_log_filename
223
def _open_or_create_log_file(filename):
224
"""Open existing log file, or create with ownership and permissions
226
It inherits the ownership and permissions (masked by umask) from
227
the containing directory to cope better with being run under sudo
228
with $HOME still set to the user's homedir.
230
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
233
fd = os.open(filename, flags)
236
if e.errno != errno.ENOENT:
239
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
241
if e.errno != errno.EEXIST:
244
osutils.copy_ownership_from_path(filename)
246
return os.fdopen(fd, 'ab', 0) # unbuffered
249
_brz_log_filename = _get_brz_log_filename()
250
_rollover_trace_maybe(_brz_log_filename)
252
brz_log_file = _open_or_create_log_file(_brz_log_filename)
253
brz_log_file.write(b'\n')
254
if brz_log_file.tell() <= 2:
255
brz_log_file.write("this is a debug log for diagnosing/reporting problems in brz\n")
256
brz_log_file.write("you can delete or truncate this file, or include sections in\n")
257
brz_log_file.write("bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
261
except EnvironmentError as e:
262
# If we are failing to open the log, then most likely logging has not
263
# been set up yet. So we just write to stderr rather than using
264
# 'warning()'. If we using warning(), users get the unhelpful 'no
265
# handlers registered for "brz"' when something goes wrong on the
266
# server. (bug #503886)
267
sys.stderr.write("failed to open trace file: %s\n" % (e,))
268
# TODO: What should happen if we fail to open the trace file? Maybe the
269
# objects should be pointed at /dev/null or the equivalent? Currently
270
# returns None which will cause failures later.
274
def enable_default_logging():
275
"""Configure default logging: messages to stderr and debug to .brz.log
277
This should only be called once per process.
279
Non-command-line programs embedding breezy do not need to call this. They
280
can instead either pass a file to _push_log_file, or act directly on
281
logging.getLogger("brz").
283
Output can be redirected away by calling _push_log_file.
285
:return: A memento from push_log_file for restoring the log state.
287
start_time = osutils.format_local_date(_brz_log_start_time,
289
brz_log_file = _open_brz_log()
290
if brz_log_file is not None:
291
brz_log_file.write(start_time.encode('utf-8') + b'\n')
292
memento = push_log_file(brz_log_file,
293
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
294
r'%Y-%m-%d %H:%M:%S')
295
# after hooking output into brz_log, we also need to attach a stderr
296
# handler, writing only at level info and with encoding
297
stderr_handler = EncodedStreamHandler(sys.stderr,
298
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
299
logging.getLogger('brz').addHandler(stderr_handler)
303
def push_log_file(to_file, log_format=None, date_format=None):
304
"""Intercept log and trace messages and send them to a file.
306
:param to_file: A file-like object to which messages will be sent.
308
:returns: A memento that should be passed to _pop_log_file to restore the
309
previously active logging.
313
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
314
if log_format is None:
315
log_format = '%(levelname)8s %(message)s'
316
new_handler.setFormatter(logging.Formatter(log_format, date_format))
317
# save and remove any existing log handlers
318
brz_logger = logging.getLogger('brz')
319
old_handlers = brz_logger.handlers[:]
320
del brz_logger.handlers[:]
321
# set that as the default logger
322
brz_logger.addHandler(new_handler)
323
brz_logger.setLevel(logging.DEBUG)
324
# TODO: check if any changes are needed to the root logger
326
# TODO: also probably need to save and restore the level on brz_logger.
327
# but maybe we can avoid setting the logger level altogether, and just set
328
# the level on the handler?
330
# save the old trace file
331
old_trace_file = _trace_file
332
# send traces to the new one
333
_trace_file = to_file
334
result = new_handler, _trace_file
335
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
338
def pop_log_file(entry):
339
"""Undo changes to logging/tracing done by _push_log_file.
341
This flushes, but does not close the trace file (so that anything that was
344
Takes the memento returned from _push_log_file."""
345
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
347
_trace_file = old_trace_file
348
brz_logger = logging.getLogger('brz')
349
brz_logger.removeHandler(new_handler)
350
# must be closed, otherwise logging will try to close it at exit, and the
351
# file will likely already be closed underneath.
353
brz_logger.handlers = old_handlers
354
if new_trace_file is not None:
355
new_trace_file.flush()
358
def log_exception_quietly():
359
"""Log the last exception to the trace file only.
361
Used for exceptions that occur internally and that may be
362
interesting to developers but not to users. For example,
363
errors loading plugins.
365
mutter(traceback.format_exc())
368
def set_verbosity_level(level):
369
"""Set the verbosity level.
371
:param level: -ve for quiet, 0 for normal, +ve for verbose
373
global _verbosity_level
374
_verbosity_level = level
375
_update_logging_level(level < 0)
376
ui.ui_factory.be_quiet(level < 0)
379
def get_verbosity_level():
380
"""Get the verbosity level.
382
See set_verbosity_level() for values.
384
return _verbosity_level
387
def be_quiet(quiet=True):
389
set_verbosity_level(-1)
391
set_verbosity_level(0)
394
def _update_logging_level(quiet=True):
395
"""Hide INFO messages if quiet."""
397
_brz_logger.setLevel(logging.WARNING)
399
_brz_logger.setLevel(logging.INFO)
403
"""Is the verbosity level negative?"""
404
return _verbosity_level < 0
408
"""Is the verbosity level positive?"""
409
return _verbosity_level > 0
412
def debug_memory(message='', short=True):
413
"""Write out a memory dump."""
414
if sys.platform == 'win32':
415
from breezy import win32utils
416
win32utils.debug_memory_win32api(message=message, short=short)
418
_debug_memory_proc(message=message, short=short)
421
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
423
def _debug_memory_proc(message='', short=True):
425
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
429
status = status_file.read()
434
for line in status.splitlines():
438
for field in _short_fields:
439
if line.startswith(field):
443
def _dump_memory_usage(err_file):
446
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
447
dump_file = os.fdopen(fd, 'w')
448
from meliae import scanner
449
scanner.dump_gc_objects(dump_file)
450
err_file.write("Memory dumped to %s\n" % name)
452
err_file.write("Dumping memory requires meliae module.\n")
453
log_exception_quietly()
455
err_file.write("Exception while dumping memory.\n")
456
log_exception_quietly()
458
if dump_file is not None:
464
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
465
"""Give name of error class including module for non-builtin exceptions
467
If `unqualified_breezy_errors` is True, errors specific to breezy will
468
also omit the module prefix.
470
class_name = eclass.__name__
471
module_name = eclass.__module__
472
if module_name in ("exceptions", "__main__") or (
473
unqualified_breezy_errors and module_name == "breezy.errors"):
475
return "%s.%s" % (module_name, class_name)
478
def report_exception(exc_info, err_file):
479
"""Report an exception to err_file (typically stderr) and to .brz.log.
481
This will show either a full traceback or a short message as appropriate.
483
:return: The appropriate exit code for this error.
485
# Log the full traceback to ~/.brz.log
486
log_exception_quietly()
487
if 'error' in debug.debug_flags:
488
print_exception(exc_info, err_file)
489
return errors.EXIT_ERROR
490
exc_type, exc_object, exc_tb = exc_info
491
if isinstance(exc_object, KeyboardInterrupt):
492
err_file.write("brz: interrupted\n")
493
return errors.EXIT_ERROR
494
elif isinstance(exc_object, MemoryError):
495
err_file.write("brz: out of memory\n")
496
if 'mem_dump' in debug.debug_flags:
497
_dump_memory_usage(err_file)
499
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
500
return errors.EXIT_ERROR
501
elif isinstance(exc_object, ImportError) \
502
and str(exc_object).startswith("No module named "):
503
report_user_error(exc_info, err_file,
504
'You may need to install this Python library separately.')
505
return errors.EXIT_ERROR
506
elif not getattr(exc_object, 'internal_error', True):
507
report_user_error(exc_info, err_file)
508
return errors.EXIT_ERROR
509
elif osutils.is_environment_error(exc_object):
510
if getattr(exc_object, 'errno', None) == errno.EPIPE:
511
err_file.write("brz: broken pipe\n")
512
return errors.EXIT_ERROR
513
# Might be nice to catch all of these and show them as something more
514
# specific, but there are too many cases at the moment.
515
report_user_error(exc_info, err_file)
516
return errors.EXIT_ERROR
518
report_bug(exc_info, err_file)
519
return errors.EXIT_INTERNAL_ERROR
522
def print_exception(exc_info, err_file):
523
exc_type, exc_object, exc_tb = exc_info
524
err_file.write("brz: ERROR: %s.%s: %s\n" % (
525
exc_type.__module__, exc_type.__name__, exc_object))
527
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
530
# TODO: Should these be specially encoding the output?
531
def report_user_error(exc_info, err_file, advice=None):
532
"""Report to err_file an error that's not an internal error.
534
These don't get a traceback unless -Derror was given.
536
:param exc_info: 3-tuple from sys.exc_info()
537
:param advice: Extra advice to the user to be printed following the
540
err_file.write("brz: ERROR: %s\n" % (exc_info[1],))
542
err_file.write("%s\n" % (advice,))
545
def report_bug(exc_info, err_file):
546
"""Report an exception that probably indicates a bug in brz"""
547
from breezy.crash import report_bug
548
report_bug(exc_info, err_file)
551
def _flush_stdout_stderr():
552
# called from the breezy library finalizer returned by breezy.initialize()
556
except ValueError as e:
557
# On Windows, I get ValueError calling stdout.flush() on a closed
562
if e.errno in [errno.EINVAL, errno.EPIPE]:
569
# called from the breezy library finalizer returned by breezy.initialize()
575
class EncodedStreamHandler(logging.Handler):
576
"""Robustly write logging events to a stream using the specified encoding
578
Messages are expected to be formatted to unicode, but UTF-8 byte strings
579
are also accepted. An error during formatting or a str message in another
580
encoding will be quitely noted as an error in the Bazaar log file.
582
The stream is not closed so sys.stdout or sys.stderr may be passed.
585
def __init__(self, stream, encoding=None, errors='strict', level=0):
586
logging.Handler.__init__(self, level)
589
encoding = getattr(stream, "encoding", "ascii")
590
self.encoding = encoding
594
flush = getattr(self.stream, "flush", None)
595
if flush is not None:
598
def emit(self, record):
600
line = self.format(record)
601
if not isinstance(line, text_type):
602
line = line.decode("utf-8")
603
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
605
log_exception_quietly()
606
# Try saving the details that would have been logged in some form
607
msg = args = "<Unformattable>"
609
msg = repr(record.msg).encode("ascii")
610
args = repr(record.args).encode("ascii")
613
# Using mutter() bypasses the logging module and writes directly
614
# to the file so there's no danger of getting into a loop here.
615
mutter("Logging record unformattable: %s %% %s", msg, args)
618
class Config(object):
619
"""Configuration of message tracing in breezy.
621
This implements the context manager protocol and should manage any global
622
variables still used. The default config used is DefaultConfig, but
623
embedded uses of breezy may wish to use a custom manager.
627
return self # This is bound to the 'as' clause in a with statement.
629
def __exit__(self, exc_type, exc_val, exc_tb):
630
return False # propogate exceptions.
633
class DefaultConfig(Config):
634
"""A default configuration for tracing of messages in breezy.
636
This implements the context manager protocol.
640
self._original_filename = _brz_log_filename
641
self._original_state = enable_default_logging()
642
return self # This is bound to the 'as' clause in a with statement.
644
def __exit__(self, exc_type, exc_val, exc_tb):
645
pop_log_file(self._original_state)
646
global _brz_log_filename
647
_brz_log_filename = self._original_filename
648
return False # propogate exceptions.
added
removed
breezy/trace.py
