Upstream Source
This page is part of Truthound Orchestration 3.x.
Source repository: seadonggyun4/truthound-orchestration
Upstream docs path: docs/common/failure-catalog.md
Edit upstream page: Edit in orchestration
Preflight and Runtime Failure Catalog¶
This page translates common failure classes in truthound-orchestration into
operator-facing diagnostics. It is intentionally grounded in real failure
patterns that have already appeared in this repository.
Who This Is For¶
- operators triaging host failures quickly
- teams writing runbooks and release gates
- contributors who need a shared language for failure categories
When To Use It¶
Use this page when a quality workflow fails before execution, during result serialization, or inside CI support-matrix validation.
Prerequisites¶
- access to host logs or CI artifacts
- the host, engine, and source shape involved in the failing run
Minimal Quickstart¶
A useful first pass is:
- identify the host and operation (
check,profile,learn,stream) - check whether failure happened in preflight or execution
- compare the failure against the catalog below
Failure Catalog¶
Compatibility Tuple Mismatch¶
Symptoms:
- installation or test matrix fails before runtime
- host version and Python version fall outside the support matrix
Examples already seen in this repository:
- old Dagster API differences around
asset_check - old Prefect and Pydantic compatibility issues
- dbt adapter version and package-resolution mismatches
First places to read:
- Compatibility
- host-specific install and compatibility pages
Preflight Incompatibility¶
Symptoms:
- run aborts before engine creation or execution
- compatibility report contains one or more failures
Likely causes:
- operation not supported by the selected engine
- source shape needs a connection or serializer the runtime cannot provide
- host-level auto-config does not match the selected execution path
Source Resolution Errors¶
Symptoms:
- local path is treated differently in one host than another
- SQL path reaches execution without a connection
- stream execution cannot infer resumable batches
Likely causes:
- ambiguous source shape
- missing host-native connection layer
- unsupported stream resume assumptions
Result Serialization Drift¶
Symptoms:
- host task succeeds but downstream consumers cannot parse the payload
- custom code reads logs instead of the documented result contract
Likely causes:
- bypassing shared serializer helpers
- host-native payload assumptions not aligned with the shared runtime contract
Docs And CI Contract Regressions¶
Symptoms:
- docs-only change fails
foundationor public-doc checks - top-level CI summaries fail even though runtime code did not change
Examples already seen:
- brittle docs contract wording on the homepage
- public snapshot count drift after orchestration-doc expansion
Host-Specific Legacy API Drift¶
Symptoms:
- a host package imports or decorator signatures differ across supported minors
Examples already seen:
- Dagster asset-check surface differences
- Prefect block serialization and private-attribute issues
Production Pattern¶
- Make preflight visible in CI and deployment smoke paths.
- Keep host-specific troubleshooting tables close to the adapter section.
- Treat docs, support-matrix, and snapshot failures as first-class operator issues, not as “just docs”.