CHANGES.txt 58 KB

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