CHANGES.txt 34 KB

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