celery.conf.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Configuration - celery.conf &mdash; Celery v0.3.2 (unstable) documentation</title>
  7. <link rel="stylesheet" href="../static/agogo.css" type="text/css" />
  8. <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../',
  12. VERSION: '0.3.2 (unstable)',
  13. COLLAPSE_MODINDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../static/jquery.js"></script>
  19. <script type="text/javascript" src="../static/doctools.js"></script>
  20. <link rel="top" title="Celery v0.3.2 (unstable) documentation" href="../index.html" />
  21. <link rel="up" title="Module API Reference" href="index.html" />
  22. <link rel="next" title="Datastructures - celery.datastructures" href="celery.datastructures.html" />
  23. <link rel="prev" title="Backend: Tokyo Tyrant - celery.backends.tyrant" href="celery.backends.tyrant.html" />
  24. </head>
  25. <body>
  26. <div class="header-wrapper">
  27. <div class="header">
  28. <h1><a href="../index.html">Celery v0.3.2 (unstable) documentation</a></h1>
  29. <div class="rel">
  30. <a href="../genindex.html" title="General Index"
  31. accesskey="I">index</a> |
  32. <a href="../modindex.html" title="Global Module Index"
  33. accesskey="M">modules</a> |
  34. <a href="celery.datastructures.html" title="Datastructures - celery.datastructures"
  35. accesskey="N">next</a> |
  36. <a href="celery.backends.tyrant.html" title="Backend: Tokyo Tyrant - celery.backends.tyrant"
  37. accesskey="P">previous</a>
  38. </div>
  39. </div>
  40. </div>
  41. <div class="content-wrapper">
  42. <div class="content">
  43. <div class="document">
  44. <div class="documentwrapper">
  45. <div class="bodywrapper">
  46. <div class="body">
  47. <div class="section" id="module-celery.conf">
  48. <h1>Configuration - celery.conf<a class="headerlink" href="#module-celery.conf" title="Permalink to this headline">¶</a></h1>
  49. <p>celery.conf</p>
  50. <dl class="data">
  51. <dt id="celery.conf.AMQP_CONSUMER_QUEUE">
  52. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_CONSUMER_QUEUE</tt><a class="headerlink" href="#celery.conf.AMQP_CONSUMER_QUEUE" title="Permalink to this definition">¶</a></dt>
  53. <dd><dl class="data">
  54. <dt id="celery.conf.SEND_CELERY_TASK_ERROR_EMAILS">
  55. <tt class="descclassname">celery.conf.</tt><tt class="descname">SEND_CELERY_TASK_ERROR_EMAILS</tt><a class="headerlink" href="#celery.conf.SEND_CELERY_TASK_ERROR_EMAILS" title="Permalink to this definition">¶</a></dt>
  56. <dd>If set to <tt class="xref docutils literal"><span class="pre">True</span></tt>, errors in tasks will be sent to admins by e-mail.
  57. If unset, it will send the e-mails if DEBUG is False.</dd></dl>
  58. </dd></dl>
  59. <dl class="data">
  60. <dt id="celery.conf.AMQP_CONSUMER_ROUTING_KEY">
  61. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_CONSUMER_ROUTING_KEY</tt><a class="headerlink" href="#celery.conf.AMQP_CONSUMER_ROUTING_KEY" title="Permalink to this definition">¶</a></dt>
  62. <dd><dl class="data">
  63. <dt>
  64. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_CONSUMER_QUEUE</tt></dt>
  65. <dd>The name of the AMQP queue.</dd></dl>
  66. </dd></dl>
  67. <dl class="data">
  68. <dt id="celery.conf.AMQP_EXCHANGE">
  69. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_EXCHANGE</tt><a class="headerlink" href="#celery.conf.AMQP_EXCHANGE" title="Permalink to this definition">¶</a></dt>
  70. <dd><dl class="data">
  71. <dt id="celery.conf.AMQP_EXCHANGE_TYPE">
  72. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_EXCHANGE_TYPE</tt><a class="headerlink" href="#celery.conf.AMQP_EXCHANGE_TYPE" title="Permalink to this definition">¶</a></dt>
  73. <dd></dd></dl>
  74. <p>The type of exchange. If the exchange type is <tt class="docutils literal"><span class="pre">direct</span></tt>, all messages
  75. receives all tasks. However, if the exchange type is <tt class="docutils literal"><span class="pre">topic</span></tt>, you can
  76. route e.g. some tasks to one server, and others to the rest.
  77. See <a class="reference external" href="http://bit.ly/wpamqpexchanges">Exchange types and the effect of bindings</a>.</p>
  78. </dd></dl>
  79. <dl class="data">
  80. <dt>
  81. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_EXCHANGE_TYPE</tt></dt>
  82. <dd><dl class="data">
  83. <dt id="celery.conf.AMQP_PUBLISHER_ROUTING_KEY">
  84. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_PUBLISHER_ROUTING_KEY</tt><a class="headerlink" href="#celery.conf.AMQP_PUBLISHER_ROUTING_KEY" title="Permalink to this definition">¶</a></dt>
  85. <dd>The default AMQP routing key used when publishing tasks.</dd></dl>
  86. </dd></dl>
  87. <dl class="data">
  88. <dt>
  89. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_PUBLISHER_ROUTING_KEY</tt></dt>
  90. <dd><dl class="data">
  91. <dt>
  92. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_CONSUMER_ROUTING_KEY</tt></dt>
  93. <dd>The AMQP routing key used when consuming tasks.</dd></dl>
  94. </dd></dl>
  95. <dl class="data">
  96. <dt id="celery.conf.DAEMON_CONCURRENCY">
  97. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_CONCURRENCY</tt><a class="headerlink" href="#celery.conf.DAEMON_CONCURRENCY" title="Permalink to this definition">¶</a></dt>
  98. <dd><dl class="data">
  99. <dt>
  100. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_EXCHANGE</tt></dt>
  101. <dd>Name of the AMQP exchange.</dd></dl>
  102. </dd></dl>
  103. <dl class="data">
  104. <dt id="celery.conf.DAEMON_LOG_FILE">
  105. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_LOG_FILE</tt><a class="headerlink" href="#celery.conf.DAEMON_LOG_FILE" title="Permalink to this definition">¶</a></dt>
  106. <dd><dl class="data">
  107. <dt id="celery.conf.DAEMON_LOG_LEVEL">
  108. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_LOG_LEVEL</tt><a class="headerlink" href="#celery.conf.DAEMON_LOG_LEVEL" title="Permalink to this definition">¶</a></dt>
  109. <dd>Celery daemon log level, can be any of <tt class="docutils literal"><span class="pre">DEBUG</span></tt>, <tt class="docutils literal"><span class="pre">INFO</span></tt>, <tt class="docutils literal"><span class="pre">WARNING</span></tt>,
  110. <tt class="docutils literal"><span class="pre">ERROR</span></tt>, <tt class="docutils literal"><span class="pre">CRITICAL</span></tt>, or <tt class="docutils literal"><span class="pre">FATAL</span></tt>. See the <tt class="xref docutils literal"><span class="pre">logging</span></tt> module
  111. for more information.</dd></dl>
  112. </dd></dl>
  113. <dl class="data">
  114. <dt>
  115. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_LOG_LEVEL</tt></dt>
  116. <dd><dl class="data">
  117. <dt id="celery.conf.QUEUE_WAKEUP_AFTER">
  118. <tt class="descclassname">celery.conf.</tt><tt class="descname">QUEUE_WAKEUP_AFTER</tt><a class="headerlink" href="#celery.conf.QUEUE_WAKEUP_AFTER" title="Permalink to this definition">¶</a></dt>
  119. <dd>The time (in seconds) the celery worker should sleep when there&#8217;s
  120. no messages left on the queue. After the time is slept, the worker
  121. wakes up and checks the queue again.</dd></dl>
  122. </dd></dl>
  123. <dl class="data">
  124. <dt id="celery.conf.DAEMON_PID_FILE">
  125. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_PID_FILE</tt><a class="headerlink" href="#celery.conf.DAEMON_PID_FILE" title="Permalink to this definition">¶</a></dt>
  126. <dd><dl class="data">
  127. <dt>
  128. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_CONCURRENCY</tt></dt>
  129. <dd>The number of concurrent worker processes, executing tasks simultaneously.</dd></dl>
  130. </dd></dl>
  131. <dl class="data">
  132. <dt id="celery.conf.DEFAULT_DAEMON_LOG_FILE">
  133. <tt class="descclassname">celery.conf.</tt><tt class="descname">DEFAULT_DAEMON_LOG_FILE</tt><a class="headerlink" href="#celery.conf.DEFAULT_DAEMON_LOG_FILE" title="Permalink to this definition">¶</a></dt>
  134. <dd><dl class="data">
  135. <dt id="celery.conf.LOG_LEVELS">
  136. <tt class="descclassname">celery.conf.</tt><tt class="descname">LOG_LEVELS</tt><a class="headerlink" href="#celery.conf.LOG_LEVELS" title="Permalink to this definition">¶</a></dt>
  137. <dd>Mapping of log level names to <tt class="xref docutils literal"><span class="pre">logging</span></tt> module constants.</dd></dl>
  138. </dd></dl>
  139. <dl class="data">
  140. <dt id="celery.conf.EMPTY_MSG_EMIT_EVERY">
  141. <tt class="descclassname">celery.conf.</tt><tt class="descname">EMPTY_MSG_EMIT_EVERY</tt><a class="headerlink" href="#celery.conf.EMPTY_MSG_EMIT_EVERY" title="Permalink to this definition">¶</a></dt>
  142. <dd><dl class="data">
  143. <dt>
  144. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_PID_FILE</tt></dt>
  145. <dd>Full path to the daemon pidfile.</dd></dl>
  146. </dd></dl>
  147. <dl class="data">
  148. <dt id="celery.conf.LOG_FORMAT">
  149. <tt class="descclassname">celery.conf.</tt><tt class="descname">LOG_FORMAT</tt><a class="headerlink" href="#celery.conf.LOG_FORMAT" title="Permalink to this definition">¶</a></dt>
  150. <dd><dl class="data">
  151. <dt>
  152. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_LOG_FILE</tt></dt>
  153. <dd>The path to the deamon log file (if not set, <tt class="docutils literal"><span class="pre">stderr</span></tt> is used).</dd></dl>
  154. </dd></dl>
  155. <dl class="data">
  156. <dt>
  157. <tt class="descclassname">celery.conf.</tt><tt class="descname">LOG_LEVELS</tt></dt>
  158. <dd><dl class="data">
  159. <dt>
  160. <tt class="descclassname">celery.conf.</tt><tt class="descname">LOG_FORMAT</tt></dt>
  161. <dd>The format to use for log messages.
  162. Default is <tt class="docutils literal"><span class="pre">[%(asctime)s:</span> <span class="pre">%(levelname)s/%(processName)s]</span> <span class="pre">%(message)s</span></tt></dd></dl>
  163. </dd></dl>
  164. <dl class="data">
  165. <dt>
  166. <tt class="descclassname">celery.conf.</tt><tt class="descname">QUEUE_WAKEUP_AFTER</tt></dt>
  167. <dd><dl class="data">
  168. <dt>
  169. <tt class="descclassname">celery.conf.</tt><tt class="descname">EMPTY_MSG_EMIT_EVERY</tt></dt>
  170. <dd>How often the celery daemon should write a log message saying there are no
  171. messages in the queue. If this is <tt class="xref docutils literal"><span class="pre">None</span></tt> or <tt class="docutils literal"><span class="pre">0</span></tt>, it will never print
  172. this message.</dd></dl>
  173. </dd></dl>
  174. </div>
  175. </div>
  176. </div>
  177. </div>
  178. </div>
  179. <div class="sidebar">
  180. <h3>Contents</h3>
  181. <ul class="current">
  182. <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
  183. <li class="toctree-l1"><a class="reference external" href="../faq.html">Frequently Asked Questions</a></li>
  184. <li class="toctree-l1 current"><a class="reference external" href="index.html">Module API Reference</a><ul class="current">
  185. <li class="toctree-l2"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
  186. <li class="toctree-l2"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
  187. <li class="toctree-l2"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
  188. <li class="toctree-l2"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
  189. <li class="toctree-l2"><a class="reference external" href="celery.worker.html">Multiprocessing Worker - celery.worker</a></li>
  190. <li class="toctree-l2"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
  191. <li class="toctree-l2"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
  192. <li class="toctree-l2"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
  193. <li class="toctree-l2"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
  194. <li class="toctree-l2"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
  195. <li class="toctree-l2 current"><a class="current reference external" href="">Configuration - celery.conf</a></li>
  196. <li class="toctree-l2"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
  197. <li class="toctree-l2"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
  198. <li class="toctree-l2"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
  199. <li class="toctree-l2"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
  200. <li class="toctree-l2"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
  201. <li class="toctree-l2"><a class="reference external" href="celery.platform.html">Platform Specific - celery.platform</a></li>
  202. <li class="toctree-l2"><a class="reference external" href="celery.timer.html">Timers - celery.timer</a></li>
  203. <li class="toctree-l2"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
  204. </ul>
  205. </li>
  206. <li class="toctree-l1"><a class="reference external" href="../changelog.html">Change history</a></li>
  207. </ul>
  208. <h3 style="margin-top: 1.5em;">Search</h3>
  209. <form class="search" action="../search.html" method="get">
  210. <input type="text" name="q" size="18" />
  211. <input type="submit" value="Go" />
  212. <input type="hidden" name="check_keywords" value="yes" />
  213. <input type="hidden" name="area" value="default" />
  214. </form>
  215. <p class="searchtip" style="font-size: 90%">
  216. Enter search terms or a module, class or function name.
  217. </p>
  218. </div>
  219. <div class="clearer"></div>
  220. </div>
  221. </div>
  222. <div class="footer-wrapper">
  223. <div class="footer">
  224. <div class="left">
  225. <a href="../genindex.html" title="General Index"
  226. >index</a> |
  227. <a href="../modindex.html" title="Global Module Index"
  228. >modules</a> |
  229. <a href="celery.datastructures.html" title="Datastructures - celery.datastructures"
  230. >next</a> |
  231. <a href="celery.backends.tyrant.html" title="Backend: Tokyo Tyrant - celery.backends.tyrant"
  232. >previous</a>
  233. <br/>
  234. <a href="../sources/reference/celery.conf.txt"
  235. rel="nofollow">Show Source</a>
  236. </div>
  237. <div class="right">
  238. &copy; Copyright 2009, Ask Solem.<br/>
  239. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  240. </div>
  241. <div class="clearer"></div>
  242. </div>
  243. </div>
  244. </body>
  245. </html>