ZenMonitor v1.0.0 ZenMonitor.Proxy.Batcher View Source
ZenMonitor.Proxy.Batcher is responsible for collecting death_certificates from
ZenMonitor.Proxy destined for the Batcher’s subscriber (normally the subscriber is a
ZenMonitor.Local.Connector)
Periodically it will sweep and send all of the death_certificates it has collected since the last sweep to the subscriber for processing.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Gets the chunk size from the Application Environment
Puts the chunk size into the Application Environment
Enqueues a new death certificate into the batcher
Get a batcher for a given subscriber
Handle enqueuing a new death_certificate
Handle sweep
Invoked when the server is started. start_link/3 or start/3 will
block until it returns
Gets the sweep interval from the Application Environment
Puts the sweep interval into the Application Environment
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor.
Gets the chunk size from the Application Environment
The chunk size is the maximum number of death certificates that will be sent during each sweep, see ZenMonitor.Proxy.Batcher’s @chunk_size for the default value
This can be controlled at boot and runtime with the {:zen_monitor, :batcher_chunk_size} setting, see ZenMonitor.Proxy.Batcher.chunk_size/1 for runtime convenience functionality.
Puts the chunk size into the Application Environment
This is a simple convenience function for overwrite the {:zen_monitor, :batcher_chunk_size} setting at runtime.
Enqueues a new death certificate into the batcher
Get a batcher for a given subscriber
Handle enqueuing a new death_certificate
Simply puts it in the batch queue.
Handle sweep
Every sweep the batcher will send the death_certificates batched up since the last sweep to the subscriber. After that it will schedule another sweep.
Invoked when the server is started. start_link/3 or start/3 will
block until it returns.
args is the argument term (second argument) passed to start_link/3.
Returning {:ok, state} will cause start_link/3 to return
{:ok, pid} and the process to enter its loop.
Returning {:ok, state, timeout} is similar to {:ok, state}
except handle_info(:timeout, state) will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate} is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3 for more information on hibernation.
Returning {:ok, state, {:continue, continue}} is similar to
{:ok, state} except that immediately after entering the loop
the c:handle_continue/2 callback will be invoked with the value
continue as first argument.
Returning :ignore will cause start_link/3 to return :ignore and
the process will exit normally without entering the loop or calling
c:terminate/2. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer. The remainder of the supervision tree will be started
and so the GenServer should not be required by other processes.
It can be started later with Supervisor.restart_child/2 as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServeris disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor. Likely this approach involves callingSupervisor.restart_child/2after a delay to attempt a restart.
Returning {:stop, reason} will cause start_link/3 to return
{:error, reason} and the process to exit with reason reason without
entering the loop or calling c:terminate/2.
Callback implementation for GenServer.init/1.
Gets the sweep interval from the Application Environment
The sweep interval is the number of milliseconds to wait between sweeps, see ZenMonitor.Proxy.Batcher’s @sweep_interval for the default value
This can be controlled at boot and runtime with the {:zen_monitor, :batcher_sweep_interval}
setting, see ZenMonitor.Proxy.Batcher.sweep_interval/1 for runtime convenience functionality.
Puts the sweep interval into the Application Environment
This is a simple convenience function for overwrite the {:zen_monitor, :batcher_sweep_interval} setting at runtime