Forge.Runner (Forge v0.1.1)

View Source

GenServer for executing pipelines.

The Runner manages the execution of a pipeline, coordinating the source, stages, measurements, and storage.

Usage

# Start a runner
{:ok, pid} = Forge.Runner.start_link(
  pipeline_module: MyApp.Pipelines,
  pipeline_name: :data_processing
)

# Run the pipeline
samples = Forge.Runner.run(pid)

# Get status
status = Forge.Runner.status(pid)

# Stop the runner
:ok = Forge.Runner.stop(pid)

Summary

Functions

Returns a specification to start this module under a supervisor.

Runs the pipeline and returns processed samples.

Starts a pipeline runner.

Returns the current status of the runner.

Stops the runner.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

run(runner, timeout \\ :infinity)

Runs the pipeline and returns processed samples.

start_link(opts)

Starts a pipeline runner.

Options

  • :pipeline_module - Module containing pipeline definitions (required)
  • :pipeline_name - Name of the pipeline to run (required)
  • :name - GenServer name (optional)

status(runner)

Returns the current status of the runner.

stop(runner)

Stops the runner.