Динамический надзор поведение

Надзор, который запускает дочерние процессы динамически.

Модуль Supervisor был разработан для управления в основном статическими дочерними процессами, которые запускаются в заданном порядке при запуске надзора. Динамический DynamicSupervisor запускается без дочерних процессов. Вместо этого дочерние процессы запускаются по требованию с помощью start_child/2. При завершении работы динамического надзора все дочерние процессы завершаются одновременно, без гарантии порядка.

Примеры

Динамический надзор запускается без дочерних процессов, часто под надзором с методом управления (единственный поддерживаемый метод в настоящее время — :one_for_one) и именем:

children = [
  {DynamicSupervisor, strategy: :one_for_one, name: MyApp.DynamicSupervisor}
]

Supervisor.start_link(children, strategy: :one_for_one)

Параметры, указанные в спецификации дочернего процесса, описаны в start_link/1.

После запуска динамического надзора мы можем запустить дочерние процессы с помощью start_child/2, который получает спецификацию дочернего процесса:

{:ok, agent1} = DynamicSupervisor.start_child(MyApp.DynamicSupervisor, {Agent, fn -> %{} end})
Agent.update(agent1, &Map.put(&1, :key, "value"))
Agent.get(agent1, & &1)
#=> %{key: "value"}

{:ok, agent2} = DynamicSupervisor.start_child(MyApp.DynamicSupervisor, {Agent, fn -> %{} end})
Agent.get(agent2, & &1)
#=> %{}

DynamicSupervisor.count_children(MyApp.DynamicSupervisor)
#=> %{active: 2, specs: 2, supervisors: 0, workers: 2}

Модульно-ориентированные надзоры

Аналогично Supervisor, динамические надзоры также поддерживают модульно-ориентированные надзоры.

defmodule MyApp.DynamicSupervisor do
  # Automatically defines child_spec/1
  use DynamicSupervisor

  def start_link(arg) do
    DynamicSupervisor.start_link(__MODULE__, arg, name: __MODULE__)
  end

  @impl true
  def init(_arg) do
    DynamicSupervisor.init(strategy: :one_for_one)
  end
end

См. документацию Supervisor для обсуждения случаев, когда вы можете использовать модульно-ориентированные надзоры. Аннотация @doc непосредственно перед use DymamicSupervisor будет добавлена к сгенерированной функции child_spec/1.

Регистрация имени

Надзор подчиняется тем же правилам регистрации имени, что и GenServer. Подробнее об этих правилах см. в документации GenServer.

Миграция из Supervisor's :simple_one_for_one

В случае использования устаревшего метода :simple_one_for_one из модуля Supervisor, вы можете перейти на DynamicSupervisor в несколько шагов.

Представьте данный «старый» код:

defmodule MySupervisor do
  use Supervisor

  def start_link(arg) do
    Supervisor.start_link(__MODULE__, arg, name: __MODULE__)
  end

  def start_child(foo, bar, baz) do
    # This will start child by calling MyWorker.start_link(initial_arg, foo, bar, baz)
    Supervisor.start_child(__MODULE__, [foo, bar, baz])
  end

  @impl true
  def init(initial_arg) do
    children = [
      # Or the deprecated: worker(MyWorker, [initial_arg])
      %{id: MyWorker, start: {MyWorker, :start_link, [initial_arg]}}
    ]

    Supervisor.init(children, strategy: :simple_one_for_one)
  end
end

Его можно обновить на DynamicSupervisor так:

defmodule MySupervisor do
  use DynamicSupervisor

  def start_link(arg) do
    DynamicSupervisor.start_link(__MODULE__, arg, name: __MODULE__)
  end

  def start_child(foo, bar, baz) do
    # If MyWorker is not using the new child specs, we need to pass a map:
    # spec = %{id: MyWorker, start: {MyWorker, :start_link, [foo, bar, baz]}}
    spec = {MyWorker, foo: foo, bar: bar, baz: baz}
    DynamicSupervisor.start_child(__MODULE__, spec)
  end

  @impl true
  def init(initial_arg) do
    DynamicSupervisor.init(
      strategy: :one_for_one,
      extra_arguments: [initial_arg]
    )
  end
end

Разница заключается в том, что DynamicSupervisor ожидает спецификацию дочернего процесса в момент вызова start_child/2, а не в обратном вызове init. Если при инициализации были переданы какие-либо начальные аргументы, такие как [initial_arg], их можно указать в флаге :extra_arguments функции DynamicSupervisor.init/1.

Обзор

Типы

init_option()

Параметры, переданные функциям start_link/2 и init/1

on_start_child()

Возвращаемые значения функций start_child

option()

Значения параметров, используемые функциями start*

options()

Параметры, используемые функциями start*

strategy()

Поддерживаемые стратегии

sup_flags()

Флаги надзора, возвращаемые при инициализации

Функции

child_spec(opts)

Возвращает спецификацию для запуска динамического надзора под надзором.

count_children(supervisor)

Возвращает карту, содержащую значения подсчёта для надзора.

init(options)

Принимает набор options, который инициализирует динамический надзор.

start_child(supervisor, child_spec)

Динамически добавляет спецификацию дочернего процесса к supervisor и запускает этот процесс.

start_link(options)

Запускает надзор с заданными параметрами.

start_link(mod, init_arg, opts \\ [])

Запускает процесс модульно-ориентированного надзора с заданными module и arg.

stop(supervisor, reason \\ :normal, timeout \\ :infinity)

Синхронно останавливает заданный надзор с заданным reason.

terminate_child(supervisor, pid)

Останавливает заданный дочерний процесс, идентифицированный pid.

which_children(supervisor)

Возвращает список с информацией обо всех дочерних процессах.

Обработчики событий

init(init_arg)

Обработчик, вызываемый для запуска надзора и во время горячих обновлений кода.

Типы

init_option()

init_option() ::
  {:strategy, strategy()}
  | {:max_restarts, non_neg_integer()}
  | {:max_seconds, pos_integer()}
  | {:max_children, non_neg_integer() | :infinity}
  | {:extra_arguments, [term()]}

Параметры, переданные функциям start_link/2 и init/1

on_start_child()

on_start_child() ::
  {:ok, pid()}
  | {:ok, pid(), info :: term()}
  | :ignore
  | {:error, {:already_started, pid()} | :max_children | term()}

Возвращаемые значения функций start_child

option()

option() :: {:name, Supervisor.name()} | init_option()

Значения параметров, используемые функциями start*

options()

options() :: [option(), ...]

Параметры, используемые функциями start*

strategy()

strategy() :: :one_for_one

Поддерживаемые стратегии

sup_flags()

sup_flags() :: %{
  strategy: strategy(),
  intensity: non_neg_integer(),
  period: pos_integer(),
  max_children: non_neg_integer() | :infinity,
  extra_arguments: [term()]
}

Флаги надзора, возвращаемые при инициализации

Функции

child_spec(opts)

Возвращает спецификацию для запуска динамического надзора под надзором.

См. Supervisor.

count_children(supervisor)

count_children(Supervisor.supervisor()) :: %{
  specs: non_neg_integer(),
  active: non_neg_integer(),
  supervisors: non_neg_integer(),
  workers: non_neg_integer()
}

Возвращает карту, содержащую значения подсчёта для надзора.

Карта содержит следующие ключи:

• :specs - количество дочерних процессов

• :active - количество активно работающих дочерних процессов, управляемых этим надзором

• :supervisors - количество всех надзоров, независимо от того, жив дочерний процесс или нет

• :workers - количество всех рабочих процессов, независимо от того, жив дочерний процесс или нет

init(options)

init([init_option()]) :: {:ok, sup_flags()}

Принимает набор options для инициализации динамического надзора.

Обычно вызывается в конце обработчика init/1 модульно-ориентированных надзоров. Более подробную информацию см. в разделе «Модульно-ориентированные надзоры» в документации модуля.

options функции также поддерживаются функцией start_link/2.

Эта функция возвращает кортеж, содержащий параметры надзора.

Примеры

def init(_arg) do
  DynamicSupervisor.init(max_children: 1000, strategy: :one_for_one)
end

Параметры

• :strategy - параметр стратегии перезапуска. Единственное поддерживаемое значение — :one_for_one, что означает, что при завершении работы дочернего процесса другие дочерние процессы не останавливаются. Дополнительную информацию о стратегиях см. в документации модуля Supervisor.

• :max_restarts - максимальное количество перезапусков, разрешённых за определённый период. По умолчанию 3.

• :max_seconds - период времени, в течение которого действует :max_restarts. По умолчанию 5.

• :max_children - максимальное количество дочерних процессов, которые могут работать под управлением данного надзора одновременно. При превышении :max_children, start_child/2 возвращает {:error, :max_children}. По умолчанию :infinity.

• :extra_arguments - аргументы, которые добавляются к аргументам, указанным в спецификации дочернего процесса, переданной функции start_child/2. По умолчанию пустой список.

start_child(supervisor, child_spec)

start_child(
  Supervisor.supervisor(),
  Supervisor.child_spec() | {module(), term()} | module()
) :: on_start_child()

Динамически добавляет спецификацию дочернего процесса к supervisor и запускает этот процесс.

child_spec должна быть допустимой спецификацией дочернего процесса, как описано в разделе «child_spec/1» документации Supervisor. Дочерний процесс будет запущен в соответствии со спецификацией.

Если функция запуска дочернего процесса возвращает {:ok, child} или {:ok, child, info}, то спецификация дочернего процесса и идентификатор процесса добавляются в надзор, и эта функция возвращает то же значение.

Если функция запуска дочернего процесса возвращает :ignore, то ни один дочерний процесс не добавляется в дерево надзора, и эта функция также возвращает :ignore.

Если функция запуска дочернего процесса возвращает кортеж с ошибкой или ошибочное значение, или если она завершается с ошибкой, спецификация дочернего процесса игнорируется, и эта функция возвращает {:error, error}, где error — термин, содержащий информацию об ошибке и спецификации дочернего процесса.

Если у надзирателя уже есть N детей таким образом, что N превышает количество :max_children , установленное при инициализации надзирателя (см. init/1), то эта функция возвращает {:error, :max_children}.

start_link(options)

start_link(options()) :: Supervisor.on_start()

Запускает надзирателя с заданными параметрами.

Параметр :strategy является обязательным, и в настоящее время поддерживаемое значение равно :one_for_one. Остальные параметры можно найти в документации init/1.

Параметр :name также можно использовать для регистрации имени надзирателя. Поддерживаемые значения описаны в разделе «Регистрация имени» в документации модуля GenServer.

Если надзиратель успешно запущен, эта функция возвращает {:ok, pid}, где pid — PID надзирателя. Если надзирателю задано имя, и процесс с указанным именем уже существует, функция возвращает {:error, {:already_started, pid}}, где pid — PID этого процесса.

Обратите внимание, что надзиратель, запущенный с помощью этой функции, связан с родительским процессом и завершается не только при сбоях, но также и при завершении родительского процесса с причиной :normal.

start_link(mod, init_arg, opts \\ [])

start_link(module(), term(), GenServer.options()) :: Supervisor.on_start()

Запускает процесс надзирателя на основе модуля с заданными module и arg.

Для запуска надзирателя вызывается обратный вызов init/1 в заданном module, с arg в качестве аргумента. Обратный вызов init/1 должен вернуть спецификацию надзирателя, которую можно создать с помощью функции init/1.

Если обратный вызов init/1 возвращает :ignore, эта функция также возвращает :ignore и надзиратель завершается с причиной :normal. Если произошла ошибка или возвращено неверное значение, эта функция возвращает {:error, term} , где term — термин с информацией об ошибке, и надзиратель завершается с причиной term.

Параметр :name также можно указать для регистрации имени надзирателя, поддерживаемые значения описаны в разделе «Регистрация имени» в документации модуля GenServer.

stop(supervisor, reason \\ :normal, timeout \\ :infinity)

stop(Supervisor.supervisor(), reason :: term(), timeout()) :: :ok

Синхронно останавливает заданного надзирателя с указанной reason.

Возвращает :ok если надзиратель завершился с указанной причиной. Если он завершился по другой причине, вызов завершается.

Эта функция сохраняет семантику OTP относительно отчетов об ошибках. Если причина отличается от :normal, :shutdown или {:shutdown, _}, регистрируется отчет об ошибке.

terminate_child(supervisor, pid)

terminate_child(Supervisor.supervisor(), pid()) :: :ok | {:error, :not_found}

Завершает указанного дочернего процесса, идентифицированного по pid.

При успешном завершении эта функция возвращает :ok. Если процесса с заданным PID нет, функция возвращает {:error, :not_found}.

which_children(supervisor)

which_children(Supervisor.supervisor()) :: [
  {:undefined, pid() | :restarting, :worker | :supervisor,
   :supervisor.modules()}
]

Возвращает список с информацией обо всех детях.

Обратите внимание, что вызов этой функции при наблюдении за большим количеством детей в условиях низкой памяти может привести к исключению из-за нехватки памяти.

Функция возвращает список кортежей, содержащих:

• id — всегда :undefined для динамических надзирателей

• child — PID соответствующего дочернего процесса или атом :restarting , если процесс должен быть перезапущен

• type — :worker или :supervisor , как определено в спецификации дочернего процесса

• modules — как определено в спецификации дочернего процесса

Обратные вызовы

init(init_arg)

init(init_arg :: term()) :: {:ok, sup_flags()} | :ignore

Обратный вызов, вызываемый для запуска надзирателя и во время горячих обновлений кода.

Разработчики обычно вызывают DynamicSupervisor.init/1 в конце своего обратного вызова init, чтобы вернуть правильные флаги управления.