Skip to content

Master process

Classes

MasterProcess

1
MasterProcess(*args, **kwargs)

OptionsGroup

Master process is a separate process offering mentoring capabilities for other processes. Only one master process per uWSGI instance.

uWSGI's built-in prefork+threading multi-worker management mode, activated by flicking the master switch on.

Note

For all practical serving deployments it's not really a good idea not to use master mode.

name 

1
.name: str = ''

Name to represent the group.

plugin 

1
.plugin: bool | str = False

Indication this option group belongs to a plugin.

add_cron_task

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
.add_cron_task(
    command: str,  # (1)!
    weekday: Strint = None,  # (2)!
    month: Strint = None,  # (3)!
    day: Strint = None,  # (4)!
    hour: Strint = None,  # (5)!
    minute: Strint = None,  # (6)!
    legion: str | None = None,  # (7)!
    unique: bool | None = None,  # (8)!
    harakiri: int | None = None,  # (9)!
)

  1. Command to execute on schedule (with or without path).

  2. Day of the week number. Defaults to each. 0 - Sunday 1 - Monday 2 - Tuesday 3 - Wednesday 4 - Thursday 5 - Friday 6 - Saturday

  3. Month number 1-12. Defaults to each.

  4. Day of the month number 1-31. Defaults to each.

  5. Hour 0-23. Defaults to each.

  6. Minute 0-59. Defaults to each.

  7. Set legion (cluster) name to use this cron command against. Such commands are only executed by legion lord node.

  8. Marks command as unique. Default to not unique. Some commands can take a long time to finish or just hang doing their thing. Sometimes this is okay, but there are also cases when running multiple instances of the same command can be dangerous.

  9. Enforce a time limit (in seconds) on executed commands. If a command is taking longer it will be killed.

Adds a cron task running the given command on the given schedule. http://uwsgi.readthedocs.io/en/latest/Cron.html

HINTS: * Use negative values to say every: hour=-3 stands for every 3 hours

1
2
* Use - (minus) to make interval:
    minute='13-18'  stands for `from minute 13 to 18`

Note

We use cron2 option available since 1.9.11.

attach_process

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
.attach_process(
    command: str,  # (1)!
    for_legion: bool = False,  # (2)!
    broken_counter: int | None = None,  # (3)!
    pidfile: str | None = None,  # (4)!
    control: bool | None = None,  # (5)!
    daemonize: bool | None = None,  # (6)!
    touch_reload: Strlist = None,  # (7)!
    signal_stop: int | None = None,  # (8)!
    signal_reload: int | None = None,  # (9)!
    honour_stdin: bool | None = None,  # (10)!
    uid: Strint = None,  # (11)!
    gid: Strint = None,  # (12)!
    new_pid_ns: bool | None = None,  # (13)!
    change_dir: str | None = None,  # (14)!
)

  1. The command line to execute.

  2. Legion daemons will be executed only on the legion lord node, so there will always be a single daemon instance running in each legion. Once the lord dies a daemon will be spawned on another node.

  3. Maximum attempts before considering a daemon "broken".

  4. The pidfile path to check (enable smart mode).

  5. If True, the daemon becomes a control one: if it dies the whole uWSGI instance dies.

  6. Daemonize the process (enable smart2 mode).

  7. List of files to check: whenever they are 'touched', the daemon is restarted

  8. The signal number to send to the daemon when uWSGI is stopped.

  9. The signal number to send to the daemon when uWSGI is reloaded.

  10. The signal number to send to the daemon when uWSGI is reloaded.

  11. Drop privileges to the specified uid.

    1
    .. note:: Requires master running as root.

  12. Drop privileges to the specified gid.

    1
    .. note:: Requires master running as root.

  13. Spawn the process in a new pid namespace.

    1
2
3
    .. note:: Requires master running as root.

.. note:: Linux only.

  14. Use chdir() to the specified directory before running the command.

Attaches a command/daemon to the master process.

This will allow the uWSGI master to control/monitor/respawn this process.

http://uwsgi-docs.readthedocs.io/en/latest/AttachingDaemons.html

attach_process_classic

1
2
3
4
5
6
.attach_process_classic(
    command_or_pid_path: str, 
    background: bool,  # (1)!
    control: bool = False,  # (2)!
    for_legion: bool = False,  # (3)!
)

  1. Must indicate whether process is in background.

  2. Consider this process a control: when the daemon dies, the master exits.

    1
    .. note:: pidfile managed processed not supported.

  3. Legion daemons will be executed only on the legion lord node, so there will always be a single daemon instance running in each legion. Once the lord dies a daemon will be spawned on another node.

    Note

    uWSGI 1.9.9+ required.

Attaches a command/daemon to the master process optionally managed by a pidfile.

This will allow the uWSGI master to control/monitor/respawn this process.

Note

This uses old classic uWSGI means of process attaching To have more control use .attach_process() method (requires uWSGI 2.0+)

http://uwsgi-docs.readthedocs.io/en/latest/AttachingDaemons.html

set_basic_params

1
2
3
4
5
6
7
8
.set_basic_params(
    enable: bool | None = None,  # (1)!
    name: str | None = None,  # (2)!
    no_orphans: bool | None = None,  # (3)!
    as_root: bool | None = None,  # (4)!
    subproc_check_interval: int | None = None,  # (5)!
    fifo_file: Strlist | Pathlist = None,  # (6)!
)

  1. Enable uWSGI master process.

  2. Set master process name to given value.

  3. Automatically kill workers if master dies (can be dangerous for availability).

  4. Leave master process running as root.

  5. Set the interval (in seconds) of master checks. Default: 1 The master process makes a scan of subprocesses, etc. every N seconds.

    Warning

    You can increase this time if you need to, but it's DISCOURAGED.

  6. Enables the master FIFO.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    .. note:: Placeholders can be used to build paths, e.g.: {project_runtime_dir}.fifo
  See ``Section.project_name`` and ``Section.runtime_dir``.

Instead of signals, you can tell the master to create a UNIX named pipe (FIFO)
that you may use to issue commands to the master.

Up to 10 different FIFO files supported. By default, the first specified is bound (mapped as '0').

* <http://uwsgi.readthedocs.io/en/latest/MasterFIFO.html#the-master-fifo>

.. note:: Since 1.9.17

set_exception_handling_params

1
2
3
4
5
.set_exception_handling_params(
    handler: Strlist = None,  # (1)!
    catch: bool | None = None,  # (2)!
    no_write_exception: bool | None = None,  # (3)!
)

  1. Register one or more exception handling C-functions.

  2. Catch exceptions and report them as http output (including stack trace and env params).

    1
    .. warning:: Use only for testing purposes.

  3. Disable exception generation on write()/writev().

    1
2
3
    .. note:: This can be combined with ``logging.set_filters(write_errors=False, sigpipe=False)``.

.. note: Currently available for Python.

Exception handling related params.

set_exit_events

1
2
3
4
5
6
.set_exit_events(
    no_workers: bool | None = None, 
    idle: bool | None = None, 
    reload: bool | None = None, 
    sig_term: bool | None = None
)

Do exit on certain events

set_idle_params

1
2
3
4
.set_idle_params(
    timeout: int | None = None,  # (1)!
    exit: bool | None = None,  # (2)!
)

  1. Inactivity timeout in seconds.

  2. Shutdown uWSGI when idle.

Activate idle mode - put uWSGI in cheap mode after inactivity timeout.

set_reload_params

1
2
3
4
.set_reload_params(
    mercy: int | None = None,  # (1)!
    exit: bool | None = None,  # (2)!
)

  1. Set the maximum time (in seconds) we wait for workers and other processes to die during reload/shutdown.

  2. Force exit even if a reload is requested.

Set reload related params.