exq v0.13.2 Exq.Stats.Server
Stats process is responsible for recording all stats into Redis.
The stats format is compatible with the Sidekiq stats format, so that The Sidekiq UI can be also used to view Exq status as well, and Exq can run side by side with Sidekiq without breaking any of it's UI.
This includes job success/failure as well as in-progress jobs
Link to this section Summary
Functions
Add in progress worker process
Returns a specification to start this module under a supervisor
Cleanup stats on boot. This includes cleaning up busy workers
Invoked when the server is started. start_link/3 or start/3 will
block until it returns
Remove in progress worker process
Record job as failed
Record job as successfully processes
Link to this section Functions
add_process(stats, namespace, worker, host, job_serialized)
Add in progress worker process
child_spec(arg)
Returns a specification to start this module under a supervisor.
See Supervisor.
cleanup_host_stats(stats, namespace, host)
Cleanup stats on boot. This includes cleaning up busy workers.
force_flush(stats)
generate_instructions(arg)
init(opts)
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.
process_queue(queue, state, redis_batch, size \\ 0)
process_terminated(stats, namespace, process_info)
Remove in progress worker process
record_failure(stats, namespace, error, job)
Record job as failed
record_processed(stats, namespace, job)
Record job as successfully processes