Reference
Pages to look things up in. Per-type and per-method pages are in the SDK Reference; the pages here cover what spans several types.
General
- Packages: every Trax package, what it is for and what it needs beside it.
- Glossary: the names Trax uses, with the namespace each lives in.
- Registration Order: which registration calls must come first, and the error each wrong order raises.
- Troubleshooting: the error messages Trax raises, verbatim, with causes and fixes.
- Benchmarks: train overhead against plain code, measured.
- Acknowledgments: the third-party packages Trax depends on.
Trains
- Trains & Junctions: writing trains and junctions, and the startup chain check.
- Building Chains:
Chain,Resolve,ShortCircuit,ExtractandAddServicesinJunctions(). - Decisions: tracks, deciders and how decisions are verified at startup.
- Cancellation Tokens: how a token flows through a run.
- Route and Junction Registration: the
AddTraxRouteandAddTraxJunctionmethods.
Effects
- Metadata: the record every run produces.
- Host Tracking: which host a run ran on.
- JSON Effect: logging tracked model changes in development.
- Parameter Effect: storing inputs and outputs on Metadata.
- Junction Logger: per-junction metadata.
- Junction Progress: the running junction and cancellation between junctions.
- Junction Events: each step of a run, published live and stored.
- Decision Recording and Models: how decisions are recorded and replayed.
Data
- Data Persistence: the Postgres, SQLite and InMemory data providers.
- Schema migrations: every schema migration that changes something visible, Postgres and SQLite paired.
Mediator
- Train Discovery: how trains are found and routed by input type.
State machines
- Lexicon: the file that says what a features directory's words mean, keyword by keyword.
- Feature files: what
trax machine from-gherkinreads and writes: the steps, the glossary,host.jsonandaccess.txt.
Scheduling
- Scheduling Options: manifests, groups and schedule types.
- Exclusion Windows: days, dates and time windows a manifest skips.
- ManifestManager, JobDispatcher, JobRunner and MetadataCleanup: the scheduler's own trains.
GraphQL API and dashboard
- GraphQL Client: the outbound GraphQL client.
- Operations console: the operations console and its pages.
Security
- Authorization: endpoint policies,
TraxAuthorize,TraxAllowAnonymousand startup validation. - Security policy: reporting a vulnerability and supported versions.
Tooling
- CLI: the
traxcommand,generateandmachine. - Project Templates: the
dotnet newtemplates. - Architecture Guards: the guard packages, their fixtures and what they check.
- Analyzer: the deprecated chain analyzer.
- IDE Extensions: inlay hints for VS Code and Rider.