# {py:mod}archivebox.workers.supervisord\_util ```{py:module} ``` ```{autodoc2-docstring} :allowtitles: ``` ## Module Contents ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`is_port_in_use ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.is_port_in_use :summary: ``` * - {py:obj}`get_sock_file ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.get_sock_file :summary: ``` * - {py:obj}`follow ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.follow :summary: ``` * - {py:obj}`create_supervisord_config ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.create_supervisord_config :summary: ``` * - {py:obj}`create_worker_config ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.create_worker_config :summary: ``` * - {py:obj}`get_existing_supervisord_process ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.get_existing_supervisord_process :summary: ``` * - {py:obj}`stop_existing_supervisord_process ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.stop_existing_supervisord_process :summary: ``` * - {py:obj}`start_new_supervisord_process ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.start_new_supervisord_process :summary: ``` * - {py:obj}`wait_for_supervisord_ready ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.wait_for_supervisord_ready :summary: ``` * - {py:obj}`get_or_create_supervisord_process ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.get_or_create_supervisord_process :summary: ``` * - {py:obj}`start_worker ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.start_worker :summary: ``` * - {py:obj}`get_worker ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.get_worker :summary: ``` * - {py:obj}`stop_worker ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.stop_worker :summary: ``` * - {py:obj}`tail_worker_logs ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.tail_worker_logs :summary: ``` * - {py:obj}`tail_multiple_worker_logs ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.tail_multiple_worker_logs :summary: ``` * - {py:obj}`watch_worker ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.watch_worker :summary: ``` * - {py:obj}`start_server_workers ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.start_server_workers :summary: ``` * - {py:obj}`start_cli_workers ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.start_cli_workers :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`LOG_FILE_NAME ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.LOG_FILE_NAME :summary: ``` * - {py:obj}`CONFIG_FILE_NAME ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.CONFIG_FILE_NAME :summary: ``` * - {py:obj}`PID_FILE_NAME ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.PID_FILE_NAME :summary: ``` * - {py:obj}`WORKERS_DIR_NAME ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.WORKERS_DIR_NAME :summary: ``` * - {py:obj}`_supervisord_proc ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util._supervisord_proc :summary: ``` * - {py:obj}`ORCHESTRATOR_WORKER ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.ORCHESTRATOR_WORKER :summary: ``` * - {py:obj}`SERVER_WORKER ` - ```{autodoc2-docstring} archivebox.workers.supervisord_util.SERVER_WORKER :summary: ``` ```` ### API ````{py:data} :canonical: archivebox.workers.supervisord_util.LOG_FILE_NAME :value: > 'supervisord.log' ```{autodoc2-docstring} archivebox.workers.supervisord_util.LOG_FILE_NAME ``` ```` ````{py:data} :canonical: archivebox.workers.supervisord_util.CONFIG_FILE_NAME :value: > 'supervisord.conf' ```{autodoc2-docstring} archivebox.workers.supervisord_util.CONFIG_FILE_NAME ``` ```` ````{py:data} :canonical: archivebox.workers.supervisord_util.PID_FILE_NAME :value: > 'supervisord.pid' ```{autodoc2-docstring} archivebox.workers.supervisord_util.PID_FILE_NAME ``` ```` ````{py:data} :canonical: archivebox.workers.supervisord_util.WORKERS_DIR_NAME :value: > 'workers' ```{autodoc2-docstring} archivebox.workers.supervisord_util.WORKERS_DIR_NAME ``` ```` ````{py:data} :canonical: archivebox.workers.supervisord_util._supervisord_proc :value: > None ```{autodoc2-docstring} archivebox.workers.supervisord_util._supervisord_proc ``` ```` ````{py:data} :canonical: archivebox.workers.supervisord_util.ORCHESTRATOR_WORKER :value: > None ```{autodoc2-docstring} archivebox.workers.supervisord_util.ORCHESTRATOR_WORKER ``` ```` ````{py:data} :canonical: archivebox.workers.supervisord_util.SERVER_WORKER :value: > None ```{autodoc2-docstring} archivebox.workers.supervisord_util.SERVER_WORKER ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.is_port_in_use ```{autodoc2-docstring} archivebox.workers.supervisord_util.is_port_in_use ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.get_sock_file ```{autodoc2-docstring} archivebox.workers.supervisord_util.get_sock_file ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.follow ```{autodoc2-docstring} archivebox.workers.supervisord_util.follow ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.create_supervisord_config ```{autodoc2-docstring} archivebox.workers.supervisord_util.create_supervisord_config ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.create_worker_config ```{autodoc2-docstring} archivebox.workers.supervisord_util.create_worker_config ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.get_existing_supervisord_process ```{autodoc2-docstring} archivebox.workers.supervisord_util.get_existing_supervisord_process ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.stop_existing_supervisord_process ```{autodoc2-docstring} archivebox.workers.supervisord_util.stop_existing_supervisord_process ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.start_new_supervisord_process ```{autodoc2-docstring} archivebox.workers.supervisord_util.start_new_supervisord_process ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.wait_for_supervisord_ready ```{autodoc2-docstring} archivebox.workers.supervisord_util.wait_for_supervisord_ready ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.get_or_create_supervisord_process ```{autodoc2-docstring} archivebox.workers.supervisord_util.get_or_create_supervisord_process ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.start_worker ```{autodoc2-docstring} archivebox.workers.supervisord_util.start_worker ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.get_worker ```{autodoc2-docstring} archivebox.workers.supervisord_util.get_worker ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.stop_worker ```{autodoc2-docstring} archivebox.workers.supervisord_util.stop_worker ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.tail_worker_logs ```{autodoc2-docstring} archivebox.workers.supervisord_util.tail_worker_logs ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.tail_multiple_worker_logs ```{autodoc2-docstring} archivebox.workers.supervisord_util.tail_multiple_worker_logs ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.watch_worker ```{autodoc2-docstring} archivebox.workers.supervisord_util.watch_worker ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.start_server_workers ```{autodoc2-docstring} archivebox.workers.supervisord_util.start_server_workers ``` ```` ````{py:function} :canonical: archivebox.workers.supervisord_util.start_cli_workers ```{autodoc2-docstring} archivebox.workers.supervisord_util.start_cli_workers ``` ````