forked from Supervisor/supervisor
/
supervisorctl.py
executable file
·621 lines (534 loc) · 21.3 KB
/
supervisorctl.py
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
#!/usr/bin/env python -u
##############################################################################
#
# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""supervisorctl -- control applications run by supervisord from the cmd line.
Usage: python supervisorctl.py [-C URL] [-h] [action [arguments]]
Options:
-c/--configuration URL -- configuration file or URL
-h/--help -- print usage message and exit
-i/--interactive -- start an interactive shell after executing commands
-s/--serverurl URL -- URL on which supervisord server is listening
(default "http://localhost:9001").
-u/--username -- username to use for authentication with server
-p/--password -- password to use for authentication with server
action [arguments] -- see below
Actions are commands like "tail" or "stop". If -i is specified or no action is
specified on the command line, a"shell" interpreting actions typed
interactively is started. Use the action "help" to find out about available
actions.
"""
import os
import cmd
import sys
import time
import getpass
import xmlrpclib
import urllib2
import fcntl
import socket
import asyncore
import errno
import time
import datetime
import urlparse
from options import ClientOptions
from supervisord import ProcessStates
from supervisord import getProcessStateDescription
import xmlrpc
class Controller(cmd.Cmd):
def __init__(self, options, completekey='tab', stdin=None, stdout=None):
self.options = options
self.prompt = self.options.prompt + '> '
cmd.Cmd.__init__(self, completekey, stdin, stdout)
def emptyline(self):
# We don't want a blank line to repeat the last command.
return
def onecmd(self, line):
""" Override the onecmd method to catch and print all exceptions
"""
origline = line
cmd, arg, line = self.parseline(line)
if not line:
return self.emptyline()
if cmd is None:
return self.default(line)
self.lastcmd = line
if cmd == '':
return self.default(line)
else:
try:
func = getattr(self, 'do_' + cmd)
except AttributeError:
return self.default(line)
try:
try:
return func(arg)
except xmlrpclib.ProtocolError, e:
if e.errcode == 401:
if self.options.interactive:
self._output('Server requires authentication')
username = raw_input('Username:')
password = getpass.getpass(prompt='Password:')
self._output('')
self.options.username = username
self.options.password = password
return self.onecmd(origline)
else:
self.options.usage('Server requires authentication')
else:
raise
except SystemExit:
raise
except Exception, e:
(file, fun, line), t, v, tbinfo = asyncore.compact_traceback()
error = 'error: %s, %s: file: %s line: %s' % (t, v, file, line)
self._output(error)
def _output(self, stuff):
if stuff is not None:
self.stdout.write(stuff + '\n')
def _makeNamespace(self, namespace):
proxy = self.options.getServerProxy()
namespace = getattr(proxy, namespace)
return namespace
def _get_supervisor(self):
supervisor = self._makeNamespace('supervisor')
return supervisor
def _upcheck(self):
try:
supervisor = self._get_supervisor()
supervisor.getSupervisorVersion()
except socket.error, why:
if why[0] == errno.ECONNREFUSED:
self._output('%s refused connection' % self.options.serverurl)
return False
raise
return True
def help_help(self):
self._output("help\t\tPrint a list of available actions.")
self._output("help <action>\tPrint help for <action>.")
def do_EOF(self, arg):
self._output('')
return 1
def help_EOF(self):
self._output("To quit, type ^D or use the quit command.")
def _tailf(self, path):
if not self._upcheck():
return
self._output('==> Press Ctrl-C to exit <==')
username = self.options.username
password = self.options.password
try:
# Python's urllib2 (at least as of Python 2.4.2) isn't up
# to this task; it doesn't actually implement a proper
# HTTP/1.1 client that deals with chunked responses (it
# always sends a Connection: close header). We use a
# homegrown client based on asyncore instead. This makes
# me sad.
import http_client
listener = http_client.Listener()
handler = http_client.HTTPHandler(listener, username, password)
handler.get(self.options.serverurl, path)
asyncore.loop()
except KeyboardInterrupt:
handler.close()
self._output('')
return
def do_tail(self, arg):
if not self._upcheck():
return
args = arg.strip().split()
if len(args) < 1:
self._output('Error: too few arguments')
self.help_tail()
return
elif len(args) > 2:
self._output('Error: too many arguments')
self.help_tail()
return
elif len(args) == 2:
if args[0].startswith('-'):
what = args[0][1:]
if what == 'f':
path = '/logtail/' + args[1]
return self._tailf(path)
try:
what = int(what)
except:
self._output('Error: bad argument %s' % args[0])
return
else:
bytes = what
else:
self._output('Error: bad argument %s' % args[0])
else:
bytes = 1600
processname = args[-1]
supervisor = self._get_supervisor()
try:
output = supervisor.readProcessLog(processname, -bytes, 0)
except xmlrpclib.Fault, e:
template = '%s: ERROR (%s)'
if e.faultCode == xmlrpc.Faults.NO_FILE:
self._output(template % (processname, 'no log file'))
elif e.faultCode == xmlrpc.Faults.FAILED:
self._output(template % (processname,
'unknown error reading log'))
elif e.faultCode == xmlrpc.Faults.BAD_NAME:
self._output(template % (processname, 'no such process name'))
else:
self._output(output)
def help_tail(self):
self._output(
"tail -f <processname>\tContinuous tail of named process stdout,\n"
"\t\t\tCtrl-C to exit.\n"
"tail -100 <processname>\tlast 100 *bytes* of process log file\n"
"tail <processname>\tlast 1600 *bytes* of process log file\n"
)
def do_maintail(self, arg):
if not self._upcheck():
return
args = arg.strip().split()
if len(args) > 1:
self._output('Error: too many arguments')
self.help_maintail()
return
elif len(args) == 1:
if args[0].startswith('-'):
what = args[0][1:]
if what == 'f':
path = '/mainlogtail'
return self._tailf(path)
try:
what = int(what)
except:
self._output('Error: bad argument %s' % args[0])
return
else:
bytes = what
else:
self._output('Error: bad argument %s' % args[0])
else:
bytes = 1600
supervisor = self._get_supervisor()
try:
output = supervisor.readLog(-bytes, 0)
except xmlrpclib.Fault, e:
template = '%s: ERROR (%s)'
if e.faultCode == xmlrpc.Faults.NO_FILE:
self._output(template % (processname, 'no log file'))
elif e.faultCode == xmlrpc.Faults.FAILED:
self._output(template % (processname,
'unknown error reading log'))
else:
self._output(output)
def help_maintail(self):
self._output(
"maintail -f \tContinuous tail of supervisor main log file,\n"
"\t\t\tCtrl-C to exit.\n"
"maintail -100\tlast 100 *bytes* of supervisord main log file\n"
"maintail\tlast 1600 *bytes* of supervisor main log file\n"
)
def do_quit(self, arg):
sys.exit(0)
def help_quit(self):
self._output("quit\tExit the supervisor shell.")
do_exit = do_quit
def help_exit(self):
self._output("exit\tExit the supervisor shell.")
def do_status(self, arg):
if not self._upcheck():
return
supervisor = self._get_supervisor()
template = '%(name)-14s %(state)-10s %(desc)s'
processnames = arg.strip().split()
if processnames:
for processname in processnames:
try:
info = supervisor.getProcessInfo(processname)
except xmlrpclib.Fault, e:
if e.faultCode == xmlrpc.Faults.BAD_NAME:
self._output('No such process %s' % processname)
else:
raise
continue
newinfo = {'name':info['name'], 'state':info['statename'],
'desc':info['description']}
self._output(template % newinfo)
else:
for info in supervisor.getAllProcessInfo():
newinfo = {'name':info['name'], 'state':info['statename'],
'desc':info['description']}
self._output(template % newinfo)
def help_status(self):
self._output("status\t\t\tGet all process status info.")
self._output("status <name>\t\tGet status on a single process by name.")
self._output("status <name> <name>\tGet status on multiple named "
"processes.")
def _startresult(self, code, processname, default=None):
template = '%s: ERROR (%s)'
if code == xmlrpc.Faults.BAD_NAME:
return template % (processname,'no such process')
elif code == xmlrpc.Faults.ALREADY_STARTED:
return template % (processname,'already started')
elif code == xmlrpc.Faults.SPAWN_ERROR:
return template % (processname, 'spawn error')
elif code == xmlrpc.Faults.ABNORMAL_TERMINATION:
return template % (processname, 'abnormal termination')
elif code == xmlrpc.Faults.SUCCESS:
return '%s: started' % processname
return default
def do_start(self, arg):
if not self._upcheck():
return
processnames = arg.strip().split()
supervisor = self._get_supervisor()
if not processnames:
self._output("Error: start requires a process name")
self.help_start()
return
if 'all' in processnames:
results = supervisor.startAllProcesses()
for result in results:
name = result['name']
code = result['status']
result = self._startresult(code, name)
if result is None:
# assertion
raise ValueError('Unknown result code %s for %s' %
(code, name))
else:
self._output(result)
else:
for processname in processnames:
try:
result = supervisor.startProcess(processname)
except xmlrpclib.Fault, e:
error = self._startresult(e.faultCode, processname)
if error is not None:
self._output(error)
else:
raise
else:
if result == True:
self._output('%s: started' % processname)
else:
raise # assertion
def help_start(self):
self._output("start <processname>\t\t\tStart a process.")
self._output("start <processname> <processname>\tStart multiple "
"processes")
self._output("start all\t\t\t\tStart all processes")
self._output(" When all processes are started, they are started "
"in")
self._output(" priority order (see config file)")
def _stopresult(self, code, processname, fault_string=None):
template = '%s: ERROR (%s)'
if code == xmlrpc.Faults.BAD_NAME:
return template % (processname, 'no such process')
elif code == xmlrpc.Faults.NOT_RUNNING:
return template % (processname, 'not running')
elif code == xmlrpc.Faults.SUCCESS:
return '%s: stopped' % processname
elif code == xmlrpc.Faults.FAILED:
return fault_string
return None
def do_stop(self, arg):
if not self._upcheck():
return
processnames = arg.strip().split()
supervisor = self._get_supervisor()
if not processnames:
self._output('Error: stop requires a process name')
self.help_stop()
return
if 'all' in processnames:
results = supervisor.stopAllProcesses()
for result in results:
name = result['name']
code = result['status']
fault_string = result['description']
result = self._stopresult(code, name, fault_string)
if result is None:
# assertion
raise ValueError('Unknown result code %s for %s' %
(code, name))
else:
self._output(result)
else:
for processname in processnames:
try:
result = supervisor.stopProcess(processname)
except xmlrpclib.Fault, e:
error = self._stopresult(e.faultCode, processname,
e.faultString)
if error is not None:
self._output(error)
else:
raise
else:
if result == True:
self._output('%s: stopped' % processname)
else:
raise # assertion
def help_stop(self):
self._output("stop <processname>\t\t\tStop a process.")
self._output("stop <processname> <processname>\tStop multiple "
"processes")
self._output("stop all\t\t\t\tStop all processes")
self._output(" When all processes are stopped, they are stopped "
"in")
self._output(" reverse priority order (see config file)")
def do_restart(self, arg):
if not self._upcheck():
return
processnames = arg.strip().split()
if not processnames:
self._output('Error: restart requires a process name')
self.help_restart()
return
self.do_stop(arg)
self.do_start(arg)
def help_restart(self):
self._output("restart <processname>\t\t\tRestart a process.")
self._output("restart <processname> <processname>\tRestart multiple "
"processes")
self._output("restart all\t\t\t\tRestart all processes")
self._output(" When all processes are restarted, they are "
"started in")
self._output(" priority order (see config file)")
def do_shutdown(self, arg):
if self.options.interactive:
yesno = raw_input('Really shut the remote supervisord process '
'down y/N? ')
really = yesno.lower().startswith('y')
else:
really = 1
if really:
supervisor = self._get_supervisor()
try:
supervisor.shutdown()
except xmlrpclib.Fault, e:
if e.faultCode == xmlrpc.Faults.SHUTDOWN_STATE:
self._output('ERROR: already shutting down')
else:
self._output('Shut down')
def help_shutdown(self):
self._output("shutdown \t\tShut the remote supervisord down.")
def do_reload(self, arg):
if self.options.interactive:
yesno = raw_input('Really restart the remote supervisord process '
'y/N? ')
really = yesno.lower().startswith('y')
else:
really = 1
if really:
supervisor = self._get_supervisor()
try:
supervisor.restart()
except xmlrpclib.Fault, e:
if e.faultCode == xmlrpc.Faults.SHUTDOWN_STATE:
self._output('ERROR: already shutting down')
else:
self._output('Restarted supervisord')
def help_reload(self):
self._output("reload \t\tRestart the remote supervisord.")
def _clearresult(self, code, processname, default=None):
template = '%s: ERROR (%s)'
if code == xmlrpc.Faults.BAD_NAME:
return template % (processname, 'no such process')
elif code == xmlrpc.Faults.FAILED:
return template % (processname, 'failed')
elif code == xmlrpc.Faults.SUCCESS:
return '%s: cleared' % processname
return default
def do_clear(self, arg):
if not self._upcheck():
return
processnames = arg.strip().split()
if not processnames:
self._output('Error: clear requires a process name')
self.help_clear()
return
supervisor = self._get_supervisor()
if 'all' in processnames:
results = supervisor.clearAllProcessLogs()
for result in results:
name = result['name']
code = result['status']
result = self._clearresult(code, name)
if result is None:
# assertion
raise ValueError('Unknown result code %s for %s' %
(code, name))
else:
self._output(result)
else:
for processname in processnames:
try:
result = supervisor.clearProcessLog(processname)
except xmlrpclib.Fault, e:
error = self._clearresult(e.faultCode, processname)
if error is not None:
self._output(error)
else:
raise
else:
if result == True:
self._output('%s: cleared' % processname)
else:
raise # assertion
def help_clear(self):
self._output("clear <processname>\t\t\tClear a process' log file.")
self._output("clear <processname> <processname>\tclear multiple "
"process log files")
self._output("clear all\t\t\t\tClear all process log files")
def do_open(self, arg):
url = arg.strip()
parts = urlparse.urlparse(url)
if parts[0] not in ('unix', 'http'):
self._output('ERROR: url must be http:// or unix://')
return
self.options.serverurl = url
self.do_status('')
def help_open(self):
self._output("open <url>\t\t\tConnect to a remote supervisord process.")
self._output("\t\t\t(for UNIX domain socket, use unix:///socket/path)")
def do_version(self, arg):
if not self._upcheck():
return
supervisor = self._get_supervisor()
self._output(supervisor.getSupervisorVersion())
def help_version(self):
self._output("version\t\t\tShow the version of the remote supervisord ")
self._output("\t\t\tprocess")
def main(args=None, options=None):
if options is None:
options = ClientOptions()
options.realize(args)
c = Controller(options)
if options.args:
c.onecmd(" ".join(options.args))
if options.interactive:
try:
import readline
except ImportError:
pass
try:
c.onecmd('status')
c.cmdloop()
except KeyboardInterrupt:
c._output('')
pass
if __name__ == "__main__":
main()