/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Merged Martin

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
 
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.
 
5
 
 
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.
 
10
 
 
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
 
14
 
 
15
 
 
16
"""Messages and logging for bazaar-ng
 
17
 
 
18
Messages are sent out through the Python logging library.
 
19
 
 
20
They can be sent to two places: to stderr, and to ~/.bzr.log.
 
21
 
 
22
~/.bzr.log gets all messages, and tracebacks of all uncaught
 
23
exceptions.
 
24
 
 
25
Normally stderr only gets messages of level INFO and higher, and gets
 
26
only a summary of exceptions, not the traceback.
 
27
"""
 
28
 
 
29
 
 
30
# TODO: in debug mode, stderr should get full tracebacks and also
 
31
# debug messages.  (Is this really needed?)
 
32
 
 
33
# TODO: When running the test suites, we should add an additional
 
34
# logger that sends messages into the test log file.
 
35
 
 
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.
 
39
 
 
40
 
 
41
import sys
 
42
import os
 
43
import logging
 
44
import traceback
 
45
 
 
46
 
 
47
_file_handler = None
 
48
_stderr_handler = None
 
49
 
 
50
 
 
51
class QuietFormatter(logging.Formatter):
 
52
    """Formatter that supresses the details of errors.
 
53
 
 
54
    This is used by default on stderr so as not to scare the user.
 
55
    """
 
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.
 
59
 
 
60
    def format(self, record):
 
61
        if record.levelno >= logging.WARNING:
 
62
            s = 'bzr: ' + record.levelname + ': '
 
63
        else:
 
64
            s = ''
 
65
            
 
66
        s += record.getMessage()
 
67
 
 
68
        ##import textwrap
 
69
        ##s = textwrap.fill(s)
 
70
            
 
71
        if record.exc_info:
 
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
 
75
            s += '\n'
 
76
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
 
77
            s += '  see ~/.bzr.log for debug information'
 
78
 
 
79
        return s
 
80
        
 
81
 
 
82
 
 
83
 
 
84
################
 
85
# configure convenient aliases for output routines
 
86
 
 
87
_bzr_logger = logging.getLogger('bzr')
 
88
 
 
89
info = note = _bzr_logger.info
 
90
warning =   _bzr_logger.warning
 
91
log_error = _bzr_logger.error
 
92
error =     _bzr_logger.error
 
93
mutter =    _bzr_logger.debug
 
94
debug =     _bzr_logger.debug
 
95
 
 
96
 
 
97
 
 
98
 
 
99
# we do the rollover using this code, rather than the default from python
 
100
# logging, because we only want to rollover at program startup, not on each
 
101
# message.  maybe that's not a good enough reason.
 
102
 
 
103
def _rollover_trace_maybe(trace_fname):
 
104
    import stat
 
105
    try:
 
106
        size = os.stat(trace_fname)[stat.ST_SIZE]
 
107
        if size <= 4 << 20:
 
108
            return
 
109
        old_fname = trace_fname + '.old'
 
110
 
 
111
        from osutils import rename
 
112
        rename(trace_fname, old_fname)
 
113
 
 
114
    except OSError:
 
115
        return
 
116
 
 
117
 
 
118
 
 
119
def open_tracefile(tracefilename='~/.bzr.log'):
 
120
    # Messages are always written to here, so that we have some
 
121
    # information if something goes wrong.  In a future version this
 
122
    # file will be removed on successful completion.
 
123
    global _file_handler
 
124
    import stat, codecs
 
125
 
 
126
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
127
    _rollover_trace_maybe(trace_fname)
 
128
 
 
129
    # buffering=1 means line buffered
 
130
    try:
 
131
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
 
132
 
 
133
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
 
134
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
135
            tf.write("you can delete or truncate this file, or include sections in\n")
 
136
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
137
        
 
138
        _file_handler = logging.StreamHandler(tf)
 
139
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
140
        datefmt = r'%a %H:%M:%S'
 
141
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
142
        _file_handler.setLevel(logging.DEBUG)
 
143
        logging.getLogger('').addHandler(_file_handler)
 
144
 
 
145
    except IOError, e:
 
146
        warning("failed to open trace file: %s" % (e))
 
147
 
 
148
 
 
149
def log_startup(argv):
 
150
    import bzrlib
 
151
 
 
152
    debug('bzr %s invoked on python %s (%s)',
 
153
          bzrlib.__version__,
 
154
          '.'.join(map(str, sys.version_info)),
 
155
          sys.platform)
 
156
 
 
157
    debug('  arguments: %r', argv)
 
158
    debug('  working dir: %r', os.getcwdu())
 
159
 
 
160
 
 
161
def log_exception(msg=None):
 
162
    """Log the last exception to stderr and the trace file.
 
163
 
 
164
    The exception string representation is used as the error
 
165
    summary, unless msg is given.
 
166
    """
 
167
    ei = sys.exc_info()
 
168
    try:
 
169
        if msg == None:
 
170
            msg = str(ei[1])
 
171
    except Exception, e:
 
172
        msg = "Error logging exception of type %s\n" % ei[1].__class__.__name__
 
173
        try:
 
174
            msg += str(e)
 
175
        except:
 
176
            pass
 
177
    if msg and (msg[-1] == '\n'):
 
178
        msg = msg[:-1]
 
179
    msg += '\n  command: %s' % ' '.join(repr(arg) for arg in sys.argv)
 
180
    msg += '\n      pwd: %r' % os.getcwdu()
 
181
    msg += '\n    error: %s' % ei[0]        # exception type
 
182
    _bzr_logger.exception(msg)
 
183
 
 
184
 
 
185
def log_exception_quietly():
 
186
    """Log the last exception to the trace file only.
 
187
 
 
188
    Used for exceptions that occur internally and that may be 
 
189
    interesting to developers but not to users.  For example, 
 
190
    errors loading plugins.
 
191
    """
 
192
    debug(traceback.format_exc())
 
193
 
 
194
 
 
195
def enable_default_logging():
 
196
    """Configure default logging to stderr and .bzr.log"""
 
197
    global _stderr_handler, _file_handler
 
198
 
 
199
    _stderr_handler = logging.StreamHandler()
 
200
    _stderr_handler.setFormatter(QuietFormatter())
 
201
 
 
202
    if not _file_handler:
 
203
        open_tracefile()
 
204
 
 
205
    if os.environ.get('BZR_DEBUG'):
 
206
        level = logging.DEBUG
 
207
    else:
 
208
        level = logging.INFO
 
209
 
 
210
    _stderr_handler.setLevel(logging.INFO)
 
211
    _file_handler.setLevel(level)
 
212
    _bzr_logger.setLevel(level) 
 
213
 
 
214
    logging.getLogger('').addHandler(_stderr_handler)
 
215
 
 
216
 
 
217
def disable_default_logging():
 
218
    """Turn off default log handlers.
 
219
 
 
220
    This is intended to be used by the test framework, which doesn't
 
221
    want leakage from the code-under-test into the main logs.
 
222
    """
 
223
 
 
224
    l = logging.getLogger('')
 
225
    l.removeHandler(_stderr_handler)
 
226
    if _file_handler:
 
227
        l.removeHandler(_file_handler)