[group:x] Section Settings

It is often useful to group “homogeneous” process groups (aka“programs”) together into a “heterogeneous” process group so they canbe controlled as a unit from Supervisor’s various controllerinterfaces.

To place programs into a group so you can treat them as a unit, definea [group:x] section in your configuration file. The group headervalue is a composite. It is the word “group”, followed directly by acolon, then the group name. A header value of [group:foo]describes a group with the name of “foo”. The name is used withinclient applications that control the processes that are created as aresult of this configuration. It is an error to create a groupsection that does not have a name. The name must not include a coloncharacter or a bracket character.

For a [group:x], there must be one or more [program:x]sections elsewhere in your configuration file, and the group mustrefer to them by name in the programs value.

If “homogeneous” process groups (represented by program sections) areplaced into a “heterogeneous” group via [group:x] section’sprograms line, the homogeneous groups that are implied by theprogram section will not exist at runtime in supervisor. Instead, allprocesses belonging to each of the homogeneous groups will be placedinto the heterogeneous group. For example, given the following groupconfiguration:

  1. [group:foo]
  2. programs=bar,baz
  3. priority=999

Given the above, at supervisord startup, the bar and bazhomogeneous groups will not exist, and the processes that would havebeen under them will now be moved into the foo group.

[group:x] Section Values

programs

A comma-separated list of program names. The programs which arelisted become members of the group.

Default: No default (required)

Required: Yes.

Introduced: 3.0

priority

A priority number analogous to a [program:x] priority valueassigned to the group.

Default: 999

Required: No.

Introduced: 3.0

[group:x] Section Example

  1. [group:foo]
  2. programs=bar,baz
  3. priority=999