CHANGES.txt 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334
  1. Next release
  2. ------------
  3. - The behavior of the program option ``user`` has changed. In all previous
  4. versions, if ``supervisord`` failed to switch to the user, a warning would
  5. be sent to the stderr log but the child process would still be spawned.
  6. This means that a mistake in the config file could result in a child
  7. process being unintentionally spawned as root. Now, ``supervisord`` will
  8. not spawn the child unless it was able to successfully switch to the user.
  9. Thanks to Igor Partola for reporting this issue.
  10. - If a user specified in the config file does not exist on the system,
  11. ``supervisord`` will now print an error and refuse to start.
  12. - Reverted a change to logging introduced in 3.0b1 that was intended to allow
  13. multiple processes to log to the same file with the rotating log handler.
  14. The implementation caused supervisord to crash during reload and to leak
  15. file handles. Also, since log rotation options are given on a per-program
  16. basis, impossible configurations could be created (conflicting rotation
  17. options for the same file). Given this and that supervisord now has syslog
  18. support, it was decided to remove this feature. A warning was added to the
  19. documentation that two processes may not log to the same file.
  20. - Fixed a bug where parsing ``command=`` could cause supervisord to crash if
  21. shlex.split() fails, such as a bad quoting. Patch by Scott Wilson.
  22. - It is now possible to use ``supervisorctl`` on a machine with no
  23. ``supervisord.conf`` file by supplying the connection information in
  24. command line options. Patch by Jens Rantil.
  25. - Fixed a bug where supervisord would crash if the syslog handler was used
  26. and supervisord received SIGUSR2 (log reopen request).
  27. - Fixed an XML-RPC bug where calling supervisor.getProcessInfo() with a bad
  28. name would cause a 500 Internal Server Error rather than the returning
  29. a BAD_NAME fault.
  30. - Added a favicon to the web interface. Patch by Caio Ariede.
  31. - Fixed a test failure due to incorrect handling of daylight savings time
  32. in the childutils tests. Patch by Ildar Hizbulin.
  33. - Fixed a number of pyflakes warnings for unused variables, imports, and
  34. dead code. Patch by Philippe Ombredanne.
  35. 3.0b1 (2012-09-10)
  36. ------------------
  37. - Fixed a bug where parsing ``environment=`` did not verify that key/value
  38. pairs were correctly separated. Patch by Martijn Pieters.
  39. - Fixed a bug in the HTTP server code that could cause unnecessary delays
  40. when sending large responses. Patch by Philip Zeyliger.
  41. - When supervisord starts up as root, if the ``-c`` flag was not provided, a
  42. warning is now emitted to the console. Rationale: supervisord looks in the
  43. current working directory for a ``supervisord.conf`` file; someone might
  44. trick the root user into starting supervisord while cd'ed into a directory
  45. that has a rogue ``supervisord.conf``.
  46. - A warning was added to the documentation about the security implications of
  47. starting supervisord without the ``-c`` flag.
  48. - Add a boolean program option ``stopasgroup``, defaulting to false.
  49. When true, the flag causes supervisor to send the stop signal to the
  50. whole process group. This is useful for programs, such as Flask in debug
  51. mode, that do not propagate stop signals to their children, leaving them
  52. orphaned.
  53. - Python 2.3 is no longer supported. The last version that supported Python
  54. 2.3 is Supervisor 3.0a12.
  55. - Removed the unused "supervisor_rpc" entry point from setup.py.
  56. - Fixed a bug in the rotating log handler that would cause unexpected
  57. results when two processes were set to log to the same file. Patch
  58. by Whit Morriss.
  59. - Fixed a bug in config file reloading where each reload could leak memory
  60. because a list of warning messages would be appended but never cleared.
  61. Patch by Philip Zeyliger.
  62. - Added a new Syslog log handler. Thanks to Denis Bilenko, Nathan L. Smith,
  63. and Jason R. Coombs, who each contributed to the patch.
  64. - Put all change history into a single file (CHANGES.txt).
  65. 3.0a12 (2011-12-06)
  66. -------------------
  67. - Released to replace a broken 3.0a11 package where non-Python files were
  68. not included in the package.
  69. 3.0a11 (2011-12-06)
  70. -------------------
  71. - Added a new file, ``PLUGINS.rst``, with a listing of third-party plugins
  72. for Supervisor. Contributed by Jens Rantil.
  73. - The ``pid`` command in supervisorctl can now be used to retrieve the PIDs
  74. of child processes. See ``help pid``. Patch by Gregory Wisniewski.
  75. - Added a new ``host_node_name`` expansion that will be expanded to the
  76. value returned by Python's ``platform.node`` (see
  77. http://docs.python.org/library/platform.html#platform.node).
  78. Patch by Joseph Kondel.
  79. - Fixed a bug in the web interface where pages over 64K would be truncated.
  80. Thanks to Drew Perttula and Timothy Jones for reporting this.
  81. - Renamed ``README.txt`` to ``README.rst`` so GitHub renders the file as
  82. ReStructuredText.
  83. - The XML-RPC server is now compatible with clients that do not send empty
  84. <params> when there are no parameters for the method call. Thanks to
  85. Johannes Becker for reporting this.
  86. - Fixed ``supervisorctl --help`` output to show the correct program name.
  87. - The behavior of the configuration options ``minfds`` and ``minprocs`` has
  88. changed. Previously, if a hard limit was less than ``minfds`` or
  89. ``minprocs``, supervisord would unconditionally abort with an error. Now,
  90. supervisord will attempt to raise the hard limit. This may succeed if
  91. supervisord is run as root, otherwise the error is printed as before.
  92. Patch by Benoit Sigoure.
  93. - Add a boolean program option ``killasgroup``, defaulting to false,
  94. if true when resorting to send SIGKILL to stop/terminate the process
  95. send it to its whole process group instead to take care of possible
  96. children as well and not leave them behind. Patch by Samuele Pedroni.
  97. - Environment variables may now be used in the configuration file
  98. for options that support string expansion. Patch by Aleksey Sivokon.
  99. - Fixed a race condition where supervisord might not act on a signal sent
  100. to it. Thanks to Adar Dembo for reporting the issue and supplying the
  101. initial patch.
  102. - Updated the output of ``echo_supervisord_conf`` to fix typos and
  103. improve comments. Thanks to Jens Rantil for noticing these.
  104. - Fixed a possible 500 Server Error from the web interface. This was
  105. observed when using Supervisor on a domain socket behind Nginx, where
  106. Supervisor would raise an exception because REMOTE_ADDR was not set.
  107. Patch by David Bennett.
  108. 3.0a10 (2011-03-30)
  109. -------------------
  110. - Fixed the stylesheet of the web interface so the footer line won't overlap
  111. a long process list. Thanks to Derek DeVries for the patch.
  112. - Allow rpc interface plugins to register new events types.
  113. - Bug fix for FCGI sockets not getting cleaned up when the ``reload`` command
  114. is issued from supervisorctl. Also, the default behavior has changed for
  115. FCGI sockets. They are now closed whenever the number of running processes
  116. in a group hits zero. Previously, the sockets were kept open unless a
  117. group-level stop command was issued.
  118. - Better error message when HTTP server cannot reverse-resolve a hostname to
  119. an IP address. Previous behavior: show a socket error. Current behavior:
  120. spit out a suggestion to stdout.
  121. - Environment variables set via ``environment=`` value within
  122. ``[supervisord]`` section had no effect. Thanks to Wyatt Baldwin
  123. for a patch.
  124. - Fix bug where stopping process would cause process output that happened
  125. after the stop request was issued to be lost. See
  126. https://github.com/Supervisor/supervisor/issues/11.
  127. - Moved 2.X change log entries into ``HISTORY.txt``.
  128. - Converted ``CHANGES.txt`` and ``README.txt`` into proper ReStructuredText
  129. and included them in the ``long_description`` in ``setup.py``.
  130. - Added a tox.ini to the package (run via ``tox`` in the package dir). Tests
  131. supervisor on multiple Python versions.
  132. 3.0a9 (2010-08-13)
  133. ------------------
  134. - Use rich comparison methods rather than __cmp__ to sort process configs and
  135. process group configs to better straddle Python versions. (thanks to
  136. Jonathan Riboux for identifying the problem and supplying an initial
  137. patch).
  138. - Fixed test_supervisorctl.test_maintail_dashf test for Python 2.7. (thanks
  139. to Jonathan Riboux for identifying the problem and supplying an initial
  140. patch).
  141. - Fixed the way that supervisor.datatypes.url computes a "good" URL
  142. for compatibility with Python 2.7 and Python >= 2.6.5. URLs with
  143. bogus "schemes://" will now be accepted as a version-straddling
  144. compromise (before they were rejected before supervisor would
  145. start). (thanks to Jonathan Riboux for identifying the problem
  146. and supplying an initial patch).
  147. - Add a ``-v`` / ``--version`` option to supervisord: Print the
  148. supervisord version number out to stdout and exit. (Roger Hoover)
  149. - Import iterparse from xml.etree when available (eg: Python 2.6). Patch
  150. by Sidnei da Silva.
  151. - Fixed the url to the supervisor-users mailing list. Patch by
  152. Sidnei da Silva
  153. - When parsing "environment=" in the config file, changes introduced in
  154. 3.0a8 prevented Supervisor from parsing some characters commonly
  155. found in paths unless quoting was used as in this example::
  156. environment=HOME='/home/auser'
  157. Supervisor once again allows the above line to be written as::
  158. environment=HOME=/home/auser
  159. Alphanumeric characters, "_", "/", ".", "+", "-", "(", ")", and ":" can all
  160. be used as a value without quoting. If any other characters are needed in
  161. the value, please quote it as in the first example above. Thanks to Paul
  162. Heideman for reporting this issue.
  163. - Supervisor will now look for its config file in locations relative to the
  164. executable path, allowing it to be used more easily in virtual
  165. environments. If sys.argv[0] is ``/path/to/venv/bin/supervisorctl``,
  166. supervisor will now look for it's config file in
  167. ``/path/to/venv/etc/supervisord.conf`` and
  168. ``/path/to/venv/supervisord.conf`` in addition to the other standard
  169. locations. Patch by Chris Rossi.
  170. 3.0a8 (2010-01-20)
  171. ------------------
  172. - Don't cleanup file descriptors on first supervisord invocation:
  173. this is a lame workaround for Snow Leopard systems that use
  174. libdispatch and are receiving "Illegal instruction" messages at
  175. supervisord startup time. Restarting supervisord via
  176. "supervisorctl restart" may still cause a crash on these systems.
  177. - Got rid of Medusa hashbang headers in various files to ease RPM
  178. packaging.
  179. - Allow umask to be 000 (patch contributed by Rowan Nairn).
  180. - Fixed a bug introduced in 3.0a7 where supervisorctl wouldn't ask
  181. for a username/password combination properly from a
  182. password-protected supervisord if it wasn't filled in within the
  183. "[supervisorctl]" section username/password values. It now
  184. properly asks for a username and password.
  185. - Fixed a bug introduced in 3.0a7 where setup.py would not detect the
  186. Python version correctly. Patch by Daniele Paolella.
  187. - Fixed a bug introduced in 3.0a7 where parsing a string of key/value
  188. pairs failed on Python 2.3 due to use of regular expression syntax
  189. introduced in Python 2.4.
  190. - Removed the test suite for the ``memmon`` console script, which was
  191. moved to the Superlance package in 3.0a7.
  192. - Added release dates to CHANGES.txt.
  193. - Reloading the config for an fcgi process group did not close the fcgi
  194. socket - now, the socket is closed whenever the group is stopped as a unit
  195. (including during config update). However, if you stop all the processes
  196. in a group individually, the socket will remain open to allow for graceful
  197. restarts of FCGI daemons. (Roger Hoover)
  198. - Rereading the config did not pick up changes to the socket parameter in a
  199. fcgi-program section. (Roger Hoover)
  200. - Made a more friendly exception message when a FCGI socket cannot be
  201. created. (Roger Hoover)
  202. - Fixed a bug where the --serverurl option of supervisorctl would not
  203. accept a URL with a "unix" scheme. (Jason Kirtland)
  204. - Running the tests now requires the "mock" package. This dependency has
  205. been added to "tests_require" in setup.py. (Roger Hoover)
  206. - Added support for setting the ownership and permissions for an FCGI socket.
  207. This is done using new "socket_owner" and "socket_mode" options in an
  208. [fcgi-program:x] section. See the manual for details. (Roger Hoover)
  209. - Fixed a bug where the FCGI socket reference count was not getting
  210. decremented on spawn error. (Roger Hoover)
  211. - Fixed a Python 2.6 deprecation warning on use of the "sha" module.
  212. - Updated ez_setup.py to one that knows about setuptools 0.6c11.
  213. - Running "supervisorctl shutdown" no longer dumps a Python backtrace
  214. when it can't connect to supervisord on the expected socket. Thanks
  215. to Benjamin Smith for reporting this.
  216. - Removed use of collections.deque in our bundled version of asynchat
  217. because it broke compatibility with Python 2.3.
  218. - The sample configuration output by "echo_supervisord_conf" now correctly
  219. shows the default for "autorestart" as "unexpected". Thanks to
  220. William Dode for noticing it showed the wrong value.
  221. 3.0a7 (2009-05-24)
  222. ------------------
  223. - We now bundle our own patched version of Medusa contributed by Jason
  224. Kirtland to allow Supervisor to run on Python 2.6. This was done
  225. because Python 2.6 introduced backwards incompatible changes to
  226. asyncore and asynchat in the stdlib.
  227. - The console script ``memmon``, introduced in Supervisor 3.0a4, has
  228. been moved to Superlance (http://pypi.python.org/pypi/superlance).
  229. The Superlance package contains other useful monitoring tools designed
  230. to run under Supervisor.
  231. - Supervisorctl now correctly interprets all of the error codes that can
  232. be returned when starting a process. Patch by Francesc Alted.
  233. - New ``stdout_events_enabled`` and ``stderr_events_enabled`` config options
  234. have been added to the ``[program:x]``, ``[fcgi-program:x]``, and
  235. ``[eventlistener:x]`` sections. These enable the emitting of new
  236. PROCESS_LOG events for a program. If unspecified, the default is False.
  237. If enabled for a subprocess, and data is received from the stdout or
  238. stderr of the subprocess while not in the special capture mode used by
  239. PROCESS_COMMUNICATION, an event will be emitted.
  240. Event listeners can subscribe to either PROCESS_LOG_STDOUT or
  241. PROCESS_LOG_STDERR individually, or PROCESS_LOG for both.
  242. - Values for subprocess environment variables specified with environment=
  243. in supervisord.conf can now be optionally quoted, allowing them to
  244. contain commas. Patch by Tim Godfrey.
  245. - Added a new event type, REMOTE_COMMUNICATION, that is emitted by a new
  246. RPC method, supervisor.sendRemoteCommEvent().
  247. - Patch for bug #268 (KeyError on ``here`` expansion for
  248. stdout/stderr_logfile) from David E. Kindred.
  249. - Add ``reread``, ``update``, and ``avail`` commands based on Anders
  250. Quist's ``online_config_reload.diff`` patch. This patch extends
  251. the "add" and "drop" commands with automagical behavior::
  252. In supervisorctl:
  253. supervisor> status
  254. bar RUNNING pid 14864, uptime 18:03:42
  255. baz RUNNING pid 23260, uptime 0:10:16
  256. foo RUNNING pid 14866, uptime 18:03:42
  257. gazonk RUNNING pid 23261, uptime 0:10:16
  258. supervisor> avail
  259. bar in use auto 999:999
  260. baz in use auto 999:999
  261. foo in use auto 999:999
  262. gazonk in use auto 999:999
  263. quux avail auto 999:999
  264. Now we add this to our conf:
  265. [group:zegroup]
  266. programs=baz,gazonk
  267. Then we reread conf:
  268. supervisor> reread
  269. baz: disappeared
  270. gazonk: disappeared
  271. quux: available
  272. zegroup: available
  273. supervisor> avail
  274. bar in use auto 999:999
  275. foo in use auto 999:999
  276. quux avail auto 999:999
  277. zegroup:baz avail auto 999:999
  278. zegroup:gazonk avail auto 999:999
  279. supervisor> status
  280. bar RUNNING pid 14864, uptime 18:04:18
  281. baz RUNNING pid 23260, uptime 0:10:52
  282. foo RUNNING pid 14866, uptime 18:04:18
  283. gazonk RUNNING pid 23261, uptime 0:10:52
  284. The magic make-it-so command:
  285. supervisor> update
  286. baz: stopped
  287. baz: removed process group
  288. gazonk: stopped
  289. gazonk: removed process group
  290. zegroup: added process group
  291. quux: added process group
  292. supervisor> status
  293. bar RUNNING pid 14864, uptime 18:04:43
  294. foo RUNNING pid 14866, uptime 18:04:43
  295. quux RUNNING pid 23561, uptime 0:00:02
  296. zegroup:baz RUNNING pid 23559, uptime 0:00:02
  297. zegroup:gazonk RUNNING pid 23560, uptime 0:00:02
  298. supervisor> avail
  299. bar in use auto 999:999
  300. foo in use auto 999:999
  301. quux in use auto 999:999
  302. zegroup:baz in use auto 999:999
  303. zegroup:gazonk in use auto 999:999
  304. - Fix bug with symptom "KeyError: 'process_name'" when using a logfile name
  305. including documented``process_name`` Python string expansions.
  306. - Tab completions in the supervisorctl shell, and a foreground mode for
  307. Supervisor, implemented as a part of GSoC. The supervisorctl program now
  308. has a ``fg`` command, which makes it possible to supply inputs to a
  309. process, and see its output/error stream in real time.
  310. - Process config reloading implemented by Anders Quist. The
  311. supervisorctl program now has the commands "add" and "drop".
  312. "add <programname>" adds the process group implied by <programname>
  313. in the config file. "drop <programname>" removes the process
  314. group from the running configuration (it must already be stopped).
  315. This makes it possible to add processes to and remove processes from
  316. a running supervisord without restarting the supervisord process.
  317. - Fixed a bug where opening the HTTP servers would fail silently
  318. for socket errors other than errno.EADDRINUSE.
  319. - Thanks to Dave Peticolas, using "reload" against a supervisord
  320. that is running in the background no longer causes supervisord
  321. to crash.
  322. - Configuration options for logfiles now accept mixed case reserved
  323. words (e.g. "AUTO" or "auto") for consistency with other options.
  324. - childutils.eventdata was buggy, it could not deal with carriage returns
  325. in data. See http://www.plope.com/software/collector/257. Thanks
  326. to Ian Bicking.
  327. - Per-process exitcodes= configuration now will not accept exit
  328. codes that are not 8-bit unsigned integers (supervisord will not
  329. start when one of the exit codes is outside the range of 0 - 255).
  330. - Per-process ``directory`` value can now contain expandable values like
  331. ``%(here)s``. (See http://www.plope.com/software/collector/262).
  332. - Accepted patch from Roger Hoover to allow for a new sort of
  333. process group: "fcgi-program". Adding one of these to your
  334. supervisord.conf allows you to control fastcgi programs. FastCGI
  335. programs cannot belong to heterogenous groups.
  336. The configuration for FastCGI programs is the same as regular programs
  337. except an additional "socket" parameter. Substitution happens on the
  338. socket parameter with the ``here`` and ``program_name`` variables::
  339. [fcgi-program:fcgi_test]
  340. ;socket=tcp://localhost:8002
  341. socket=unix:///path/to/fcgi/socket
  342. - Supervisorctl now supports a plugin model for supervisorctl
  343. commands.
  344. - Added the ability to retrieve supervisord's own pid through
  345. supervisor.getPID() on the XML-RPC interface or a new
  346. "pid" command on supervisorctl.
  347. 3.0a6 (2008-04-07)
  348. ------------------
  349. - The RotatingFileLogger had a race condition in its doRollover
  350. method whereby a file might not actually exist despite a call to
  351. os.path.exists on the line above a place where we try to remove
  352. it. We catch the exception now and ignore the missing file.
  353. 3.0a5 (2008-03-13)
  354. ------------------
  355. - Supervisorctl now supports persistent readline history. To
  356. enable, add "history_file = <pathname>" to the ``[supervisorctl]``
  357. section in your supervisord.conf file.
  358. - Multiple commands may now be issued on one supervisorctl command
  359. line, e.g. "restart prog; tail -f prog". Separate commands with a
  360. single semicolon; they will be executed in order as you would
  361. expect.
  362. 3.0a4 (2008-01-30)
  363. ------------------
  364. - 3.0a3 broke Python 2.3 backwards compatibility.
  365. - On Debian Sarge, one user reported that a call to
  366. options.mktempfile would fail with an "[Errno 9] Bad file
  367. descriptor" at supervisord startup time. I was unable to
  368. reproduce this, but we found a workaround that seemed to work for
  369. him and it's included in this release. See
  370. http://www.plope.com/software/collector/252 for more information.
  371. Thanks to William Dode.
  372. - The fault ``ALREADY_TERMINATED`` has been removed. It was only raised by
  373. supervisor.sendProcessStdin(). That method now returns ``NOT_RUNNING``
  374. for parity with the other methods. (Mike Naberezny)
  375. - The fault TIMED_OUT has been removed. It was not used.
  376. - Supervisor now depends on meld3 0.6.4, which does not compile its
  377. C extensions by default, so there is no more need to faff around
  378. with NO_MELD3_EXTENSION_MODULES during installation if you don't
  379. have a C compiler or the Python development libraries on your
  380. system.
  381. - Instead of making a user root around for the sample.conf file,
  382. provide a convenience command "echo_supervisord_conf", which he can
  383. use to echo the sample.conf to his terminal (and redirect to a file
  384. appropriately). This is a new user convenience (especially one who
  385. has no Python experience).
  386. - Added ``numprocs_start`` config option to ``[program:x]`` and
  387. ``[eventlistener:x]`` sections. This is an offset used to compute
  388. the first integer that ``numprocs`` will begin to start from.
  389. Contributed by Antonio Beamud Montero.
  390. - Added capability for ``[include]`` config section to config format.
  391. This section must contain a single key "files", which must name a
  392. space-separated list of file globs that will be included in
  393. supervisor's configuration. Contributed by Ian Bicking.
  394. - Invoking the ``reload`` supervisorctl command could trigger a bug in
  395. supervisord which caused it to crash. See
  396. http://www.plope.com/software/collector/253 . Thanks to William Dode for
  397. a bug report.
  398. - The ``pidproxy`` script was made into a console script.
  399. - The ``password`` value in both the ``[inet_http_server]`` and
  400. ``[unix_http_server]`` sections can now optionally be specified as a SHA
  401. hexdigest instead of as cleartext. Values prefixed with ``{SHA}`` will be
  402. considered SHA hex digests. To encrypt a password to a form suitable for
  403. pasting into the configuration file using Python, do, e.g.::
  404. >>> import sha
  405. >>> '{SHA}' + sha.new('thepassword').hexdigest()
  406. '{SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d'
  407. - The subtypes of the events PROCESS_STATE_CHANGE (and
  408. PROCESS_STATE_CHANGE itself) have been removed, replaced with a
  409. simpler set of PROCESS_STATE subscribable event types.
  410. The new event types are:
  411. PROCESS_STATE_STOPPED
  412. PROCESS_STATE_EXITED
  413. PROCESS_STATE_STARTING
  414. PROCESS_STATE_STOPPING
  415. PROCESS_STATE_BACKOFF
  416. PROCESS_STATE_FATAL
  417. PROCESS_STATE_RUNNING
  418. PROCESS_STATE_UNKNOWN
  419. PROCESS_STATE # abstract
  420. PROCESS_STATE_STARTING replaces:
  421. PROCESS_STATE_CHANGE_STARTING_FROM_STOPPED
  422. PROCESS_STATE_CHANGE_STARTING_FROM_BACKOFF
  423. PROCESS_STATE_CHANGE_STARTING_FROM_EXITED
  424. PROCESS_STATE_CHANGE_STARTING_FROM_FATAL
  425. PROCESS_STATE_RUNNING replaces
  426. PROCESS_STATE_CHANGE_RUNNING_FROM_STARTED
  427. PROCESS_STATE_BACKOFF replaces
  428. PROCESS_STATE_CHANGE_BACKOFF_FROM_STARTING
  429. PROCESS_STATE_STOPPING replaces:
  430. PROCESS_STATE_CHANGE_STOPPING_FROM_RUNNING
  431. PROCESS_STATE_CHANGE_STOPPING_FROM_STARTING
  432. PROCESS_STATE_EXITED replaces
  433. PROCESS_STATE_CHANGE_EXITED_FROM_RUNNING
  434. PROCESS_STATE_STOPPED replaces
  435. PROCESS_STATE_CHANGE_STOPPED_FROM_STOPPING
  436. PROCESS_STATE_FATAL replaces
  437. PROCESS_STATE_CHANGE_FATAL_FROM_BACKOFF
  438. PROCESS_STATE_UNKNOWN replaces PROCESS_STATE_CHANGE_TO_UNKNOWN
  439. PROCESS_STATE replaces PROCESS_STATE_CHANGE
  440. The PROCESS_STATE_CHANGE_EXITED_OR_STOPPED abstract event is gone.
  441. All process state changes have at least "processname",
  442. "groupname", and "from_state" (the name of the previous state) in
  443. their serializations.
  444. PROCESS_STATE_EXITED additionaly has "expected" (1 or 0) and "pid"
  445. (the process id) in its serialization.
  446. PROCESS_STATE_RUNNING, PROCESS_STATE_STOPPING,
  447. PROCESS_STATE_STOPPED additionally have "pid" in their
  448. serializations.
  449. PROCESS_STATE_STARTING and PROCESS_STATE_BACKOFF have "tries" in
  450. their serialization (initially "0", bumped +1 each time a start
  451. retry happens).
  452. - Remove documentation from README.txt, point people to
  453. http://supervisord.org/manual/ .
  454. - The eventlistener request/response protocol has changed. OK/FAIL
  455. must now be wrapped in a RESULT envelope so we can use it for more
  456. specialized communications.
  457. Previously, to signify success, an event listener would write the string
  458. ``OK\n`` to its stdout. To signify that the event was seen but couldn't
  459. be handled by the listener and should be rebuffered, an event listener
  460. would write the string ``FAIL\n`` to its stdout.
  461. In the new protocol, the listener must write the string::
  462. RESULT {resultlen}\n{result}
  463. For example, to signify OK::
  464. RESULT 2\nOK
  465. To signify FAIL::
  466. RESULT 4\nFAIL
  467. See the scripts/sample_eventlistener.py script for an example.
  468. - To provide a hook point for custom results returned from event
  469. handlers (see above) the [eventlistener:x] configuration sections
  470. now accept a "result_handler=" parameter,
  471. e.g. "result_handler=supervisor.dispatchers:default_handler" (the
  472. default) or "handler=mypackage:myhandler". The keys are pkgutil
  473. "entry point" specifications (importable Python function names).
  474. Result handlers must be callables which accept two arguments: one
  475. named "event" which represents the event, and the other named
  476. "result", which represents the listener's result. A result
  477. handler either executes successfully or raises an exception. If
  478. it raises a supervisor.dispatchers.RejectEvent exception, the
  479. event will be rebuffered, and the eventhandler will be placed back
  480. into the ACKNOWLEDGED state. If it raises any other exception,
  481. the event handler will be placed in the UNKNOWN state. If it does
  482. not raise any exception, the event is considered successfully
  483. processed. A result handler's return value is ignored. Writing a
  484. result handler is a "in case of emergency break glass" sort of
  485. thing, it is not something to be used for arbitrary business code.
  486. In particular, handlers *must not block* for any appreciable
  487. amount of time.
  488. The standard eventlistener result handler
  489. (supervisor.dispatchers:default_handler) does nothing if it receives an
  490. "OK" and will raise a supervisor.dispatchers.RejectEvent exception if it
  491. receives any other value.
  492. - Supervisord now emits TICK events, which happen every N seconds.
  493. Three types of TICK events are available: TICK_5 (every five
  494. seconds), TICK_60 (every minute), TICK_3600 (every hour). Event
  495. listeners may subscribe to one of these types of events to perform
  496. every-so-often processing. TICK events are subtypes of the EVENT
  497. type.
  498. - Get rid of OSX platform-specific memory monitor and replace with
  499. memmon.py, which works on both Linux and Mac OS. This script is
  500. now a console script named "memmon".
  501. - Allow "web handler" (the handler which receives http requests from
  502. browsers visiting the web UI of supervisor) to deal with POST requests.
  503. - RPC interface methods stopProcess(), stopProcessGroup(), and
  504. stopAllProcesses() now take an optional "wait" argument that defaults
  505. to True for parity with the start methods.
  506. 3.0a3 (2007-10-02)
  507. ------------------
  508. - Supervisorctl now reports a better error message when the main supervisor
  509. XML-RPC namespace is not registered. Thanks to Mike Orr for reporting
  510. this. (Mike Naberezny)
  511. - Create ``scripts`` directory within supervisor package, move
  512. ``pidproxy.py`` there, and place sample event listener and comm event
  513. programs within the directory.
  514. - When an event notification is buffered (either because a listener rejected
  515. it or because all listeners were busy when we attempted to send it
  516. originally), we now rebuffer it in a way that will result in it being
  517. retried earlier than it used to be.
  518. - When a listener process exits (unexpectedly) before transitioning from the
  519. BUSY state, rebuffer the event that was being processed.
  520. - supervisorctl ``tail`` command now accepts a trailing specifier: ``stderr``
  521. or ``stdout``, which respectively, allow a user to tail the stderr or
  522. stdout of the named process. When this specifier is not provided, tail
  523. defaults to stdout.
  524. - supervisor ``clear`` command now clears both stderr and stdout logs for the
  525. given process.
  526. - When a process encounters a spawn error as a result of a failed execve or
  527. when it cannot setuid to a given uid, it now puts this info into the
  528. process' stderr log rather than its stdout log.
  529. - The event listener protocol header now contains the ``server`` identifier,
  530. the ``pool`` that the event emanated from, and the ``poolserial`` as well
  531. as the values it previously contained (version, event name, serial, and
  532. length). The server identifier is taken from the config file options value
  533. ``identifier``, the ``pool`` value is the name of the listener pool that
  534. this event emanates from, and the ``poolserial`` is a serial number
  535. assigned to the event local to the pool that is processing it.
  536. - The event listener protocol header is now a sequence of key-value
  537. pairs rather than a list of positional values. Previously, a
  538. representative header looked like::
  539. SUPERVISOR3.0 PROCESS_COMMUNICATION_STDOUT 30 22\n
  540. Now it looks like::
  541. ver:3.0 server:supervisor serial:21 ...
  542. - Specific event payload serializations have changed. All event
  543. types that deal with processes now include the pid of the process
  544. that the event is describing. In event serialization "header"
  545. values, we've removed the space between the header name and the
  546. value and headers are now separated by a space instead of a line
  547. feed. The names of keys in all event types have had underscores
  548. removed.
  549. - Abandon the use of the Python stdlib ``logging`` module for speed
  550. and cleanliness purposes. We've rolled our own.
  551. - Fix crash on start if AUTO logging is used with a max_bytes of
  552. zero for a process.
  553. - Improve process communication event performance.
  554. - The process config parameters ``stdout_capturefile`` and
  555. ``stderr_capturefile`` are no longer valid. They have been replaced with
  556. the ``stdout_capture_maxbytes`` and ``stderr_capture_maxbytes`` parameters,
  557. which are meant to be suffix-multiplied integers. They both default to
  558. zero. When they are zero, process communication event capturing is not
  559. performed. When either is nonzero, the value represents the maximum number
  560. of bytes that will be captured between process event start and end tags.
  561. This change was to support the fact that we no longer keep capture data in
  562. a separate file, we just use a FIFO in RAM to maintain capture info. For
  563. users whom don't care about process communication events, or whom haven't
  564. changed the defaults for ``stdout_capturefile`` or ``stderr_capturefile``,
  565. they needn't do anything to their configurations to deal with this change.
  566. - Log message levels have been normalized. In particular, process
  567. stdin/stdout is now logged at ``debug`` level rather than at ``trace``
  568. level (``trace`` level is now reserved for output useful typically for
  569. debugging supervisor itself). See "Supervisor Log Levels" in the
  570. documentation for more info.
  571. - When an event is rebuffered (because all listeners are busy or a
  572. listener rejected the event), the rebuffered event is now inserted
  573. in the head of the listener event queue. This doesn't guarantee
  574. event emission in natural ordering, because if a listener rejects
  575. an event or dies while it's processing an event, it can take an
  576. arbitrary amount of time for the event to be rebuffered, and other
  577. events may be processed in the meantime. But if pool listeners
  578. never reject an event or don't die while processing an event, this
  579. guarantees that events will be emitted in the order that they were
  580. received because if all listeners are busy, the rebuffered event
  581. will be tried again "first" on the next go-around.
  582. - Removed EVENT_BUFFER_OVERFLOW event type.
  583. - The supervisorctl xmlrpc proxy can now communicate with
  584. supervisord using a persistent HTTP connection.
  585. - A new module "supervisor.childutils" was added. This module
  586. provides utilities for Python scripts which act as children of
  587. supervisord. Most notably, it contains an API method
  588. "getRPCInterface" allows you to obtain an xmlrpxlib ServerProxy
  589. that is willing to communicate with the parent supervisor. It
  590. also contains utility functions that allow for parsing of
  591. supervisor event listener protocol headers. A pair of scripts
  592. (loop_eventgen.py and loop_listener.py) were added to the script
  593. directory that serve as examples about how to use the childutils
  594. module.
  595. - A new envvar is added to child process environments:
  596. SUPERVISOR_SERVER_URL. This contains the server URL for the
  597. supervisord running the child.
  598. - An ``OK`` URL was added at ``/ok.html`` which just returns the string
  599. ``OK`` (can be used for up checks or speed checks via plain-old-HTTP).
  600. - An additional command-line option ``--profile_options`` is accepted
  601. by the supervisord script for developer use::
  602. supervisord -n -c sample.conf --profile_options=cumulative,calls
  603. The values are sort_stats options that can be passed to the
  604. standard Python profiler's PStats sort_stats method.
  605. When you exit supervisor, it will print Python profiling output to
  606. stdout.
  607. - If cElementTree is installed in the Python used to invoke
  608. supervisor, an alternate (faster, by about 2X) XML parser will be
  609. used to parse XML-RPC request bodies. cElementTree was added as
  610. an "extras_require" option in setup.py.
  611. - Added the ability to start, stop, and restart process groups to
  612. supervisorctl. To start a group, use ``start groupname:*``. To start
  613. multiple groups, use ``start groupname1:* groupname2:*``. Equivalent
  614. commands work for "stop" and "restart". You can mix and match short
  615. processnames, fullly-specified group:process names, and groupsplats on the
  616. same line for any of these commands.
  617. - Added ``directory`` option to process config. If you set this
  618. option, supervisor will chdir to this directory before executing
  619. the child program (and thus it will be the child's cwd).
  620. - Added ``umask`` option to process config. If you set this option,
  621. supervisor will set the umask of the child program. (Thanks to
  622. Ian Bicking for the suggestion).
  623. - A pair of scripts ``osx_memmon_eventgen.py`` and `osx_memmon_listener.py``
  624. have been added to the scripts directory. If they are used together as
  625. described in their comments, processes which are consuming "too much"
  626. memory will be restarted. The ``eventgen`` script only works on OSX (my
  627. main development platform) but it should be trivially generalizable to
  628. other operating systems.
  629. - The long form ``--configuration`` (-c) command line option for
  630. supervisord was broken. Reported by Mike Orr. (Mike Naberezny)
  631. - New log level: BLAT (blather). We log all
  632. supervisor-internal-related debugging info here. Thanks to Mike
  633. Orr for the suggestion.
  634. - We now allow supervisor to listen on both a UNIX domain socket and an inet
  635. socket instead of making them mutually exclusive. As a result, the options
  636. "http_port", "http_username", "http_password", "sockchmod" and "sockchown"
  637. are no longer part of the ``[supervisord]`` section configuration. These
  638. have been supplanted by two other sections: ``[unix_http_server]`` and
  639. ``[inet_http_server]``. You'll need to insert one or the other (depending
  640. on whether you want to listen on a UNIX domain socket or a TCP socket
  641. respectively) or both into your supervisord.conf file. These sections have
  642. their own options (where applicable) for port, username, password, chmod,
  643. and chown. See README.txt for more information about these sections.
  644. - All supervisord command-line options related to "http_port",
  645. "http_username", "http_password", "sockchmod" and "sockchown" have
  646. been removed (see above point for rationale).
  647. - The option that *used* to be ``sockchown`` within the ``[supervisord]``
  648. section (and is now named ``chown`` within the ``[unix_http_server]``
  649. section) used to accept a dot-separated user.group value. The separator
  650. now must be a colon ":", e.g. "user:group". Unices allow for dots in
  651. usernames, so this change is a bugfix. Thanks to Ian Bicking for the bug
  652. report.
  653. - If a '-c' option is not specified on the command line, both supervisord and
  654. supervisorctl will search for one in the paths ``./supervisord.conf`` ,
  655. ``./etc/supervisord.conf`` (relative to the current working dir when
  656. supervisord or supervisorctl is invoked) or in ``/etc/supervisord.conf``
  657. (the old default path). These paths are searched in order, and supervisord
  658. and supervisorctl will use the first one found. If none are found,
  659. supervisor will fail to start.
  660. - The Python string expression ``%(here)s`` (referring to the directory in
  661. which the the configuration file was found) can be used within the
  662. following sections/options within the config file::
  663. unix_http_server:file
  664. supervisor:directory
  665. supervisor:logfile
  666. supervisor:pidfile
  667. supervisor:childlogdir
  668. supervisor:environment
  669. program:environment
  670. program:stdout_logfile
  671. program:stderr_logfile
  672. program:process_name
  673. program:command
  674. - The ``--environment`` aka ``-b`` option was removed from the list of
  675. available command-line switches to supervisord (use "A=1 B=2
  676. bin/supervisord" instead).
  677. - If the socket filename (the tail-end of the unix:// URL) was
  678. longer than 64 characters, supervisorctl would fail with an
  679. encoding error at startup.
  680. - The ``identifier`` command-line argument was not functional.
  681. - Fixed http://www.plope.com/software/collector/215 (bad error
  682. message in supervisorctl when program command not found on PATH).
  683. - Some child processes may not have been shut down properly at
  684. supervisor shutdown time.
  685. - Move to ZPL-derived (but not ZPL) license availble from
  686. http://www.repoze.org/LICENSE.txt; it's slightly less restrictive
  687. than the ZPL (no servicemark clause).
  688. - Spurious errors related to unclosed files ("bad file descriptor",
  689. typically) were evident at supervisord "reload" time (when using
  690. the "reload" command from supervisorctl).
  691. - We no longer bundle ez_setup to bootstrap setuptools installation.
  692. 3.0a2 (2007-08-24)
  693. ------------------
  694. - Fixed the README.txt example for defining the supervisor RPC
  695. interface in the configuration file. Thanks to Drew Perttula.
  696. - Fixed a bug where process communication events would not have the
  697. proper payload if the payload data was very short.
  698. - when supervisord attempted to kill a process with SIGKILL after
  699. the process was not killed within "stopwaitsecs" using a "normal"
  700. kill signal, supervisord would crash with an improper
  701. AssertionError. Thanks to Calvin Hendryx-Parker.
  702. - On Linux, Supervisor would consume too much CPU in an effective
  703. "busywait" between the time a subprocess exited and the time at
  704. which supervisor was notified of its exit status. Thanks to Drew
  705. Perttula.
  706. - RPC interface behavior change: if the RPC method
  707. "sendProcessStdin" is called against a process that has closed its
  708. stdin file descriptor (e.g. it has done the equivalent of
  709. "sys.stdin.close(); os.close(0)"), we return a NO_FILE fault
  710. instead of accepting the data.
  711. - Changed the semantics of the process configuration ``autorestart``
  712. parameter with respect to processes which move between the RUNNING and
  713. EXITED state. ``autorestart`` was previously a boolean. Now it's a
  714. trinary, accepting one of ``false``, ``unexpected``, or ``true``. If it's
  715. ``false``, a process will never be automatically restarted from the EXITED
  716. state. If it's ``unexpected``, a process that enters the EXITED state will
  717. be automatically restarted if it exited with an exit code that was not
  718. named in the process config's ``exitcodes`` list. If it's ``true``, a
  719. process that enters the EXITED state will be automatically restarted
  720. unconditionally. The default is now ``unexpected`` (it was previously
  721. ``true``). The readdition of this feature is a reversion of the behavior
  722. change note in the changelog notes for 3.0a1 that asserted we never cared
  723. about the process' exit status when determining whether to restart it or
  724. not.
  725. - setup.py develop (and presumably setup.py install) would fail under Python
  726. 2.3.3, because setuptools attempted to import ``splituser`` from urllib2,
  727. and it didn't exist.
  728. - It's now possible to use ``setup.py install`` and ``setup.py develop`` on
  729. systems which do not have a C compiler if you set the environment variable
  730. "NO_MELD3_EXTENSION_MODULES=1" in the shell in which you invoke these
  731. commands (versions of meld3 > 0.6.1 respect this envvar and do not try to
  732. compile optional C extensions when it's set).
  733. - The test suite would fail on Python versions <= 2.3.3 because
  734. the "assertTrue" and "assertFalse" methods of unittest.TestCase
  735. didn't exist in those versions.
  736. - The ``supervisorctl`` and ``supervisord`` wrapper scripts were disused in
  737. favor of using setuptools' ``console_scripts`` entry point settings.
  738. - Documentation files and the sample configuration file are put into
  739. the generated supervisor egg's ``doc`` directory.
  740. - Using the web interface would cause fairly dramatic memory
  741. leakage. We now require a version of meld3 that does not appear
  742. to leak memory from its C extensions (0.6.3).
  743. 3.0a1 (2007-08-16)
  744. ------------------
  745. - Default config file comment documented 10 secs as default for ``startsecs``
  746. value in process config, in reality it was 1 sec. Thanks to Christoph
  747. Zwerschke.
  748. - Make note of subprocess environment behavior in README.txt.
  749. Thanks to Christoph Zwerschke.
  750. - New "strip_ansi" config file option attempts to strip ANSI escape
  751. sequences from logs for smaller/more readable logs (submitted by
  752. Mike Naberezny).
  753. - The XML-RPC method supervisor.getVersion() has been renamed for
  754. clarity to supervisor.getAPIVersion(). The old name is aliased
  755. for compatibility but is deprecated and will be removed in a
  756. future version (Mike Naberezny).
  757. - Improved web interface styling (Mike Naberezny, Derek DeVries)
  758. - The XML-RPC method supervisor.startProcess() now checks that
  759. the file exists and is executable (Mike Naberezny).
  760. - Two environment variables, "SUPERVISOR_PROCESS_NAME" and
  761. "SUPERVISOR_PROCESS_GROUP" are set in the environment of child
  762. processes, representing the name of the process and group in
  763. supervisor's configuration.
  764. - Process state map change: a process may now move directly from the
  765. STARTING state to the STOPPING state (as a result of a stop
  766. request).
  767. - Behavior change: if ``autorestart`` is true, even if a process exits with
  768. an "expected" exit code, it will still be restarted. In the immediately
  769. prior release of supervisor, this was true anyway, and no one complained,
  770. so we're going to consider that the "officially correct" behavior from now
  771. on.
  772. - Supervisor now logs subprocess stdout and stderr independently.
  773. The old program config keys "logfile", "logfile_backups" and
  774. "logfile_maxbytes" are superseded by "stdout_logfile",
  775. "stdout_logfile_backups", and "stdout_logfile_maxbytes". Added
  776. keys include "stderr_logfile", "stderr_logfile_backups", and
  777. "stderr_logfile_maxbytes". An additional "redirect_stderr" key is
  778. used to cause program stderr output to be sent to its stdin
  779. channel. The keys "log_stderr" and "log_stdout" have been
  780. removed.
  781. - ``[program:x]`` config file sections now represent "homgeneous process
  782. groups" instead of single processes. A "numprocs" key in the section
  783. represents the number of processes that are in the group. A "process_name"
  784. key in the section allows composition of the each process' name within the
  785. homogeneous group.
  786. - A new kind of config file section, ``[group:x]`` now exists, allowing users
  787. to group heterogeneous processes together into a process group that can be
  788. controlled as a unit from a client.
  789. - Supervisord now emits "events" at certain points in its normal
  790. operation. These events include supervisor state change events,
  791. process state change events, and "process communication events".
  792. - A new kind of config file section ``[eventlistener:x]`` now exists. Each
  793. section represents an "event listener pool", which is a special kind of
  794. homogeneous process group. Each process in the pool is meant to receive
  795. supervisor "events" via its stdin and perform some notification (e.g. send
  796. a mail, log, make an http request, etc.)
  797. - Supervisord can now capture data between special tokens in
  798. subprocess stdout/stderr output and emit a "process communications
  799. event" as a result.
  800. - Supervisor's XML-RPC interface may be extended arbitrarily by programmers.
  801. Additional top-level namespace XML-RPC interfaces can be added using the
  802. ``[rpcinterface:foo]`` declaration in the configuration file.
  803. - New ``supervisor``-namespace XML-RPC methods have been added:
  804. getAPIVersion (returns the XML-RPC API version, the older
  805. "getVersion" is now deprecated), "startProcessGroup" (starts all
  806. processes in a supervisor process group), "stopProcessGroup"
  807. (stops all processes in a supervisor process group), and
  808. "sendProcessStdin" (sends data to a process' stdin file
  809. descriptor).
  810. - ``supervisor``-namespace XML-RPC methods which previously accepted
  811. ony a process name as "name" (startProcess, stopProcess,
  812. getProcessInfo, readProcessLog, tailProcessLog, and
  813. clearProcessLog) now accept a "name" which may contain both the
  814. process name and the process group name in the form
  815. ``groupname:procname``. For backwards compatibility purposes,
  816. "simple" names will also be accepted but will be expanded
  817. internally (e.g. if "foo" is sent as a name, it will be expanded
  818. to "foo:foo", representing the foo process within the foo process
  819. group).
  820. - 2.X versions of supervisorctl will work against supervisor 3.0
  821. servers in a degraded fashion, but 3.X versions of supervisorctl
  822. will not work at all against supervisor 2.X servers.
  823. 2.2b1 (2007-03-31)
  824. ------------------
  825. - Individual program configuration sections can now specify an
  826. environment.
  827. - Added a 'version' command to supervisorctl. This returns the
  828. version of the supervisor2 package which the remote supervisord
  829. process is using.
  830. 2.1 (2007-03-17)
  831. ----------------
  832. - When supervisord was invoked more than once, and its configuration
  833. was set up to use a UNIX domain socket as the HTTP server, the
  834. socket file would be erased in error. The symptom of this was
  835. that a subsequent invocation of supervisorctl could not find the
  836. socket file, so the process could not be controlled (it and all of
  837. its subprocesses would need to be killed by hand).
  838. - Close subprocess file descriptors properly when a subprocess exits
  839. or otherwise dies. This should result in fewer "too many open
  840. files to spawn foo" messages when supervisor is left up for long
  841. periods of time.
  842. - When a process was not killable with a "normal" signal at shutdown
  843. time, too many "INFO: waiting for x to die" messages would be sent
  844. to the log until we ended up killing the process with a SIGKILL.
  845. Now a maximum of one every three seconds is sent up until SIGKILL
  846. time. Thanks to Ian Bicking.
  847. - Add an assertion: we never want to try to marshal None to XML-RPC
  848. callers. Issue 223 in the collector from vgatto indicates that
  849. somehow a supervisor XML-RPC method is returning None (which
  850. should never happen), but I cannot identify how. Maybe the
  851. assertion will give us more clues if it happens again.
  852. - Supervisor would crash when run under Python 2.5 because the
  853. xmlrpclib.Transport class in Python 2.5 changed in a
  854. backward-incompatible way. Thanks to Eric Westra for the bug
  855. report and a fix.
  856. - Tests now pass under Python 2.5.
  857. - Better supervisorctl reporting on stop requests that have a FAILED
  858. status.
  859. - Removed duplicated code (readLog/readMainLog), thanks to Mike
  860. Naberezny.
  861. - Added tailProcessLog command to the XML-RPC API. It provides a
  862. more efficient way to tail logs than readProcessLog(). Use
  863. readProcessLog() to read chunks and tailProcessLog() to tail.
  864. (thanks to Mike Naberezny).
  865. 2.1b1 (2006-08-30)
  866. ------------------
  867. - "supervisord -h" and "supervisorctl -h" did not work (traceback
  868. instead of showing help view (thanks to Damjan from Macedonia for
  869. the bug report).
  870. - Processes which started successfully after failing to start
  871. initially are no longer reported in BACKOFF state once they are
  872. started successfully (thanks to Damjan from Macdonia for the bug
  873. report).
  874. - Add new 'maintail' command to supervisorctl shell, which allows
  875. you to tail the 'main' supervisor log. This uses a new
  876. readMainLog xmlrpc API.
  877. - Various process-state-transition related changes, all internal.
  878. README.txt updated with new state transition map.
  879. - startProcess and startAllProcesses xmlrpc APIs changed: instead of
  880. accepting a timeout integer, these accept a wait boolean (timeout
  881. is implied by process' "startsecs" configuration). If wait is
  882. False, do not wait for startsecs.
  883. Known issues:
  884. - Code does not match state transition map. Processes which are
  885. configured as autorestarting which start "successfully" but
  886. subsequently die after 'startsecs' go through the transitions
  887. RUNNING -> BACKOFF -> STARTING instead of the correct transitions
  888. RUNNING -> EXITED -> STARTING. This has no real negative effect,
  889. but should be fixed for correctness.
  890. 2.0 (2006-08-30)
  891. ----------------
  892. - pidfile written in daemon mode had incorrect pid.
  893. - supervisorctl: tail (non -f) did not pass through proper error
  894. messages when supplied by the server.
  895. - Log signal name used to kill processes at debug level.
  896. - supervisorctl "tail -f" didn't work with supervisorctl sections
  897. configured with an absolute unix:// URL
  898. - New "environment" config file option allows you to add environment
  899. variable values to supervisord environment from config file.
  900. 2.0b1 (2006-07-12)
  901. ------------------
  902. - Fundamental rewrite based on 1.0.7, use distutils (only) for
  903. installation, use ConfigParser rather than ZConfig, use HTTP for
  904. wire protocol, web interface, less lies in supervisorctl.
  905. 1.0.7 (2006-07-11)
  906. ------------------
  907. - Don't log a waitpid error if the error value is "no children".
  908. - Use select() against child file descriptor pipes and bump up select
  909. timeout appropriately.
  910. 1.0.6 (2005-11-20)
  911. ------------------
  912. - Various tweaks to make run more effectively on Mac OS X
  913. (including fixing tests to run there, no more "error reading
  914. from fd XXX" in logtail output, reduced disk/CPU usage as a
  915. result of not writing to log file unnecessarily on Mac OS).
  916. 1.0.5 (2004-07-29)
  917. ------------------
  918. - Short description: In previous releases, managed programs that
  919. created voluminous stdout/stderr output could run more slowly
  920. than usual when invoked under supervisor, now they do not.
  921. Long description: The supervisord manages child output by
  922. polling pipes related to child process stderr/stdout. Polling
  923. operations are performed in the mainloop, which also performs a
  924. 'select' on the filedescriptor(s) related to client/server
  925. operations. In prior releases, the select timeout was set to 2
  926. seconds. This release changes the timeout to 1/10th of a second
  927. in order to keep up with client stdout/stderr output.
  928. Gory description: On Linux, at least, there is a pipe buffer
  929. size fixed by the kernel of somewhere between 512 - 4096 bytes;
  930. when a child process writes enough data to fill the pipe buffer,
  931. it will block on further stdout/stderr output until supervisord
  932. comes along and clears out the buffer by reading bytes from the
  933. pipe within the mainloop. We now clear these buffers much more
  934. quickly than we did before due to the increased frequency of
  935. buffer reads in the mainloop; the timeout value of 1/10th of a
  936. second seems to be fast enough to clear out the buffers of child
  937. process pipes when managing programs on even a very fast system
  938. while still enabling the supervisord process to be in a sleeping
  939. state for most of the time.
  940. 1.0.4 or "Alpha 4" (2004-06-30)
  941. -------------------------------
  942. - Forgot to update version tag in configure.py, so the supervisor version
  943. in a3 is listed as "1.0.1", where it should be "1.0.3". a4 will be
  944. listed as "1.0.4'.
  945. - Instead of preventing a process from starting if setuid() can't
  946. be called (if supervisord is run as nonroot, for example), just log
  947. the error and proceed.
  948. 1.0.3 or "Alpha 3" (2004-05-26)
  949. -------------------------------
  950. - The daemon could chew up a lot of CPU time trying to select()
  951. on real files (I didn't know select() failed to block when a file
  952. is at EOF). Fixed by polling instead of using select().
  953. - Processes could "leak" and become zombies due to a bug in
  954. reaping dead children.
  955. - supervisord now defaults to daemonizing itself.
  956. - 'daemon' config file option and -d/--daemon command-line option
  957. removed from supervisord acceptable options. In place of these
  958. options, we now have a 'nodaemon' config file option and a
  959. -n/--nodaemon command-line option.
  960. - logtail now works.
  961. - pidproxy changed slightly to reap children synchronously.
  962. - in alpha2 changelist, supervisord was reported to have a
  963. "noauth" command-line option. This was not accurate. The way
  964. to turn off auth on the server is to disinclude the "passwdfile"
  965. config file option from the server config file. The client
  966. however does indeed still have a noauth option, which prevents
  967. it from ever attempting to send authentication credentials to
  968. servers.
  969. - ZPL license added for ZConfig to LICENSE.txt
  970. 1.0.2 or "Alpha 2" (Unreleased)
  971. -------------------------------
  972. - supervisorctl and supervisord no longer need to run on the same machine
  973. due to the addition of internet socket support.
  974. - supervisorctl and supervisord no longer share a common configuration
  975. file format.
  976. - supervisorctl now uses a persistent connection to supervisord
  977. (as opposed to creating a fresh connection for each command).
  978. - SRP (Secure Remote Password) authentication is now a supported form
  979. of access control for supervisord. In supervisorctl interactive mode,
  980. by default, users will be asked for credentials when attempting to
  981. talk to a supervisord that requires SRP authentication.
  982. - supervisord has a new command-line option and configuration file
  983. option for specifying "noauth" mode, which signifies that it
  984. should not require authentication from clients.
  985. - supervisorctl has a new command-line option and configuration
  986. option for specifying "noauth" mode, which signifies that it
  987. should never attempt to send authentication info to servers.
  988. - supervisorctl has new commands: open: opens a connection to a new
  989. supervisord; close: closes the current connection.
  990. - supervisorctl's "logtail" command now retrieves log data from
  991. supervisord's log file remotely (as opposed to reading it
  992. directly from a common filesystem). It also no longer emulates
  993. "tail -f", it just returns <n> lines of the server's log file.
  994. - The supervisord/supervisorctl wire protocol now has protocol versioning
  995. and is documented in "protocol.txt".
  996. - "configfile" command-line override -C changed to -c
  997. - top-level section name for supervisor schema changed to 'supervisord'
  998. from 'supervisor'
  999. - Added 'pidproxy' shim program.
  1000. Known issues in alpha 2:
  1001. - If supervisorctl loses a connection to a supervisord or if the
  1002. remote supervisord crashes or shuts down unexpectedly, it is
  1003. possible that any supervisorctl talking to it will "hang"
  1004. indefinitely waiting for data. Pressing Ctrl-C will allow you
  1005. to restart supervisorctl.
  1006. - Only one supervisorctl process may talk to a given supervisord
  1007. process at a time. If two supervisorctl processes attempt to talk
  1008. to the same supervisord process, one will "win" and the other will
  1009. be disconnected.
  1010. - Sometimes if a pidproxy is used to start a program, the pidproxy
  1011. program itself will "leak".
  1012. 1.0.0 or "Alpha 1" (Unreleased)
  1013. -------------------------------
  1014. Initial release.