CHANGES.txt 32 KB

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