CHANGES.txt 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732
  1. Next Release
  2. - 3.0a3 broke Python 2.3 backwards compatibility.
  3. - On Debian Sarge, one user reported that a call to
  4. options.mktempfile would fail with an "[Errno 9] Bad file
  5. descriptor" at supervisord startup time. I was unable to
  6. reproduce this, but we found a workaround that seemed to work for
  7. him and it's included in this release. See
  8. http://www.plope.com/software/collector/252 for more information.
  9. Thanks to William Dode.
  10. - The fault ALREADY_TERMINATED has been removed. It was only
  11. raised by supervisor.sendProcessStdin(). That method now returns
  12. NOT_RUNNING for parity with the other methods. (Mike Naberezny)
  13. - The fault TIMED_OUT has been removed. It was not used.
  14. - Supervisor now depends on meld3 0.6.4, which does not compile its
  15. C extensions by default, so there is no more need to faff around
  16. with NO_MELD3_EXTENSION_MODULES during installation if you don't
  17. have a C compiler or the Python development libraries on your
  18. system.
  19. - Instead of making a user root around for the sample.conf file,
  20. provide a convenience command "echo_supervisord_conf", which he can
  21. use to echo the sample.conf to his terminal (and redirect to a file
  22. appropriately). This is a new user convenience (especially one who
  23. has no Python experience).
  24. - Added 'numprocs_start' config option to '[program:x]' and
  25. '[eventlistener:x]' sections. This is an offset used to compute
  26. the first integer that 'numprocs' will begin to start from.
  27. Contributed by Antonio Beamud Montero.
  28. - Added capability for '[include]' config section to config format.
  29. This section must contain a single key "files", which must name a
  30. space-separated list of file globs that will be included in
  31. supervisor's configuration. Contributed by Ian Bicking.
  32. - Invoking the 'reload' supervisorctl command could trigger a bug in
  33. supervisord which caused it to crash. See
  34. http://www.plope.com/software/collector/253 . Thanks to William
  35. Dode for a bug report.
  36. - The 'pidproxy' script was made into a console script.
  37. - The 'password' value in both the '[inet_http_server]' and
  38. '[unix_http_server]' sections can now optionally be specified as a
  39. SHA hexdigest instead of as cleartext. Values prefixed with
  40. '{SHA}' will be considered SHA hex digests. To encrypt a password
  41. to a form suitable for pasting into the configuration file using
  42. Python, do, e.g.:
  43. >>> import sha
  44. >>> '{SHA}' + sha.new('thepassword').hexdigest()
  45. '{SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d'
  46. - The subtypes of the events PROCESS_STATE_CHANGE (and
  47. PROCESS_STATE_CHANGE itself) have been removed, replaced with a
  48. simpler set of PROCESS_STATE subscribable event types.
  49. The new event types are:
  50. PROCESS_STATE_STOPPED
  51. PROCESS_STATE_EXITED
  52. PROCESS_STATE_STARTING
  53. PROCESS_STATE_STOPPING
  54. PROCESS_STATE_BACKOFF
  55. PROCESS_STATE_FATAL
  56. PROCESS_STATE_RUNNING
  57. PROCESS_STATE_UNKNOWN
  58. PROCESS_STATE # abstract
  59. PROCESS_STATE_STARTING replaces:
  60. PROCESS_STATE_CHANGE_STARTING_FROM_STOPPED
  61. PROCESS_STATE_CHANGE_STARTING_FROM_BACKOFF
  62. PROCESS_STATE_CHANGE_STARTING_FROM_EXITED
  63. PROCESS_STATE_CHANGE_STARTING_FROM_FATAL
  64. PROCESS_STATE_RUNNING replaces
  65. PROCESS_STATE_CHANGE_RUNNING_FROM_STARTED
  66. PROCESS_STATE_BACKOFF replaces
  67. PROCESS_STATE_CHANGE_BACKOFF_FROM_STARTING
  68. PROCESS_STATE_STOPPING replaces:
  69. PROCESS_STATE_CHANGE_STOPPING_FROM_RUNNING
  70. PROCESS_STATE_CHANGE_STOPPING_FROM_STARTING
  71. PROCESS_STATE_EXITED replaces
  72. PROCESS_STATE_CHANGE_EXITED_FROM_RUNNING
  73. PROCESS_STATE_STOPPED replaces
  74. PROCESS_STATE_CHANGE_STOPPED_FROM_STOPPING
  75. PROCESS_STATE_FATAL replaces
  76. PROCESS_STATE_CHANGE_FATAL_FROM_BACKOFF
  77. PROCESS_STATE_UNKNOWN replaces PROCESS_STATE_CHANGE_TO_UNKNOWN
  78. PROCESS_STATE replaces PROCESS_STATE_CHANGE
  79. The PROCESS_STATE_CHANGE_EXITED_OR_STOPPED abstract event is gone.
  80. All process state changes have at least "processname",
  81. "groupname", and "from_state" (the name of the previous state) in
  82. their serializations.
  83. PROCESS_STATE_EXITED additionaly has "expected" (1 or 0) and "pid"
  84. (the process id) in its serialization.
  85. PROCESS_STATE_RUNNING, PROCESS_STATE_STOPPING,
  86. PROCESS_STATE_STOPPED additionally have "pid" in their
  87. serializations.
  88. PROCESS_STATE_STARTING and PROCESS_STATE_BACKOFF have "tries" in
  89. their serialization (initially "0", bumped +1 each time a start
  90. retry happens).
  91. - Remove documentation from README.txt, point people to
  92. http://supervisord.org/manual/ .
  93. - The eventlistener request/response protocol has changed. OK/FAIL
  94. must now be wrapped in a RESULT envelope so we can use it for more
  95. specialized communications.
  96. Previously, to signify success, an event listener would write the
  97. string 'OK\n' to its stdout. To signify that the event was seen
  98. but couldn't be handled by the listener and should be rebuffered,
  99. an event listener would write the string 'FAIL\n' to its stdout.
  100. In the new protocol, the listener must write the string:
  101. RESULT {resultlen}\n{result}
  102. For example, to signify OK:
  103. RESULT 2\nOK
  104. To signify FAIL:
  105. RESULT 4\nFAIL
  106. See the scripts/sample_eventlistener.py script for an example.
  107. - To provide a hook point for custom results returned from event
  108. handlers (see above) the [eventlistener:x] configuration sections
  109. now accept a "result_handler=" parameter,
  110. e.g. "result_handler=supervisor.dispatchers:default_handler" (the
  111. default) or "handler=mypackage:myhandler". The keys are pkgutil
  112. "entry point" specifications (importable Python function names).
  113. Result handlers must be callables which accept two arguments: one
  114. named "event" which represents the event, and the other named
  115. "result", which represents the listener's result. A result
  116. handler either executes successfully or raises an exception. If
  117. it raises a supervisor.dispatchers.RejectEvent exception, the
  118. event will be rebuffered, and the eventhandler will be placed back
  119. into the ACKNOWLEDGED state. If it raises any other exception,
  120. the event handler will be placed in the UNKNOWN state. If it does
  121. not raise any exception, the event is considered successfully
  122. processed. A result handler's return value is ignored. Writing a
  123. result handler is a "in case of emergency break glass" sort of
  124. thing, it is not something to be used for arbitrary business code.
  125. In particular, handlers *must not block* for any appreciable
  126. amount of time.
  127. The 'standard' eventlistener result handler
  128. (supervisor.dispatchers:default_handler) does nothing if it
  129. receives an "OK" and will raise a
  130. supervisor.dispatchers.RejectEvent exception if it receives any
  131. other value.
  132. - Supervisord now emits TICK events, which happen every N seconds.
  133. Three types of TICK events are available: TICK_5 (every five
  134. seconds), TICK_60 (every minute), TICK_3600 (every hour). Event
  135. listeners may subscribe to one of these types of events to perform
  136. every-so-often processing. TICK events are subtypes of the EVENT
  137. type.
  138. - Get rid of OSX platform-specific memory monitor and replace with
  139. memmon.py, which works on both Linux and Mac OS. This script is
  140. now a console script named "memmon".
  141. - Allow "web handler" (the handler which receives http requests from
  142. browsers visiting the web UI of supervisor) to deal with POST requests.
  143. - RPC interface methods stopProcess(), stopProcessGroup(), and
  144. stopAllProcesses() now take an optional "wait" argument that defaults
  145. to True for parity with the start methods.
  146. 3.0a3
  147. - Supervisorctl now reports a better error message when the main
  148. supervisor XML-RPC namespace is not registered. Thanks to
  149. Mike Orr for reporting this. (Mike Naberezny)
  150. - Create 'scripts' directory within supervisor package, move
  151. 'pidproxy.py' there, and place sample event listener and comm
  152. event programs within the directory.
  153. - When an event notification is buffered (either because a listener
  154. rejected it or because all listeners were busy when we attempted
  155. to send it originally), we now rebuffer it in a way that will
  156. result in it being retried earlier than it used to be.
  157. - When a listener process exits (unexpectedly) before transitioning
  158. from the BUSY state, rebuffer the event that was being processed.
  159. - supervisorctl 'tail' command now accepts a trailing specifier:
  160. 'stderr' or 'stdout', which respectively, allow a user to tail the
  161. stderr or stdout of the named process. When this specifier is not
  162. provided, tail defaults to stdout.
  163. - supervisor 'clear' command now clears both stderr and stdout logs
  164. for the given process.
  165. - When a process encounters a spawn error as a result of a failed
  166. execve or when it cannot setuid to a given uid, it now puts this
  167. info into the process' stderr log rather than its stdout log.
  168. - The event listener protocol header now contains the 'server'
  169. identifier, the 'pool' that the event emanated from, and the
  170. 'poolserial' as well as the values it previously contained
  171. (version, event name, serial, and length). The server identifier
  172. is taken from the config file options value 'identifier', the
  173. 'pool' value is the name of the listener pool that this event
  174. emanates from, and the 'poolserial' is a serial number assigned to
  175. the event local to the pool that is processing it.
  176. - The event listener protocol header is now a sequence of key-value
  177. pairs rather than a list of positional values. Previously, a
  178. representative header looked like:
  179. SUPERVISOR3.0 PROCESS_COMMUNICATION_STDOUT 30 22\n
  180. Now it looks like:
  181. ver:3.0 server:supervisor serial:21 ...
  182. - Specific event payload serializations have changed. All event
  183. types that deal with processes now include the pid of the process
  184. that the event is describing. In event serialization "header"
  185. values, we've removed the space between the header name and the
  186. value and headers are now separated by a space instead of a line
  187. feed. The names of keys in all event types have had underscores
  188. removed.
  189. - Abandon the use of the Python stdlib 'logging' module for speed
  190. and cleanliness purposes. We've rolled our own.
  191. - Fix crash on start if AUTO logging is used with a max_bytes of
  192. zero for a process.
  193. - Improve process communication event performance.
  194. - The process config parameters 'stdout_capturefile' and
  195. 'stderr_capturefile' are no longer valid. They have been replaced
  196. with the 'stdout_capture_maxbytes' and 'stderr_capture_maxbytes'
  197. parameters, which are meant to be suffix-multiplied integers.
  198. They both default to zero. When they are zero, process
  199. communication event capturing is not performed. When either is
  200. nonzero, the value represents the maximum number of bytes that
  201. will be captured between process event start and end tags. This
  202. change was to support the fact that we no longer keep capture data
  203. in a separate file, we just use a FIFO in RAM to maintain capture
  204. info. For users whom don't care about process communication
  205. events, or whom haven't changed the defaults for
  206. 'stdout_capturefile' or 'stderr_capturefile', they needn't do
  207. anything to their configurations to deal with this change.
  208. - Log message levels have been normalized. In particular, process
  209. stdin/stdout is now logged at 'debug' level rather than at 'trace'
  210. level ('trace' level is now reserved for output useful typically
  211. for debugging supervisor itself). See 'Supervisor Log Levels' in
  212. README.txt for more info.
  213. - When an event is rebuffered (because all listeners are busy or a
  214. listener rejected the event), the rebuffered event is now inserted
  215. in the head of the listener event queue. This doesn't guarantee
  216. event emission in natural ordering, because if a listener rejects
  217. an event or dies while it's processing an event, it can take an
  218. arbitrary amount of time for the event to be rebuffered, and other
  219. events may be processed in the meantime. But if pool listeners
  220. never reject an event or don't die while processing an event, this
  221. guarantees that events will be emitted in the order that they were
  222. received because if all listeners are busy, the rebuffered event
  223. will be tried again "first" on the next go-around.
  224. - Removed EVENT_BUFFER_OVERFLOW event type.
  225. - The supervisorctl xmlrpc proxy can now communicate with
  226. supervisord using a persistent HTTP connection.
  227. - A new module "supervisor.childutils" was added. This module
  228. provides utilities for Python scripts which act as children of
  229. supervisord. Most notably, it contains an API method
  230. "getRPCInterface" allows you to obtain an xmlrpxlib ServerProxy
  231. that is willing to communicate with the parent supervisor. It
  232. also contains utility functions that allow for parsing of
  233. supervisor event listener protocol headers. A pair of scripts
  234. (loop_eventgen.py and loop_listener.py) were added to the script
  235. directory that serve as examples about how to use the childutils
  236. module.
  237. - A new envvar is added to child process environments:
  238. SUPERVISOR_SERVER_URL. This contains the server URL for the
  239. supervisord running the child.
  240. - An 'OK' URL was added at /ok.html which just returns the string
  241. 'OK' (can be used for up checks or speed checks via
  242. plain-old-HTTP).
  243. - An additional command-line option '--profile_options' is accepted
  244. by the supervisord script for developer use.
  245. supervisord -n -c sample.conf --profile_options=cumulative,calls
  246. The values are sort_stats options that can be passed to the
  247. standard Python profiler's PStats sort_stats method.
  248. When you exit supervisor, it will print Python profiling output to
  249. stdout.
  250. - If cElementTree is installed in the Python used to invoke
  251. supervisor, an alternate (faster, by about 2X) XML parser will be
  252. used to parse XML-RPC request bodies. cElementTree was added as
  253. an "extras_require" option in setup.py.
  254. - Added the ability to start, stop, and restart process groups to
  255. supervisorctl. To start a group, use "start groupname:*". To
  256. start multiple groups, use "start groupname1:* groupname2:*".
  257. Equivalent commands work for "stop" and "restart". You can mix and
  258. match short processnames, fullly-specified group:process names,
  259. and groupsplats on the same line for any of these commands.
  260. - Added 'directory' option to process config. If you set this
  261. option, supervisor will chdir to this directory before executing
  262. the child program (and thus it will be the child's cwd).
  263. - Added 'umask' option to process config. If you set this option,
  264. supervisor will set the umask of the child program. (Thanks to
  265. Ian Bicking for the suggestion).
  266. - A pair of scripts "osx_memmon_eventgen.py" and
  267. "osx_memmon_listener.py" have been added to the scripts directory.
  268. If they are used together as described in their comments,
  269. processes which are consuming "too much" memory will be restarted.
  270. The 'eventgen' script only works on OSX (my main development
  271. platform) but it should be trivially generalizable to other
  272. operating systems.
  273. - The long form "--configuration" (-c) command line option for
  274. supervisord was broken. Reported by Mike Orr. (Mike Naberezny)
  275. - New log level: BLAT (blather). We log all
  276. supervisor-internal-related debugging info here. Thanks to Mike
  277. Orr for the suggestion.
  278. - We now allow supervisor to listen on both a UNIX domain socket and
  279. an inet socket instead of making them mutually exclusive. As a
  280. result, the options "http_port", "http_username", "http_password",
  281. "sockchmod" and "sockchown" are no longer part of the
  282. '[supervisord]' section configuration. These have been supplanted
  283. by two other sections: '[unix_http_server]' and
  284. '[inet_http_server']. You'll need to insert one or the other
  285. (depending on whether you want to listen on a UNIX domain socket
  286. or a TCP socket respectively) or both into your supervisord.conf
  287. file. These sections have their own options (where applicable)
  288. for port, username, password, chmod, and chown. See README.txt
  289. for more information about these sections.
  290. - All supervisord command-line options related to "http_port",
  291. "http_username", "http_password", "sockchmod" and "sockchown" have
  292. been removed (see above point for rationale).
  293. - The option that *used* to be 'sockchown' within the
  294. '[supervisord]' section (and is now named 'chown' within the
  295. '[unix_http_server]' section) used to accept a dot-separated
  296. user.group value. The separator now must be a colon ":",
  297. e.g. "user:group". Unices allow for dots in usernames, so this
  298. change is a bugfix. Thanks to Ian Bicking for the bug report.
  299. - If a '-c' option is not specified on the command line, both
  300. supervisord and supervisorctl will search for one in the paths
  301. './supervisord.conf' , './etc/supervisord.conf' (relative to the
  302. current working dir when supervisord or supervisorctl is invoked)
  303. or in '/etc/supervisord.conf' (the old default path). These paths
  304. are searched in order, and supervisord and supervisorctl will use
  305. the first one found. If none are found, supervisor will fail to
  306. start.
  307. - The Python string expression '%(here)s' (referring to the
  308. directory in which the the configuration file was found) can be
  309. used within the following sections/options within the config file:
  310. unix_http_server:file
  311. supervisor:directory
  312. supervisor:logfile
  313. supervisor:pidfile
  314. supervisor:childlogdir
  315. supervisor:environment
  316. program:environment
  317. program:stdout_logfile
  318. program:stderr_logfile
  319. program:process_name
  320. program:command
  321. - The '--environment' aka '-b' option was removed from the list of
  322. available command-line switches to supervisord (use "A=1 B=2
  323. bin/supervisord" instead).
  324. - If the socket filename (the tail-end of the unix:// URL) was
  325. longer than 64 characters, supervisorctl would fail with an
  326. encoding error at startup.
  327. - The 'identifier' command-line argument was not functional.
  328. - Fixed http://www.plope.com/software/collector/215 (bad error
  329. message in supervisorctl when program command not found on PATH).
  330. - Some child processes may not have been shut down properly at
  331. supervisor shutdown time.
  332. - Move to ZPL-derived (but not ZPL) license availble from
  333. http://www.repoze.org/LICENSE.txt; it's slightly less restrictive
  334. than the ZPL (no servicemark clause).
  335. - Spurious errors related to unclosed files ("bad file descriptor",
  336. typically) were evident at supervisord "reload" time (when using
  337. the "reload" command from supervisorctl).
  338. - Updated ez_setup.py to one that knows about setuptools 0.6c7.
  339. 3.0a2
  340. - Fixed the README.txt example for defining the supervisor RPC
  341. interface in the configuration file. Thanks to Drew Perttula.
  342. - Fixed a bug where process communication events would not have the
  343. proper payload if the payload data was very short.
  344. - when supervisord attempted to kill a process with SIGKILL after
  345. the process was not killed within "stopwaitsecs" using a "normal"
  346. kill signal, supervisord would crash with an improper
  347. AssertionError. Thanks to Calvin Hendryx-Parker.
  348. - On Linux, Supervisor would consume too much CPU in an effective
  349. "busywait" between the time a subprocess exited and the time at
  350. which supervisor was notified of its exit status. Thanks to Drew
  351. Perttula.
  352. - RPC interface behavior change: if the RPC method
  353. "sendProcessStdin" is called against a process that has closed its
  354. stdin file descriptor (e.g. it has done the equivalent of
  355. "sys.stdin.close(); os.close(0)"), we return a NO_FILE fault
  356. instead of accepting the data.
  357. - Changed the semantics of the process configuration 'autorestart'
  358. parameter with respect to processes which move between the RUNNING
  359. and EXITED state. 'autorestart' was previously a boolean. Now
  360. it's a trinary, accepting one of 'false', 'unexpected', or 'true'.
  361. If it's 'false', a process will never be automatically restarted
  362. from the EXITED state. If it's 'unexpected', a process that
  363. enters the EXITED state will be automatically restarted if it
  364. exited with an exit code that was not named in the process
  365. config's 'exitcodes' list. If it's 'true', a process that enters
  366. the EXITED state will be automatically restarted unconditionally.
  367. The default is now 'unexpected' (it was previously 'true'). The
  368. readdition of this feature is a reversion of the behavior change
  369. note in the changelog notes for 3.0a1 that asserted we never cared
  370. about the process' exit status when determining whether to restart
  371. it or not.
  372. - setup.py develop (and presumably setup.py install) would fail
  373. under Python 2.3.3, because setuptools attempted to import
  374. 'splituser' from urllib2, and it didn't exist.
  375. - It's now possible to use 'setup.py install' and 'setup.py develop'
  376. on systems which do not have a C compiler if you set the
  377. environment variable "NO_MELD3_EXTENSION_MODULES=1" in the shell
  378. in which you invoke these commands (versions of meld3 > 0.6.1
  379. respect this envvar and do not try to compile optional C
  380. extensions when it's set).
  381. - The test suite would fail on Python versions <= 2.3.3 because
  382. the "assertTrue" and "assertFalse" methods of unittest.TestCase
  383. didn't exist in those versions.
  384. - The 'supervisorctl' and 'supervisord' wrapper scripts were disused
  385. in favor of using setuptools' 'console_scripts' entry point settings.
  386. - Documentation files and the sample configuration file are put into
  387. the generated supervisor egg's 'doc' directory.
  388. _ Using the web interface would cause fairly dramatic memory
  389. leakage. We now require a version of meld3 that does not appear
  390. to leak memory from its C extensions (0.6.3).
  391. 3.0a1
  392. - Default config file comment documented 10 secs as default for
  393. 'startsecs' value in process config, in reality it was 1 sec.
  394. Thanks to Christoph Zwerschke.
  395. - Make note of subprocess environment behavior in README.txt.
  396. Thanks to Christoph Zwerschke.
  397. - New "strip_ansi" config file option attempts to strip ANSI escape
  398. sequences from logs for smaller/more readable logs (submitted by
  399. Mike Naberezny).
  400. - The XML-RPC method supervisor.getVersion() has been renamed for
  401. clarity to supervisor.getAPIVersion(). The old name is aliased
  402. for compatibility but is deprecated and will be removed in a
  403. future version (Mike Naberezny).
  404. - Improved web interface styling (Mike Naberezny, Derek DeVries)
  405. - The XML-RPC method supervisor.startProcess() now checks that
  406. the file exists and is executable (Mike Naberezny).
  407. - Two environment variables, "SUPERVISOR_PROCESS_NAME" and
  408. "SUPERVISOR_PROCESS_GROUP" are set in the environment of child
  409. processes, representing the name of the process and group in
  410. supervisor's configuration.
  411. - Process state map change: a process may now move directly from the
  412. STARTING state to the STOPPING state (as a result of a stop
  413. request).
  414. - Behavior change: if 'autorestart' is true, even if a process exits
  415. with an "expected" exit code, it will still be restarted. In the
  416. immediately prior release of supervisor, this was true anyway, and
  417. no one complained, so we're going to consider that the "officially
  418. correct" behavior from now on.
  419. - Supervisor now logs subprocess stdout and stderr independently.
  420. The old program config keys "logfile", "logfile_backups" and
  421. "logfile_maxbytes" are superseded by "stdout_logfile",
  422. "stdout_logfile_backups", and "stdout_logfile_maxbytes". Added
  423. keys include "stderr_logfile", "stderr_logfile_backups", and
  424. "stderr_logfile_maxbytes". An additional "redirect_stderr" key is
  425. used to cause program stderr output to be sent to its stdin
  426. channel. The keys "log_stderr" and "log_stdout" have been
  427. removed.
  428. - '[program:x]' config file sections now represent "homgeneous
  429. process groups" instead of single processes. A "numprocs" key in
  430. the section represents the number of processes that are in the
  431. group. A "process_name" key in the section allows composition of
  432. the each process' name within the homogeneous group.
  433. - A new kind of config file section, '[group:x]' now exists,
  434. allowing users to group heterogeneous processes together into a
  435. process group that can be controlled as a unit from a client.
  436. - Supervisord now emits "events" at certain points in its normal
  437. operation. These events include supervisor state change events,
  438. process state change events, and "process communication events".
  439. - A new kind of config file section '[eventlistener:x]' now exists.
  440. Each section represents an "event listener pool", which is a
  441. special kind of homogeneous process group. Each process in the
  442. pool is meant to receive supervisor "events" via its stdin and
  443. perform some notification (e.g. send a mail, log, make an http
  444. request, etc.)
  445. - Supervisord can now capture data between special tokens in
  446. subprocess stdout/stderr output and emit a "process communications
  447. event" as a result.
  448. - Supervisor's XML-RPC interface may be extended arbitrarily by
  449. programmers. Additional top-level namespace XML-RPC interfaces
  450. can be added using the '[rpcinterface:foo]' declaration in the
  451. configuration file.
  452. - New 'supervisor'-namespace XML-RPC methods have been added:
  453. getAPIVersion (returns the XML-RPC API version, the older
  454. "getVersion" is now deprecated), "startProcessGroup" (starts all
  455. processes in a supervisor process group), "stopProcessGroup"
  456. (stops all processes in a supervisor process group), and
  457. "sendProcessStdin" (sends data to a process' stdin file
  458. descriptor).
  459. - 'supervisor'-namespace XML-RPC methods which previously accepted
  460. ony a process name as "name" (startProcess, stopProcess,
  461. getProcessInfo, readProcessLog, tailProcessLog, and
  462. clearProcessLog) now accept a "name" which may contain both the
  463. process name and the process group name in the form
  464. 'groupname:procname'. For backwards compatibility purposes,
  465. "simple" names will also be accepted but will be expanded
  466. internally (e.g. if "foo" is sent as a name, it will be expanded
  467. to "foo:foo", representing the foo process within the foo process
  468. group).
  469. - 2.X versions of supervisorctl will work against supervisor 3.0
  470. servers in a degraded fashion, but 3.X versions of supervisorctl
  471. will not work at all against supervisor 2.X servers.
  472. Known issues:
  473. - supervisorctl and the web interface do not yet allow you to stop
  474. / start / restart a process group as a unit.
  475. - supervisorctl and the web interface do not allow you to tail or
  476. otherwise examine stderr log files of processes.
  477. - buffered event notifications may be lost at supervisor shutdown
  478. or restart time.
  479. Acknowledgements:
  480. Maintainable Software (http://www.maintainable.com) contracted
  481. Agendless Consulting to add the event notification features and
  482. extensible XML-RPC namespaces feature to supervisor.
  483. 2.2b1
  484. - Individual program configuration sections can now specify an
  485. environment.
  486. - Added a 'version' command to supervisorctl. This returns the
  487. version of the supervisor2 package which the remote supervisord
  488. process is using.
  489. 2.1
  490. - When supervisord was invoked more than once, and its configuration
  491. was set up to use a UNIX domain socket as the HTTP server, the
  492. socket file would be erased in error. The symptom of this was
  493. that a subsequent invocation of supervisorctl could not find the
  494. socket file, so the process could not be controlled (it and all of
  495. its subprocesses would need to be killed by hand).
  496. - Close subprocess file descriptors properly when a subprocess exits
  497. or otherwise dies. This should result in fewer "too many open
  498. files to spawn foo" messages when supervisor is left up for long
  499. periods of time.
  500. - When a process was not killable with a "normal" signal at shutdown
  501. time, too many "INFO: waiting for x to die" messages would be sent
  502. to the log until we ended up killing the process with a SIGKILL.
  503. Now a maximum of one every three seconds is sent up until SIGKILL
  504. time. Thanks to Ian Bicking.
  505. - Add an assertion: we never want to try to marshal None to XML-RPC
  506. callers. Issue 223 in the collector from vgatto indicates that
  507. somehow a supervisor XML-RPC method is returning None (which
  508. should never happen), but I cannot identify how. Maybe the
  509. assertion will give us more clues if it happens again.
  510. - Supervisor would crash when run under Python 2.5 because the
  511. xmlrpclib.Transport class in Python 2.5 changed in a
  512. backward-incompatible way. Thanks to Eric Westra for the bug
  513. report and a fix.
  514. - Tests now pass under Python 2.5.
  515. - Better supervisorctl reporting on stop requests that have a FAILED
  516. status.
  517. - Removed duplicated code (readLog/readMainLog), thanks to Mike
  518. Naberezny.
  519. - Added tailProcessLog command to the XML-RPC API. It provides a
  520. more efficient way to tail logs than readProcessLog(). Use
  521. readProcessLog() to read chunks and tailProcessLog() to tail.
  522. (thanks to Mike Naberezny).
  523. 2.1b2
  524. - Added new tailProcessLog() command to the XML-RPC API that
  525. is more efficient for just tailing than the existing
  526. readProcessLog() command (Mike Naberezny).
  527. 2.1b1
  528. - "supervisord -h" and "supervisorctl -h" did not work (traceback
  529. instead of showing help view (thanks to Damjan from Macedonia for
  530. the bug report).
  531. - Processes which started successfully after failing to start
  532. initially are no longer reported in BACKOFF state once they are
  533. started successfully (thanks to Damjan from Macdonia for the bug
  534. report).
  535. - Add new 'maintail' command to supervisorctl shell, which allows
  536. you to tail the 'main' supervisor log. This uses a new
  537. readMainLog xmlrpc API.
  538. - Various process-state-transition related changes, all internal.
  539. README.txt updated with new state transition map.
  540. - startProcess and startAllProcesses xmlrpc APIs changed: instead of
  541. accepting a timeout integer, these accept a wait boolean (timeout
  542. is implied by process' "startsecs" configuration). If wait is
  543. False, do not wait for startsecs.
  544. Known issues:
  545. Code does not match state transition map. Processes which are
  546. configured as autorestarting which start "successfully" but
  547. subsequently die after 'startsecs' go through the transitions
  548. RUNNING -> BACKOFF -> STARTING instead of the correct transitions
  549. RUNNING -> EXITED -> STARTING. This has no real negative effect,
  550. but should be fixed for correctness.
  551. 2.0
  552. - pidfile written in daemon mode had incorrect pid.
  553. - supervisorctl: tail (non -f) did not pass through proper error
  554. messages when supplied by the server.
  555. - Log signal name used to kill processes at debug level.
  556. - supervisorctl "tail -f" didn't work with supervisorctl sections
  557. configured with an absolute unix:// URL
  558. - New "environment" config file option allows you to add environment
  559. variable values to supervisord environment from config file.
  560. 2.0b1
  561. - fundamental rewrite based on 1.0.6, use distutils (only) for
  562. installation, use ConfigParser rather than ZConfig, use HTTP for
  563. wire protocol, web interface, less lies in supervisorctl.