Scheduler API
The scheduler runs trains from manifests: stored records of which train to run, when, and with
what input. Manifests are declared at startup on the builder AddScheduler passes its callback, or
created at runtime through ITraxScheduler. How the scheduler works is on
Scheduler.
Trax.Scheduler
Setup
| Page | What it documents |
|---|---|
| AddScheduler | Registers the scheduler; the builder's global options and their ranges |
| ConfigureLocalWorkers | The built-in local worker pool |
| UseRemoteWorkers | Queued runs of chosen trains on a remote HTTP runner |
| UseRemoteRun | Synchronous runs on a remote HTTP runner |
| AddMetadataCleanup | Settings for the periodic deletion of old metadata, which runs by default on a database |
| AddTraxJobRunner | A runner process, with UseTraxJobRunner and UseTraxRunEndpoint |
| AddTraxWorker | A standalone worker that polls background_job |
| AddTraxSchedulerLiveness | The health check that fails when dispatch stops |
Scheduling
| Page | What it documents |
|---|---|
| Schedule / ScheduleAsync | One recurring manifest, and ScheduleOptions |
| ScheduleMany / ScheduleManyAsync | Many manifests of one train, with pruning |
| Dependent scheduling | ThenInclude, Include, IncludeMany, ThenIncludeMany, ScheduleDependentAsync, ScheduleManyDependentAsync |
| Scheduling helpers | Every, Cron, the Schedule record and ManifestOptions |
| IDormantDependentContext | Activating dormant dependents from a running train |
Runtime
| Page | What it documents |
|---|---|
| ITraxScheduler | The runtime scheduling API, TriggerGroupAsync and the dead-letter methods |
| Manifest management | DisableAsync, EnableAsync, TriggerAsync, ScheduleOnceAsync, CancelAsync, CancelGroupAsync |
| IOperationsService | The operations the dashboard and the GraphQL API share |
| IEffectSettingsService | This process's effects and their settings |
| ILogLevelService | This process's log levels |
| IDeadLetterRequeueJobs | Requeue-all as a background job on this node |
Trax.Scheduler.Sqs
| Page | What it documents |
|---|---|
| UseSqsWorkers | Queued runs of chosen trains through an SQS queue, and SqsJobRunnerHandler |
Trax.Scheduler.Lambda
| Page | What it documents |
|---|---|
| UseLambdaWorkers | Queued runs of chosen trains on an AWS Lambda function |
| UseLambdaRun | Synchronous runs on an AWS Lambda function |
Trax.Runner.Lambda
| Page | What it documents |
|---|---|
| TraxLambdaFunction | The base class of a Lambda function that runs trains |
Trax.Effect.Data
| Page | What it documents |
|---|---|
| IWorkQueuePromotion | Confirming and resolving staged work queue entries |