1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
#!/usr/bin/python
#
# Copyright 2010 Google Inc. All Rights Reserved.
# System modules
import os.path
import sys
import traceback
#TODO(yunlian@google.com): Use GetRoot from misc
def GetRoot(scr_name):
"""Break up pathname into (dir+name)."""
abs_path = os.path.abspath(scr_name)
return (os.path.dirname(abs_path), os.path.basename(abs_path))
class Logger(object):
"""Logging helper class."""
MAX_LOG_FILES = 10
def __init__ (self, rootdir, basefilename, print_console, subdir="logs"):
logdir = os.path.join(rootdir, subdir)
basename = os.path.join(logdir, basefilename)
try:
os.makedirs(logdir)
except OSError:
pass
# print "Warning: Logs directory '%s' already exists." % logdir
self.print_console = print_console
self._CreateLogFileHandles(basename)
self._WriteTo(self.cmdfd, " ".join(sys.argv), True)
def _AddSuffix(self, basename, suffix):
return "%s%s" % (basename, suffix)
def _FindSuffix(self, basename):
timestamps = []
found_suffix = None
for i in range(self.MAX_LOG_FILES):
suffix = str(i)
suffixed_basename = self._AddSuffix(basename, suffix)
cmd_file = "%s.cmd" % suffixed_basename
if not os.path.exists(cmd_file):
found_suffix = suffix
break
timestamps.append(os.stat(cmd_file).st_mtime)
if found_suffix:
return found_suffix
# Try to pick the oldest file with the suffix and return that one.
suffix = str(timestamps.index(min(timestamps)))
# print ("Warning: Overwriting log file: %s" %
# self._AddSuffix(basename, suffix))
return suffix
def _CreateLogFileHandle(self, name):
fd = None
try:
fd = open(name, "w")
except IOError:
print "Warning: could not open %s for writing." % name
return fd
def _CreateLogFileHandles(self, basename):
suffix = self._FindSuffix(basename)
suffixed_basename = self._AddSuffix(basename, suffix)
self.cmdfd = self._CreateLogFileHandle("%s.cmd" % suffixed_basename)
self.stdout = self._CreateLogFileHandle("%s.out" % suffixed_basename)
self.stderr = self._CreateLogFileHandle("%s.err" % suffixed_basename)
self._CreateLogFileSymlinks(basename, suffixed_basename)
# Symlink unsuffixed basename to currently suffixed one.
def _CreateLogFileSymlinks(self, basename, suffixed_basename):
try:
for extension in ["cmd", "out", "err"]:
src_file = "%s.%s" % (os.path.basename(suffixed_basename), extension)
dest_file = "%s.%s" % (basename, extension)
if os.path.exists(dest_file):
os.remove(dest_file)
os.symlink(src_file, dest_file)
except Exception as ex:
print "Exception while creating symlinks: %s" % str(ex)
def _WriteTo(self, fd, msg, flush):
if fd:
fd.write(msg)
if flush:
fd.flush()
def LogStartDots(self, print_to_console=True):
term_fd = self._GetStdout(print_to_console)
if (term_fd):
term_fd.flush()
term_fd.write(". ")
term_fd.flush()
def LogAppendDot(self, print_to_console=True):
term_fd = self._GetStdout(print_to_console)
if (term_fd):
term_fd.write(". ")
term_fd.flush()
def LogEndDots(self, print_to_console=True):
term_fd = self._GetStdout(print_to_console)
if (term_fd):
term_fd.write("\n")
term_fd.flush()
def _LogMsg(self, file_fd, term_fd, msg, flush=True):
if file_fd:
self._WriteTo(file_fd, msg, flush)
if self.print_console:
self._WriteTo(term_fd, msg, flush)
def _GetStdout(self, print_to_console):
if print_to_console:
return sys.stdout
return None
def _GetStderr(self, print_to_console):
if print_to_console:
return sys.stderr
return None
def LogCmd(self, cmd, machine="", user=None, print_to_console=True):
if user:
host = "%s@%s" % (user, machine)
else:
host = machine
self._LogMsg(self.cmdfd, self._GetStdout(print_to_console),
"CMD (%s): %s\n" % (host, cmd))
def LogFatal(self, msg, print_to_console=True):
self._LogMsg(self.stderr, self._GetStderr(print_to_console),
"FATAL: %s\n" % msg)
self._LogMsg(self.stderr, self._GetStderr(print_to_console),
"\n".join(traceback.format_stack()))
sys.exit(1)
def LogError(self, msg, print_to_console=True):
self._LogMsg(self.stderr, self._GetStderr(print_to_console),
"ERROR: %s\n" % msg)
def LogWarning(self, msg, print_to_console=True):
self._LogMsg(self.stderr, self._GetStderr(print_to_console),
"WARNING: %s\n" % msg)
def LogOutput(self, msg, print_to_console=True):
self._LogMsg(self.stdout, self._GetStdout(print_to_console),
"OUTPUT: %s\n" % msg)
def LogFatalIf(self, condition, msg):
if condition:
self.LogFatal(msg)
def LogErrorIf(self, condition, msg):
if condition:
self.LogError(msg)
def LogWarningIf(self, condition, msg):
if condition:
self.LogWarning(msg)
def LogCommandOutput(self, msg, print_to_console=True):
self._LogMsg(self.stdout, self._GetStdout(print_to_console),
msg, flush=False)
def LogCommandError(self, msg, print_to_console=True):
self._LogMsg(self.stderr, self._GetStderr(print_to_console),
msg, flush=False)
def Flush(self):
self.cmdfd.flush()
self.stdout.flush()
self.stderr.flush()
main_logger = None
def InitLogger(script_name, log_dir, print_console=True):
"""Initialize a global logger. To be called only once."""
global main_logger
assert not main_logger, "The logger has already been initialized"
rootdir, basefilename = GetRoot(script_name)
if not log_dir:
log_dir = rootdir
main_logger = Logger(log_dir, basefilename, print_console)
def GetLogger(log_dir=""):
if not main_logger:
InitLogger(sys.argv[0], log_dir)
return main_logger
def HandleUncaughtExceptions(fun):
"""Catches all exceptions that would go outside decorated fun scope."""
def _Interceptor(*args, **kwargs):
try:
return fun(*args, **kwargs)
except StandardError:
GetLogger().LogFatal("Uncaught exception:\n%s" % traceback.format_exc())
return _Interceptor
|
