Rendered documentation for Github Pages.

Author: Ask Solem

cookbook/daemonizing.html

@@ -58,7 +58,7 @@ <h1>Running celeryd as a daemon<a class="headerlink" href="#running-celeryd-as-a
 daemonization tools.</p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference external" href="#start-stop-daemon" id="id5">start-stop-daemon</a><ul>
+<li><a class="reference external" href="#start-stop-daemon-debian-ubuntu" id="id5">start-stop-daemon (Debian/Ubuntu/++)</a><ul>
 <li><a class="reference external" href="#init-script-celeryd" id="id6">Init script: celeryd</a><ul>
 <li><a class="reference external" href="#example-configuration" id="id7">Example configuration</a></li>
 <li><a class="reference external" href="#example-django-configuration" id="id8">Example Django configuration</a></li>
@@ -73,12 +73,15 @@ <h1>Running celeryd as a daemon<a class="headerlink" href="#running-celeryd-as-a
 </li>
 </ul>
 </li>
-<li><a class="reference external" href="#supervisord" id="id14">supervisord</a></li>
-<li><a class="reference external" href="#launchd-os-x" id="id15">launchd (OS X)</a></li>
+<li><a class="reference external" href="#supervisord" id="id14">supervisord</a><ul>
+<li><a class="reference external" href="#trobuleshooting" id="id15">Trobuleshooting</a></li>
+</ul>
+</li>
+<li><a class="reference external" href="#launchd-os-x" id="id16">launchd (OS X)</a></li>
 </ul>
 </div>
-<div class="section" id="start-stop-daemon">
-<h2><a class="toc-backref" href="#id5">start-stop-daemon</a><a class="headerlink" href="#start-stop-daemon" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="start-stop-daemon-debian-ubuntu">
+<h2><a class="toc-backref" href="#id5">start-stop-daemon (Debian/Ubuntu/++)</a><a class="headerlink" href="#start-stop-daemon-debian-ubuntu" title="Permalink to this headline">¶</a></h2>
 <p>See the <a class="reference external" href="http://github.com/ask/celery/tree/master/contrib/debian/">contrib/debian/init.d/</a> directory in the celery distribution, this
 directory contains init scripts for celeryd and celerybeat.</p>
 <p>These scripts are configured in <tt class="docutils literal"><span class="pre">/etc/default/celeryd</span></tt>.</p>
@@ -142,13 +145,13 @@ <h4><a class="toc-backref" href="#id9">Available options</a><a class="headerlink
 </dl>
 </li>
 <li><dl class="first docutils">
-<dt>CELERYD_PIDFILE</dt>
+<dt>CELERYD_PID_FILE</dt>
 <dd><p class="first last">Full path to the pidfile. Default is /var/run/celeryd.pid.</p>
 </dd>
 </dl>
 </li>
 <li><dl class="first docutils">
-<dt>CELERYD_LOGFILE</dt>
+<dt>CELERYD_LOG_FILE</dt>
 <dd><p class="first last">Full path to the celeryd logfile. Default is /var/log/celeryd.log</p>
 </dd>
 </dl>
@@ -288,9 +291,30 @@ <h2><a class="reference external" href="http://supervisord.org/">supervisord</a>
 <ul class="simple">
 <li><a class="reference external" href="http://github.com/ask/celery/tree/master/contrib/supervisord/">contrib/supervisord/</a></li>
 </ul>
+<div class="section" id="trobuleshooting">
+<h3><a class="toc-backref" href="#id15">Trobuleshooting</a><a class="headerlink" href="#trobuleshooting" title="Permalink to this headline">¶</a></h3>
+<p>If you can&#8217;t get the init scripts to work you should try running
+them in <em>verbose mode</em>:</p>
+<div class="highlight-python"><pre>$ sh -x /etc/init.d/celeryd start</pre>
+</div>
+<p>This can reveal hints as to why the service won&#8217;t start.</p>
+<p>Also you will see the commands generated, you can try to run the celeryd
+command manually to read the resulting error output.</p>
+<p>For example my <tt class="docutils literal"><span class="pre">sh</span> <span class="pre">-x</span></tt> output does this:</p>
+<div class="highlight-python"><pre>++ start-stop-daemon --start --chdir /opt/Opal/release/opal --quiet \
+    --oknodo --background --make-pidfile --pidfile /var/run/celeryd.pid \
+    --exec /opt/Opal/release/opal/manage.py celeryd -- --time-limit=300 \
+    -f /var/log/celeryd.log -l INFO</pre>
+</div>
+<p>Run the celeryd command after <tt class="docutils literal"><span class="pre">--exec</span></tt> (without the <tt class="docutils literal"><span class="pre">--</span></tt>) to show the
+actual resulting output:</p>
+<div class="highlight-python"><pre>$ /opt/Opal/release/opal/manage.py celeryd --time-limit=300 \
+    -f /var/log/celeryd.log -l INFO</pre>
+</div>
+</div>
 </div>
 <div class="section" id="launchd-os-x">
-<h2><a class="toc-backref" href="#id15">launchd (OS X)</a><a class="headerlink" href="#launchd-os-x" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id16">launchd (OS X)</a><a class="headerlink" href="#launchd-os-x" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li><a class="reference external" href="http://github.com/ask/celery/tree/master/contrib/mac/">contrib/mac/</a></li>
 </ul>
@@ -308,7 +332,7 @@ <h2><a class="toc-backref" href="#id15">launchd (OS X)</a><a class="headerlink"
   <h3><a href="../index.html">Table Of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">Running celeryd as a daemon</a><ul>
-<li><a class="reference internal" href="#start-stop-daemon">start-stop-daemon</a><ul>
+<li><a class="reference internal" href="#start-stop-daemon-debian-ubuntu">start-stop-daemon (Debian/Ubuntu/++)</a><ul>
 <li><a class="reference internal" href="#init-script-celeryd">Init script: celeryd</a><ul>
 <li><a class="reference internal" href="#example-configuration">Example configuration</a></li>
 <li><a class="reference internal" href="#example-django-configuration">Example Django configuration</a></li>
@@ -323,7 +347,10 @@ <h3><a href="../index.html">Table Of Contents</a></h3>
 </li>
 </ul>
 </li>
-<li><a class="reference internal" href="#supervisord">supervisord</a></li>
+<li><a class="reference internal" href="#supervisord">supervisord</a><ul>
+<li><a class="reference internal" href="#trobuleshooting">Trobuleshooting</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#launchd-os-x">launchd (OS X)</a></li>
 </ul>
 </li>

cookbook/index.html

@@ -59,7 +59,7 @@ <h1>Cookbook<a class="headerlink" href="#cookbook" title="Permalink to this head
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="daemonizing.html">Running celeryd as a daemon</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="daemonizing.html#start-stop-daemon">start-stop-daemon</a></li>
+<li class="toctree-l2"><a class="reference internal" href="daemonizing.html#start-stop-daemon-debian-ubuntu">start-stop-daemon (Debian/Ubuntu/++)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="daemonizing.html#supervisord">supervisord</a></li>
 <li class="toctree-l2"><a class="reference internal" href="daemonizing.html#launchd-os-x">launchd (OS X)</a></li>
 </ul>

getting-started/index.html

@@ -58,7 +58,7 @@ <h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalin
 <tbody valign="top">
 <tr class="field"><th class="field-name">Release:</th><td class="field-body">2.0</td>
 </tr>
-<tr class="field"><th class="field-name">Date:</th><td class="field-body">July 23, 2010</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">July 27, 2010</td>
 </tr>
 </tbody>
 </table>

internals/index.html

@@ -58,7 +58,7 @@ <h1>Internals<a class="headerlink" href="#internals" title="Permalink to this he
 <tbody valign="top">
 <tr class="field"><th class="field-name">Release:</th><td class="field-body">2.0</td>
 </tr>
-<tr class="field"><th class="field-name">Date:</th><td class="field-body">July 23, 2010</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">July 27, 2010</td>
 </tr>
 </tbody>
 </table>

internals/reference/celery.utils.compat.html

@@ -105,7 +105,7 @@ <h1>Python Compatibility - celery.utils.compat<a class="headerlink" href="#pytho
 
 <dl class="method">
 <dt id="celery.utils.compat.OrderedDict.pop">
-<tt class="descname">pop</tt><big>(</big><em>key</em>, <em>default=&lt;object object at 0x103b38690&gt;</em><big>)</big><a class="headerlink" href="#celery.utils.compat.OrderedDict.pop" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">pop</tt><big>(</big><em>key</em>, <em>default=&lt;object object at 0x10393a0a0&gt;</em><big>)</big><a class="headerlink" href="#celery.utils.compat.OrderedDict.pop" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="method">

internals/reference/celery.utils.html

@@ -279,7 +279,7 @@ <h1>Utilities - celery.utils<a class="headerlink" href="#utilities-celery-utils"
 
 <dl class="function">
 <dt id="celery.utils.retry_over_time">
-<tt class="descclassname">celery.utils.</tt><tt class="descname">retry_over_time</tt><big>(</big><em>fun</em>, <em>catch</em>, <em>args=</em><span class="optional">[</span><span class="optional">]</span>, <em>kwargs={}</em>, <em>errback=&lt;function noop at 0x103bd7c80&gt;</em>, <em>max_retries=None</em>, <em>interval_start=2</em>, <em>interval_step=2</em>, <em>interval_max=30</em><big>)</big><a class="headerlink" href="#celery.utils.retry_over_time" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">celery.utils.</tt><tt class="descname">retry_over_time</tt><big>(</big><em>fun</em>, <em>catch</em>, <em>args=</em><span class="optional">[</span><span class="optional">]</span>, <em>kwargs={}</em>, <em>errback=&lt;function noop at 0x1039ebe60&gt;</em>, <em>max_retries=None</em>, <em>interval_start=2</em>, <em>interval_step=2</em>, <em>interval_max=30</em><big>)</big><a class="headerlink" href="#celery.utils.retry_over_time" title="Permalink to this definition">¶</a></dt>
 <dd><p>Retry the function over and over until max retries is exceeded.</p>
 <p>For each retry we sleep a for a while before we try again, this interval
 is increased for every retry until the max seconds is reached.</p>

internals/reference/celery.worker.html

@@ -58,7 +58,7 @@ <h1>Multiprocessing Worker - celery.worker<a class="headerlink" href="#multiproc
 <span class="target" id="module-celery.worker"></span><p>The Multiprocessing Worker Server</p>
 <dl class="class">
 <dt id="celery.worker.WorkController">
-<em class="property">class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">WorkController</tt><big>(</big><em>concurrency=None</em>, <em>logfile=None</em>, <em>loglevel=None</em>, <em>send_events=False</em>, <em>hostname=None</em>, <em>ready_callback=&lt;function noop at 0x103bd7c80&gt;</em>, <em>embed_clockservice=False</em>, <em>pool_cls='celery.concurrency.processes.TaskPool'</em>, <em>listener_cls='celery.worker.listener.CarrotListener'</em>, <em>mediator_cls='celery.worker.controllers.Mediator'</em>, <em>eta_scheduler_cls='celery.worker.controllers.ScheduleController'</em>, <em>schedule_filename='celerybeat-schedule'</em>, <em>task_time_limit=None</em>, <em>task_soft_time_limit=None</em>, <em>max_tasks_per_child=None</em>, <em>pool_putlocks=True</em>, <em>db=None</em><big>)</big><a class="headerlink" href="#celery.worker.WorkController" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">WorkController</tt><big>(</big><em>concurrency=None</em>, <em>logfile=None</em>, <em>loglevel=None</em>, <em>send_events=False</em>, <em>hostname=None</em>, <em>ready_callback=&lt;function noop at 0x1039ebe60&gt;</em>, <em>embed_clockservice=False</em>, <em>pool_cls='celery.concurrency.processes.TaskPool'</em>, <em>listener_cls='celery.worker.listener.CarrotListener'</em>, <em>mediator_cls='celery.worker.controllers.Mediator'</em>, <em>eta_scheduler_cls='celery.worker.controllers.ScheduleController'</em>, <em>schedule_filename='celerybeat-schedule'</em>, <em>task_time_limit=None</em>, <em>task_soft_time_limit=None</em>, <em>max_tasks_per_child=None</em>, <em>pool_putlocks=True</em>, <em>db=None</em><big>)</big><a class="headerlink" href="#celery.worker.WorkController" title="Permalink to this definition">¶</a></dt>
 <dd><p>Executes tasks waiting in the task queue.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />

internals/reference/celery.worker.job.html

@@ -70,7 +70,7 @@ <h1>Executable Jobs - celery.worker.job<a class="headerlink" href="#executable-j
 
 <dl class="class">
 <dt id="celery.worker.job.TaskRequest">
-<em class="property">class </em><tt class="descclassname">celery.worker.job.</tt><tt class="descname">TaskRequest</tt><big>(</big><em>task_name</em>, <em>task_id</em>, <em>args</em>, <em>kwargs</em>, <em>on_ack=&lt;function noop at 0x103bd7c80&gt;</em>, <em>retries=0</em>, <em>delivery_info=None</em>, <em>hostname=None</em>, <em>email_subject=None</em>, <em>email_body=None</em>, <em>logger=None</em>, <em>eventer=None</em>, <em>**opts</em><big>)</big><a class="headerlink" href="#celery.worker.job.TaskRequest" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">celery.worker.job.</tt><tt class="descname">TaskRequest</tt><big>(</big><em>task_name</em>, <em>task_id</em>, <em>args</em>, <em>kwargs</em>, <em>on_ack=&lt;function noop at 0x1039ebe60&gt;</em>, <em>retries=0</em>, <em>delivery_info=None</em>, <em>hostname=None</em>, <em>email_subject=None</em>, <em>email_body=None</em>, <em>logger=None</em>, <em>eventer=None</em>, <em>**opts</em><big>)</big><a class="headerlink" href="#celery.worker.job.TaskRequest" title="Permalink to this definition">¶</a></dt>
 <dd><p>A request for task execution.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />

internals/reference/celery.worker.listener.html

@@ -123,7 +123,7 @@ <h1>Worker Message Listener - celery.worker.listener<a class="headerlink" href="
 </ul>
 <dl class="class">
 <dt id="celery.worker.listener.CarrotListener">
-<em class="property">class </em><tt class="descclassname">celery.worker.listener.</tt><tt class="descname">CarrotListener</tt><big>(</big><em>ready_queue</em>, <em>eta_schedule</em>, <em>logger</em>, <em>init_callback=&lt;function noop at 0x103bd7c80&gt;</em>, <em>send_events=False</em>, <em>hostname=None</em>, <em>initial_prefetch_count=2</em>, <em>pool=None</em><big>)</big><a class="headerlink" href="#celery.worker.listener.CarrotListener" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">celery.worker.listener.</tt><tt class="descname">CarrotListener</tt><big>(</big><em>ready_queue</em>, <em>eta_schedule</em>, <em>logger</em>, <em>init_callback=&lt;function noop at 0x1039ebe60&gt;</em>, <em>send_events=False</em>, <em>hostname=None</em>, <em>initial_prefetch_count=2</em>, <em>pool=None</em><big>)</big><a class="headerlink" href="#celery.worker.listener.CarrotListener" title="Permalink to this definition">¶</a></dt>
 <dd><p>Listen for messages received from the broker and
 move them the the ready queue for task processing.</p>
 <table class="docutils field-list" frame="void" rules="none">

internals/reference/index.html

@@ -60,7 +60,7 @@ <h1>Internal Module Reference<a class="headerlink" href="#internal-module-refere
 <tbody valign="top">
 <tr class="field"><th class="field-name">Release:</th><td class="field-body">2.0</td>
 </tr>
-<tr class="field"><th class="field-name">Date:</th><td class="field-body">July 23, 2010</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">July 27, 2010</td>
 </tr>
 </tbody>
 </table>