Home Explore Help
Sign In
yangck
/
celery
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: c5fd5ec9ae
Branches Tags
celery
/
reference
/
celery.conf.html

celery.conf.html 14 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. <html xmlns="http://www.w3.org/1999/xhtml">
    5. 

  5.   <head>
    6. 

  6.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7.     
    8. 

  8.     <title>Configuration - celery.conf &mdash; Celery v0.2.14 documentation</title>
    9. 

  9.     <link rel="stylesheet" href="../static/agogo.css" type="text/css" />
    10. 

  10.     <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
    11. 

  11.     <script type="text/javascript">
    12. 

  12.       var DOCUMENTATION_OPTIONS = {
    13. 

  13.       URL_ROOT:    '../',
    14. 

  14.       VERSION:     '0.2.14',
    15. 

  15.       COLLAPSE_MODINDEX: false,
    16. 

  16.       FILE_SUFFIX: '.html',
    17. 

  17.       HAS_SOURCE:  true
    18. 

  18.       };
    19. 

  19.     </script>
    20. 

  20.     <script type="text/javascript" src="../static/jquery.js"></script>
    21. 

  21.     <script type="text/javascript" src="../static/doctools.js"></script>
    22. 

  22.     <link rel="top" title="Celery v0.2.14 documentation" href="../index.html" />
    23. 

  23.     <link rel="up" title="Module API Reference" href="index.html" />
    24. 

  24.     <link rel="next" title="Datastructures - celery.datastructures" href="celery.datastructures.html" />
    25. 

  25.     <link rel="prev" title="Backend: Tokyo Tyrant - celery.backends.tyrant" href="celery.backends.tyrant.html" /> 
    26. 

  26.   </head>
    27. 

  27.   <body>
    28. 

  28. 

  29.     <div class="header-wrapper">
    30. 

  30.       <div class="header">
    31. 

  31. 	<h1><a href="../index.html">Celery v0.2.14 documentation</a></h1>
    32. 

  32. 	<div class="rel">
    33. 

  33.           <a href="../genindex.html" title="General Index"
    34. 

  34.              accesskey="I">index</a> |
    35. 

  35.           <a href="../modindex.html" title="Global Module Index"
    36. 

  36.              accesskey="M">modules</a> |
    37. 

  37.           <a href="celery.datastructures.html" title="Datastructures - celery.datastructures"
    38. 

  38.              accesskey="N">next</a> |
    39. 

  39.           <a href="celery.backends.tyrant.html" title="Backend: Tokyo Tyrant - celery.backends.tyrant"
    40. 

  40.              accesskey="P">previous</a>
    41. 

  41. 	</div>
    42. 

  42.       </div>
    43. 

  43.     </div>
    44. 

  44. 

  45.     <div class="content-wrapper">
    46. 

  46.       <div class="content">
    47. 

  47. 	<div class="document">
    48. 

  48. 	  <div class="documentwrapper">
    49. 

  49. 	    <div class="bodywrapper">
    50. 

  50. 	      <div class="body">
    51. 

  51. 		
    52. 

  52.   <div class="section" id="module-celery.conf">
    53. 

  53. <h1>Configuration - celery.conf<a class="headerlink" href="#module-celery.conf" title="Permalink to this headline">¶</a></h1>
    54. 

  54. <p>celery.conf</p>
    55. 

  55. <dl class="data">
    56. 

  56. <dt id="celery.conf.AMQP_CONSUMER_ROUTING_KEY">
    57. 

  57. <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>
    58. 

  58. <dd><dl class="data">
    59. 

  59. <dt id="celery.conf.AMQP_CONSUMER_QUEUE">
    60. 

  60. <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>
    61. 

  61. <dd>The name of the AMQP queue.</dd></dl>
    62. 

  62. 

  63. </dd></dl>
    64. 

  64. 

  65. <dl class="data">
    66. 

  66. <dt id="celery.conf.AMQP_EXCHANGE">
    67. 

  67. <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>
    68. 

  68. <dd><dl class="data">
    69. 

  69. <dt id="celery.conf.AMQP_EXCHANGE_TYPE">
    70. 

  70. <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>
    71. 

  71. <dd></dd></dl>
    72. 

  72. 

  73. <p>The type of exchange. If the exchange type is <tt class="docutils literal"><span class="pre">direct</span></tt>, all messages
    74. 

  74. receives all tasks. However, if the exchange type is <tt class="docutils literal"><span class="pre">topic</span></tt>, you can
    75. 

  75. route e.g some tasks to one server, and others to the rest.
    76. 

  76. See <a href="#id1"><span class="problematic" id="id2">`Exchange types and the effect of bindings`_</span></a>.</p>
    77. 

  77. </dd></dl>
    78. 

  78. 

  79. <dl class="data">
    80. 

  80. <dt>
    81. 

  81. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_EXCHANGE_TYPE</tt></dt>
    82. 

  82. <dd><dl class="data">
    83. 

  83. <dt id="celery.conf.AMQP_PUBLISHER_ROUTING_KEY">
    84. 

  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. 

  85. <dd>The default AMQP routing key used when publishing tasks.</dd></dl>
    86. 

  86. 

  87. </dd></dl>
    88. 

  88. 

  89. <dl class="data">
    90. 

  90. <dt>
    91. 

  91. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_PUBLISHER_ROUTING_KEY</tt></dt>
    92. 

  92. <dd><dl class="data">
    93. 

  93. <dt>
    94. 

  94. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_CONSUMER_ROUTING_KEY</tt></dt>
    95. 

  95. <dd>The AMQP routing key used when consuming tasks.</dd></dl>
    96. 

  96. 

  97. </dd></dl>
    98. 

  98. 

  99. <dl class="data">
    100. 

  100. <dt id="celery.conf.DAEMON_CONCURRENCY">
    101. 

  101. <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>
    102. 

  102. <dd><dl class="data">
    103. 

  103. <dt>
    104. 

  104. <tt class="descclassname">celery.conf.</tt><tt class="descname">AMQP_EXCHANGE</tt></dt>
    105. 

  105. <dd>Name of the AMQP exchange.</dd></dl>
    106. 

  106. 

  107. </dd></dl>
    108. 

  108. 

  109. <dl class="data">
    110. 

  110. <dt id="celery.conf.DAEMON_LOG_FILE">
    111. 

  111. <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>
    112. 

  112. <dd><dl class="data">
    113. 

  113. <dt id="celery.conf.DAEMON_LOG_LEVEL">
    114. 

  114. <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>
    115. 

  115. <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>,
    116. 

  116. <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
    117. 

  117. for more information.</dd></dl>
    118. 

  118. 

  119. </dd></dl>
    120. 

  120. 

  121. <dl class="data">
    122. 

  122. <dt>
    123. 

  123. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_LOG_LEVEL</tt></dt>
    124. 

  124. <dd><dl class="data">
    125. 

  125. <dt id="celery.conf.QUEUE_WAKEUP_AFTER">
    126. 

  126. <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>
    127. 

  127. <dd>The time (in seconds) the celery worker should sleep when there&#8217;s
    128. 

  128. no messages left on the queue. After the time is slept, the worker
    129. 

  129. wakes up and checks the queue again.</dd></dl>
    130. 

  130. 

  131. </dd></dl>
    132. 

  132. 

  133. <dl class="data">
    134. 

  134. <dt id="celery.conf.DAEMON_PID_FILE">
    135. 

  135. <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>
    136. 

  136. <dd><dl class="data">
    137. 

  137. <dt>
    138. 

  138. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_CONCURRENCY</tt></dt>
    139. 

  139. <dd>The number of concurrent worker processes, executing tasks simultaneously.</dd></dl>
    140. 

  140. 

  141. </dd></dl>
    142. 

  142. 

  143. <dl class="data">
    144. 

  144. <dt id="celery.conf.DEFAULT_REAP_TIMEOUT">
    145. 

  145. <tt class="descclassname">celery.conf.</tt><tt class="descname">DEFAULT_REAP_TIMEOUT</tt><a class="headerlink" href="#celery.conf.DEFAULT_REAP_TIMEOUT" title="Permalink to this definition">¶</a></dt>
    146. 

  146. <dd><dl class="data">
    147. 

  147. <dt id="celery.conf.LOG_LEVELS">
    148. 

  148. <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>
    149. 

  149. <dd>Mapping of log level names to <tt class="xref docutils literal"><span class="pre">logging</span></tt> module constants.</dd></dl>
    150. 

  150. 

  151. </dd></dl>
    152. 

  152. 

  153. <dl class="data">
    154. 

  154. <dt id="celery.conf.EMPTY_MSG_EMIT_EVERY">
    155. 

  155. <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>
    156. 

  156. <dd><dl class="data">
    157. 

  157. <dt>
    158. 

  158. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_PID_FILE</tt></dt>
    159. 

  159. <dd>Full path to the daemon pidfile.</dd></dl>
    160. 

  160. 

  161. </dd></dl>
    162. 

  162. 

  163. <dl class="data">
    164. 

  164. <dt id="celery.conf.LOG_FORMAT">
    165. 

  165. <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>
    166. 

  166. <dd><dl class="data">
    167. 

  167. <dt>
    168. 

  168. <tt class="descclassname">celery.conf.</tt><tt class="descname">DAEMON_LOG_FILE</tt></dt>
    169. 

  169. <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>
    170. 

  170. 

  171. </dd></dl>
    172. 

  172. 

  173. <dl class="data">
    174. 

  174. <dt>
    175. 

  175. <tt class="descclassname">celery.conf.</tt><tt class="descname">LOG_LEVELS</tt></dt>
    176. 

  176. <dd><dl class="data">
    177. 

  177. <dt>
    178. 

  178. <tt class="descclassname">celery.conf.</tt><tt class="descname">LOG_FORMAT</tt></dt>
    179. 

  179. <dd>The format to use for log messages.
    180. 

  180. 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>
    181. 

  181. 

  182. </dd></dl>
    183. 

  183. 

  184. <dl class="data">
    185. 

  185. <dt>
    186. 

  186. <tt class="descclassname">celery.conf.</tt><tt class="descname">QUEUE_WAKEUP_AFTER</tt></dt>
    187. 

  187. <dd><dl class="data">
    188. 

  188. <dt>
    189. 

  189. <tt class="descclassname">celery.conf.</tt><tt class="descname">EMPTY_MSG_EMIT_EVERY</tt></dt>
    190. 

  190. <dd>How often the celery daemon should write a log message saying there are no
    191. 

  191. 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
    192. 

  192. this message.</dd></dl>
    193. 

  193. 

  194. </dd></dl>
    195. 

  195. 

  196. </div>
    197. 

  197. 

  198. 

  199. 	      </div>
    200. 

  200. 	    </div>
    201. 

  201. 	  </div>
    202. 

  202. 	</div>
    203. 

  203. 	<div class="sidebar">
    204. 

  204. 	  <h3>Contents</h3>
    205. 

  205. 	  <ul class="current">
    206. 

  206. <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
    207. 

  207. <li class="toctree-l1"><a class="reference external" href="../faq.html">Frequently Asked Questions</a></li>
    208. 

  208. <li class="toctree-l1 current"><a class="reference external" href="index.html">Module API Reference</a><ul class="current">
    209. 

  209. <li class="toctree-l2"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
    210. 

  210. <li class="toctree-l2"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
    211. 

  211. <li class="toctree-l2"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
    212. 

  212. <li class="toctree-l2"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
    213. 

  213. <li class="toctree-l2"><a class="reference external" href="celery.worker.html">Multiprocessing Worker - celery.worker</a></li>
    214. 

  214. <li class="toctree-l2"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
    215. 

  215. <li class="toctree-l2"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
    216. 

  216. <li class="toctree-l2"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
    217. 

  217. <li class="toctree-l2"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
    218. 

  218. <li class="toctree-l2"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
    219. 

  219. <li class="toctree-l2 current"><a class="current reference external" href="">Configuration - celery.conf</a></li>
    220. 

  220. <li class="toctree-l2"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
    221. 

  221. <li class="toctree-l2"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
    222. 

  222. <li class="toctree-l2"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
    223. 

  223. <li class="toctree-l2"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
    224. 

  224. <li class="toctree-l2"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
    225. 

  225. <li class="toctree-l2"><a class="reference external" href="celery.platform.html">Platform Specific - celery.platform</a></li>
    226. 

  226. <li class="toctree-l2"><a class="reference external" href="celery.timer.html">Timers - celery.timer</a></li>
    227. 

  227. <li class="toctree-l2"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
    228. 

  228. </ul>
    229. 

  229. </li>
    230. 

  230. </ul>
    231. 

  231. 

  232. 	  <h3 style="margin-top: 1.5em;">Search</h3>
    233. 

  233. 	  <form class="search" action="../search.html" method="get">
    234. 

  234.             <input type="text" name="q" size="18" />
    235. 

  235.             <input type="submit" value="Go" />
    236. 

  236.             <input type="hidden" name="check_keywords" value="yes" />
    237. 

  237.             <input type="hidden" name="area" value="default" />
    238. 

  238.           </form>
    239. 

  239.           <p class="searchtip" style="font-size: 90%">
    240. 

  240.             Enter search terms or a module, class or function name.
    241. 

  241.           </p>
    242. 

  242. 	</div>
    243. 

  243. 	<div class="clearer"></div>
    244. 

  244.       </div>
    245. 

  245.     </div>
    246. 

  246. 

  247.     <div class="footer-wrapper">
    248. 

  248.       <div class="footer">
    249. 

  249. 	<div class="left">
    250. 

  250.           <a href="../genindex.html" title="General Index"
    251. 

  251.              >index</a> |
    252. 

  252.           <a href="../modindex.html" title="Global Module Index"
    253. 

  253.              >modules</a> |
    254. 

  254.           <a href="celery.datastructures.html" title="Datastructures - celery.datastructures"
    255. 

  255.              >next</a> |
    256. 

  256.           <a href="celery.backends.tyrant.html" title="Backend: Tokyo Tyrant - celery.backends.tyrant"
    257. 

  257.              >previous</a>
    258. 

  258.             <br/>
    259. 

  259.             <a href="../sources/reference/celery.conf.txt"
    260. 

  260.                rel="nofollow">Show Source</a>
    261. 

  261. 	</div>
    262. 

  262. 

  263. 	<div class="right">
    264. 

  264. 	  &copy; Copyright 2009, Ask Solem.<br/>
    265. 

  265. 	  Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
    266. 

  266. 	</div>
    267. 

  267. 	<div class="clearer"></div>
    268. 

  268.       </div>
    269. 

  269.     </div>
    270. 

  270. 

  271.   </body>
    272. 

  272. </html>
    273.