CHANGES.txt 38 KB

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