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

PageWhat it documents
AddSchedulerRegisters the scheduler; the builder's global options and their ranges
ConfigureLocalWorkersThe built-in local worker pool
UseRemoteWorkersQueued runs of chosen trains on a remote HTTP runner
UseRemoteRunSynchronous runs on a remote HTTP runner
AddMetadataCleanupSettings for the periodic deletion of old metadata, which runs by default on a database
AddTraxJobRunnerA runner process, with UseTraxJobRunner and UseTraxRunEndpoint
AddTraxWorkerA standalone worker that polls background_job
AddTraxSchedulerLivenessThe health check that fails when dispatch stops

Scheduling

PageWhat it documents
Schedule / ScheduleAsyncOne recurring manifest, and ScheduleOptions
ScheduleMany / ScheduleManyAsyncMany manifests of one train, with pruning
Dependent schedulingThenInclude, Include, IncludeMany, ThenIncludeMany, ScheduleDependentAsync, ScheduleManyDependentAsync
Scheduling helpersEvery, Cron, the Schedule record and ManifestOptions
IDormantDependentContextActivating dormant dependents from a running train

Runtime

PageWhat it documents
ITraxSchedulerThe runtime scheduling API, TriggerGroupAsync and the dead-letter methods
Manifest managementDisableAsync, EnableAsync, TriggerAsync, ScheduleOnceAsync, CancelAsync, CancelGroupAsync
IOperationsServiceThe operations the dashboard and the GraphQL API share
IEffectSettingsServiceThis process's effects and their settings
ILogLevelServiceThis process's log levels
IDeadLetterRequeueJobsRequeue-all as a background job on this node

Trax.Scheduler.Sqs

PageWhat it documents
UseSqsWorkersQueued runs of chosen trains through an SQS queue, and SqsJobRunnerHandler

Trax.Scheduler.Lambda

PageWhat it documents
UseLambdaWorkersQueued runs of chosen trains on an AWS Lambda function
UseLambdaRunSynchronous runs on an AWS Lambda function

Trax.Runner.Lambda

PageWhat it documents
TraxLambdaFunctionThe base class of a Lambda function that runs trains

Trax.Effect.Data

PageWhat it documents
IWorkQueuePromotionConfirming and resolving staged work queue entries