django-supervisor 0.4.0

理由

如今运行Django项目往往不仅仅是启动一个web服务器。您可能需要让Django在FCGI或CherryPy下运行，后台任务由celeryd管理，周期性任务由celerybeat调度，以及许多其他进程协同工作以保持项目的正常运行。

当您只是开发或调试时，手动启动和停止所有这些不同的进程是非常痛苦的。

当您部署时，确保每个进程都正确地连接到系统启动脚本并进行正确配置是非常痛苦的。

Django-supervisor在您的Django项目和supervisord进程控制系统之间提供了一个便捷的桥梁。它使得启动项目所需的所有进程变得非常简单

$ python myproject/manage.py supervisor

优势

Django-supervisor在supervisord提供的出色功能之上确实是一个很薄的一层。但通过与Django管理脚本的紧密集成，您可以获得一些优势

• manage.py仍然是运行您的项目的单一控制点。

• 在开发环境中运行所有这些进程与在生产环境中运行一样简单。

• 在调试模式下运行时，您会自动重新加载所有进程。

• 进程配置可以依赖于Django设置和环境变量，并且路径相对于您的项目或应用程序。

配置

Django-supervisor 是 supervisord 的包装器，因此它使用相同的配置文件格式。基本上，你可以编写一个类似于 ini 风格的配置文件，其中每个部分定义了一个要启动的进程。以下是一些示例，但请参阅 supervisord 文档以获取所有更详细的细节。

http://www.supervisord.org

要开始使用，只需在 INSTALLED_APPS 中包含“djsupervisor”，并在项目目录中放置一个“supervisord.conf”文件，紧挨着主要的 manage.py 脚本。

一个简单的配置示例可能会同时运行 Django 开发服务器和 Celery 任务守护进程。

[program:webserver]
command={{ PYTHON }} {{ PROJECT_DIR }}/manage.py runserver --noreload

[program:celeryd]
command={{ PYTHON }} {{ PROJECT_DIR }}/manage.py celeryd -l info

现在，当你运行“supervisor”管理命令时，它将检测此文件并为你启动两个进程。

请注意，配置文件是使用 Django 的模板引擎进行解释的。这让你可以做些有趣的事情，比如定位到项目根目录的相对文件路径。

更好的是，你可以根据项目设置或环境来使配置的部分条件化。例如，你可能在进行调试时启动开发服务器，但在生产中运行 FCGI。

[program:webserver]
{% if settings.DEBUG %}
command={{ PYTHON }} {{ PROJECT_DIR }}/manage.py runserver
{% else %}
command={{ PYTHON }} {{ PROJECT_DIR }}/manage.py runfcgi host=127.0.0.1 port=8025
{% endif %}

用法

Django-supervisor 提供了一个名为“supervisor”的新 Django 管理命令，允许你控制属于你的所有项目进程。

当不带参数运行时，它将启动 supervisord 以启动和监视所有配置的进程。以下是一些使用上一节中所示配置文件的示例输出。

$ python myproject/manage.py supervisor
2011-06-07 23:46:45,253 INFO RPC interface 'supervisor' initialized
2011-06-07 23:46:45,253 INFO supervisord started with pid 4787
2011-06-07 23:46:46,258 INFO spawned: 'celeryd' with pid 4799
2011-06-07 23:46:46,275 INFO spawned: 'webserver' with pid 4801
2011-06-07 23:46:47,456 INFO success: webserver entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
2011-06-07 23:46:56,512 INFO success: celeryd entered RUNNING state, process has stayed up for > than 10 seconds (startsecs)

默认情况下，“supervisor”命令将保持在前台，并将状态更新打印到控制台。传递 –daemonize 选项以使其在后台运行。您还可以使用配置文件中的所有 supervisord 标准选项来调整其行为。

一旦 supervisor 启动并运行，您可以通过与它交互来控制正在运行的进程。运行“manage.py supervisor shell”将启动交互式 supervisorctl 命令行。从这里，您可以查看进程状态并启动/停止/重启单个进程。

$ python myproject/manage.py supervisor shell
celeryd                          RUNNING    pid 4799, uptime 0:03:17
webserver                        RUNNING    pid 4801, uptime 0:03:17
supervisor>
supervisor> help

default commands (type help <topic>):
=====================================
add   clear fg       open quit   remove restart  start  stop update
avail exit  maintail pid  reload reread shutdown status tail version

supervisor>
supervisor> stop celeryd
celeryd: stopped
supervisor>
supervisor> status
celeryd                          STOPPED    Jun 07 11:51 PM
webserver                        RUNNING    pid 4801, uptime 0:04:45
supervisor>

您还可以在命令行上直接发出单个进程管理命令。

$ python myproject/manage.py supervisor start celeryd
celeryd: started
$
$ python myproject/manage.py supervisor status
celeryd                          RUNNING    pid 4937, uptime 0:00:55
webserver                        RUNNING    pid 4801, uptime 0:09:05
$
$ python myproject/manage.py supervisor shutdown
Shut down
$

有关所有可用管理命令的详细信息，请参阅 supervisord 文档。

额外功能

Django-supervisor 在 supervisord 的配置语言之上提供了一些额外的好处。

PROJECT_DIR          the top-level directory of your project (i.e. the
                     directory containing your manage.py script).

APP_DIR              for app-provided config files, the top-level
                     directory containing the application code.

PYTHON               full path to the current python interpreter.

SUPERVISOR_OPTIONS   the command-line options passed to manage.py.

settings             the Django settings module, as seen by your code.

environ              the os.environ dict, as seen by your code.

[program:nginx]
command=nginx -c {{ "nginx.conf"|templated }}

; We want all programs to redirect stderr by default,
; unless specifically configured otherwise.
[program:__defaults__]
redirect_stderr=true

; We force all programs to run as user "nobody"
[program:__overrides__]
user=nobody

; Don't reload programs when python code changes.
[program:autoreload]
exclude=true

[program:non-python-related]
autoreload=false

[program:autoreload]
exclude=true