CHANGES.txt 32 KB

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