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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
# Copyright 2012 Hewlett-Packard Development Company, L.P.
# Copyright 2013 OpenStack Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import abc
import argparse
import configparser
import daemon
import extras
import io
import logging
import logging.config
import os
import signal
import socket
import sys
import traceback
import threading
yappi = extras.try_import('yappi')
objgraph = extras.try_import('objgraph')
# as of python-daemon 1.6 it doesn't bundle pidlockfile anymore
# instead it depends on lockfile-0.9.1 which uses pidfile.
pid_file_module = extras.try_imports(['daemon.pidlockfile', 'daemon.pidfile'])
from zuul.ansible import logconfig
import zuul.lib.connections
from zuul.lib.config import get_default
def stack_dump_handler(signum, frame):
signal.signal(signal.SIGUSR2, signal.SIG_IGN)
log = logging.getLogger("zuul.stack_dump")
log.debug("Beginning debug handler")
try:
threads = {}
for t in threading.enumerate():
threads[t.ident] = t
log_str = ""
for thread_id, stack_frame in sys._current_frames().items():
thread = threads.get(thread_id)
if thread:
thread_name = thread.name
thread_is_daemon = str(thread.daemon)
else:
thread_name = '(Unknown)'
thread_is_daemon = '(Unknown)'
log_str += "Thread: %s %s d: %s\n"\
% (thread_id, thread_name, thread_is_daemon)
log_str += "".join(traceback.format_stack(stack_frame))
log.debug(log_str)
except Exception:
log.exception("Thread dump error:")
try:
if yappi:
if not yappi.is_running():
log.debug("Starting Yappi")
yappi.start()
else:
log.debug("Stopping Yappi")
yappi.stop()
yappi_out = io.StringIO()
yappi.get_func_stats().print_all(out=yappi_out)
yappi.get_thread_stats().print_all(out=yappi_out)
log.debug(yappi_out.getvalue())
yappi_out.close()
yappi.clear_stats()
except Exception:
log.exception("Yappi error:")
try:
if objgraph:
log.debug("Most common types:")
objgraph_out = io.StringIO()
objgraph.show_growth(limit=100, file=objgraph_out)
log.debug(objgraph_out.getvalue())
objgraph_out.close()
except Exception:
log.exception("Objgraph error:")
log.debug("End debug handler")
signal.signal(signal.SIGUSR2, stack_dump_handler)
class ZuulApp(object):
app_name = None # type: str
app_description = None # type: str
def __init__(self):
self.args = None
self.config = None
self.connections = {}
def _get_version(self):
from zuul.version import version_info as zuul_version_info
return "Zuul version: %s" % zuul_version_info.release_string()
def createParser(self):
parser = argparse.ArgumentParser(
description=self.app_description,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument('-c', dest='config',
help='specify the config file')
parser.add_argument('--version', dest='version', action='version',
version=self._get_version(),
help='show zuul version')
return parser
def parseArguments(self, args=None):
parser = self.createParser()
self.args = parser.parse_args(args)
# The arguments debug and foreground both lead to nodaemon mode so
# set nodaemon if one of them is set.
if ((hasattr(self.args, 'debug') and self.args.debug) or
(hasattr(self.args, 'foreground') and self.args.foreground)):
self.args.nodaemon = True
else:
self.args.nodaemon = False
return parser
def readConfig(self):
safe_env = {
k: v for k, v in os.environ.items()
if k.startswith('ZUUL_')
}
self.config = configparser.ConfigParser(safe_env)
if self.args.config:
locations = [self.args.config]
else:
locations = ['/etc/zuul/zuul.conf',
'~/zuul.conf']
for fp in locations:
if os.path.exists(os.path.expanduser(fp)):
self.config.read(os.path.expanduser(fp))
return
raise Exception("Unable to locate config file in %s" % locations)
def setup_logging(self, section, parameter):
if self.config.has_option(section, parameter):
fp = os.path.expanduser(self.config.get(section, parameter))
logging_config = logconfig.load_config(fp)
else:
# If someone runs in the foreground and doesn't give a logging
# config, leave the config set to emit to stdout.
if hasattr(self.args, 'nodaemon') and self.args.nodaemon:
logging_config = logconfig.ServerLoggingConfig()
else:
# Setting a server value updates the defaults to use
# WatchedFileHandler on /var/log/zuul/{server}-debug.log
# and /var/log/zuul/{server}.log
logging_config = logconfig.ServerLoggingConfig(server=section)
if hasattr(self.args, 'debug') and self.args.debug:
logging_config.setDebug()
logging_config.apply()
def configure_connections(self, source_only=False, include_drivers=None):
self.connections = zuul.lib.connections.ConnectionRegistry()
self.connections.configure(self.config, source_only, include_drivers)
class ZuulDaemonApp(ZuulApp, metaclass=abc.ABCMeta):
def createParser(self):
parser = super(ZuulDaemonApp, self).createParser()
parser.add_argument('-d', dest='debug', action='store_true',
help='run in foreground with debug log. Note '
'that in future this will be changed to only '
'request debug logging. If you want to keep '
'running the process in the foreground '
'migrate/add the -f switch.')
parser.add_argument('-f', dest='foreground', action='store_true',
help='run in foreground with info log')
return parser
def getPidFile(self):
pid_fn = get_default(self.config, self.app_name, 'pidfile',
'/var/run/zuul/%s.pid' % self.app_name,
expand_user=True)
return pid_fn
@abc.abstractmethod
def run(self):
"""
This is the main run method of the application.
"""
pass
def setup_logging(self, section, parameter):
super(ZuulDaemonApp, self).setup_logging(section, parameter)
from zuul.version import version_info as zuul_version_info
log = logging.getLogger(
"zuul.{section}".format(section=section.title()))
log.debug(
"Configured logging: {version}".format(
version=zuul_version_info.release_string()))
def main(self):
self.parseArguments()
self.readConfig()
pid_fn = self.getPidFile()
pid = pid_file_module.TimeoutPIDLockFile(pid_fn, 10)
# Early register the stack dump handler for all zuul apps. This makes
# it possible to also gather stack dumps during startup hangs.
signal.signal(signal.SIGUSR2, stack_dump_handler)
if self.args.nodaemon:
self.run()
else:
# Exercise the pidfile before we do anything else (including
# logging or daemonizing)
with pid:
pass
with daemon.DaemonContext(pidfile=pid, umask=0o022):
self.run()
def send_command(self, cmd):
command_socket = get_default(
self.config, self.app_name, 'command_socket',
'/var/lib/zuul/%s.socket' % self.app_name)
s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
s.connect(command_socket)
cmd = '%s\n' % cmd
s.sendall(cmd.encode('utf8'))
|
