Starts a development environment with in-memory ZooKeeper. Helpful for developing locally without needing to start any other services.

Starts a resource pool to be shared across a group of peers. You should only start one peer group per physical machine.

Starts N virtual peers to execute tasks. In a production environment, you should start by booting up N virtual peers for N cores on the physical machine. Tune performance from there.

Submits a job to Onyx to be scheduled for execution. Takes a map with keys :catalog, :workflow, :flow-conditions, :windows, :triggers, :metadata, and :task-scheduler. Returns a map of :job-id and :task-ids, which map to a UUID and vector of maps respectively. :metadata is a map of values that must serialize to EDN. :metadata will be logged with all task output, and is useful for identifying a particular task based on something other than its name or ID.

Additionally, :metadata may optionally contain a :job-id key. When specified, this key will be used for the job ID instead of a randomly chosen UUID. Repeated submissions of a job with the same :job-id will be treated as an idempotent action. If a job with the same ID has been submitted more than once, the original task IDs associated with the catalog will be returned, and the job will not run again, even if it has been killed or completed. It is undefined behavior to submit two jobs with the same :job-id metadata whose :workflow, :catalog, :flow-conditions, etc are not equal.

Given a job ID, blocks the calling thread until all the tasks for this job have been completed.

Invokes the garbage collector. Compresses the replica in Zookeeper, freeing up storage and deleting log history. Frees up memory on the local, in memory replica on all peers.

Stops this job from executing, never allowing it to be run again.

Sends all events in the log to a core.async channel. Events are received in the order that they appeared in the log. Starts from the beginning of the log, blocking until more entries are available.

Shuts down a single peer, stopping any task that it is presently executing.

Shuts down the peer group, releasing any messaging resources it was holding open.

Shuts down the development environment and stops in memory ZooKeeper.