阅读中文版本

Build a Health Check Orchestrator

Health Check Orchestrator — a complete walkthrough of composite health checking, covering check registry, parallel runner, timeout guard, and testing.

health_check_orchestrator/
├── src/index.ts
├── src/check-registry.ts
├── src/parallel-runner.ts
├── tests/health_check_orchestrator.test.ts
└── package.json

// Check registry: composite health checking core
export function checkregistry(input: CheckregistryInput): CheckregistryResult {
  // Build the check registry that anchors composite health checking and defines the core data shape.
  return processCheckregistry(input);
}

// Parallel runner — handles composite health checking Add the parallel runner so
export class Parallelrunner {
  constructor(private opts: ParallelrunnerOptions) {}
  async run(ctx: Context): Promise<ParallelrunnerOutput> {
    return this.execute(ctx);
  }
}

// Timeout guard: composite health checking stage
export const timeoutguard = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

// Rollup policy for composite health checking
export async function rolluppolicy(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

// Status cache: composite health checking finalization
export function statuscache(state: State): Result {
  validate(state);
  return finalize(state);
}

Project overview

This project builds a composite health checking system whose reason for existing is rolling up many dependency checks into one health verdict without a single slow check blocking the answer. The temptation in composite health checking is to bolt the interesting part onto a working prototype and discover the hard cases in production; this build inverts that order and treats a dependency check that hangs indefinitely and degrades the health endpoint into a timeout for every caller as the first thing designed, not the last.

You will implement Check registry, Parallel runner, Timeout guard, Rollup policy, and Status cache, each as a module with one responsibility and a test that proves it in isolation. The composite health checking pipeline is then the wiring that composes them, and the integration test is where the composition is shown to survive a dependency check that hangs indefinitely and degrades the health endpoint into a timeout for every caller.

The walkthrough is written for a developer who has used a composite health checking system but has not had to make one honest. It favors explicit data shapes over clever abstractions, and it names the failure each design choice prevents rather than presenting the choice as a style preference.

Each phase ends with something observable — a check registry that returns the right shape, a parallel runner that rejects bad input, an integration test that goes green — so you can stop at any point and still have a composite health checking system that works for the cases covered so far.

What you will build

The finished composite health checking system exposes five capabilities, each with a focused test:

• Check registry
• Parallel runner
• Timeout guard
• Rollup policy
• Status cache

Check registry is the foundation that every later stage assumes; Parallel runner is where composite health checking correctness lives; Timeout guard handles a dependency check that hangs indefinitely and degrades the health endpoint into a timeout for every caller; Rollup policy makes the system observable; and Status cache is the graceful-degradation layer that keeps overload from becoming corruption.

The build keeps the composite health checking logic in ordinary modules you can read in one sitting, and pulls in dependencies only for the parts that are genuinely tedious to hand-roll. That keeps the diff between the tutorial and a real codebase small, and keeps the failure modes visible in code rather than hidden behind a framework.

Architecture and data model

The system is organized around Check registry, Parallel runner, and Timeout guard, with Rollup policy tying them together. Data flows as a registry of named checks each with a timeout, run in parallel and rolled up into an overall status with a short cache.

Each component is a module with a pure interface where practical: the same input produces the same output, and side effects are pushed to the edges. That discipline is what makes the phases independently testable, because a test for Timeout guard does not need to stand up Check registry and Parallel runner to exercise the interesting branch.

The data model is deliberately explicit. A registry of named checks each with a timeout, run in parallel and rolled up into an overall status with a short cache Keeping the shape written down — in a schema, a type, or a fixture — means a change to the shape is a visible diff rather than a silent runtime shift, and it means the integration test can assert against a concrete shape instead of guessing.

Configuration and code are kept apart: the configuration says what composite health checking should do, the modules say how. A reviewer can change a threshold or a policy without reading the implementation, which keeps the risky changes small and lets the diff stand as the review.

The failure path through Timeout guard is designed before the happy path is finished, because a dependency check that hangs indefinitely and degrades the health endpoint into a timeout for every caller is the case that distinguishes a composite health checking system from a demo. Every component declares what it does when its inputs are wrong, and the integration test asserts each of those declarations.

Prerequisites and dependencies

Have these ready before you install anything, so the composite health checking setup is not blocked by a missing tool:

• Node.js 20 LTS or later
• Familiarity with composite health checking fundamentals
• A local environment to run the test suite

The runtime dependencies are chosen to keep the composite health checking datapath legible:

• fastify (^5.0.0) — Health endpoint
• p-timeout (^6.1.0) — Per-check timeout

# setup for health-check-orchestrator
pnpm init
pnpm add fastify p-timeout
pnpm add -D typescript tsx vitest

Versions are pinned to a major range so the composite health checking install is reproducible; commit the lockfile. The check registry reads its operational parameters from the environment and validates them at startup, so a missing value fails the boot rather than the first composite health checking request.

Directory structure

Keep each composite health checking component in its own file so it can be tested without starting the others:

health_check_orchestrator/
├── src/index.ts
├── src/check-registry.ts
├── src/parallel-runner.ts
├── tests/health_check_orchestrator.test.ts
└── package.json

Phase 1: Check registry

Build the check registry that anchors composite health checking and defines the core data shape.

// Check registry: composite health checking core
export function checkregistry(input: CheckregistryInput): CheckregistryResult {
  // Build the check registry that anchors composite health checking and defines the core data shape.
  return processCheckregistry(input);
}

After this phase the check registry works in isolation and is covered by a unit test. The check registry defines the data shape that every later stage assumes, so getting it right first means the later phases compile against a stable contract.

Treat the check registry as the single source of truth for the composite health checking data shape. Validate inputs at the boundary and reject early, so a malformed value never reaches Parallel runner or Timeout guard where its effect would be harder to localize.

Phase 2: Parallel runner

Add the parallel runner so composite health checking can rolling up many dependency correctly.

// Parallel runner — handles composite health checking Add the parallel runner so
export class Parallelrunner {
  constructor(private opts: ParallelrunnerOptions) {}
  async run(ctx: Context): Promise<ParallelrunnerOutput> {
    return this.execute(ctx);
  }
}

After this phase the parallel runner works in isolation and is covered by a unit test. This is where composite health checking correctness lives: the parallel runner is what makes rolling up many dependency checks into one health verdict without a single slow check blocking the answer true, and its test is the proof.

Keep the parallel runner pure where you can. A function that takes an input and returns an output is trivial to test and impossible to mock wrong; a class with hidden state is the opposite. Push side effects to the caller and keep the parallel runner about the transformation.

Phase 3: Timeout guard

Wire the timeout guard to handle a dependency check that without losing data.

// Timeout guard: composite health checking stage
export const timeoutguard = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

After this phase the timeout guard works in isolation and is covered by a unit test. The timeout guard is the difference between a composite health checking system that works on the happy path and one that survives a dependency check that hangs indefinitely and degrades the health endpoint into a timeout for every caller.

Design the failure before the success. Decide what timeout guard does when a dependency check that hangs indefinitely and degrades the health endpoint into a timeout for every caller: reject, retry, shed, or degrade — and write that test first. A composite health checking system whose failure behavior is unspecified will pick one at random under pressure, and it is usually the wrong one.

Phase 4: Rollup policy

Integrate the rollup policy to make composite health checking observable and testable end to end.

// Rollup policy for composite health checking
export async function rolluppolicy(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

After this phase the rollup policy works in isolation and is covered by a unit test. Observability is not a finishing touch; it is how you know the composite health checking system is doing what it claims in production.

Emit one structured event per meaningful action, with enough context to localize a failure without a second round-trip. The rollup policy is what turns “something is slow” into “the parallel runner is slow for inputs matching this shape,” which is the difference between an alert and an investigation.

Phase 5: Status cache

Finalize the status cache so the composite health checking system degrades gracefully under overload.

// Status cache: composite health checking finalization
export function statuscache(state: State): Result {
  validate(state);
  return finalize(state);
}

After this phase the status cache works in isolation and is covered by a unit test. The status cache is what keeps overload from becoming corruption: when the composite health checking system is asked for more than it can do, it degrades in a defined way instead of failing in an undefined one.

Pick a degradation strategy for status cache — shed, queue, or backpressure — and make it explicit in code and in a test. Leaving the behavior to chance is how a composite health checking traffic spike becomes a data loss incident.

Testing

Each phase has a focused test: check registry, parallel runner, and timeout guard are exercised in isolation, then an integration test drives the full composite health checking pipeline and asserts the a dependency check that case is handled.

Start with unit tests that pin each component’s contract: the check registry returns the documented shape, the parallel runner transforms correctly, and the timeout guard fails in the documented way. These tests are fast and they localize regressions to the component that broke.

Then add an integration test that composes the components and drives a realistic composite health checking scenario end to end. Assert the happy path first, then deliberately trigger a dependency check that hangs indefinitely and degrades the health endpoint into a timeout for every caller and assert the system degrades rather than corrupts. Because the components are pure where practical, the integration test stays deterministic rather than flaky.

A composite health checking suite must also prove the negative: bad input is rejected at the boundary, overload is shed rather than queued indefinitely, and a partial failure does not leave the system in an inconsistent state. These are the tests that catch the regressions a happy-path suite never would.

The entire composite health checking suite runs with no external service; every dependency is either in-process or stubbed, so every case is reproducible in CI. That is what lets the timeout guard failure-mode assertions live as tests rather than as a manual checklist that drifts out of date.

# run the composite health checking test suite
pnpm vitest run

Deployment and operations

Run at least two composite health checking instances behind a load balancer and share state in Redis. Set resource limits so composite health checking overload surfaces as backpressure rather than failure.

Run at least two stateless instances behind a load balancer, and move any shared state into a shared store so the composite health checking behavior is global rather than per instance. Size limits so the system sheds load before it runs out of memory, because a composite health checking system that OOMs under load fails in a way that is hard to reason about.

Drain on deploy: stop accepting new work, let in-flight composite health checking operations finish, then exit. Because the system holds no state that cannot be reconstructed, a rollout is a matter of cycling instances one at a time while watching the error rate.

When a dependency is unavailable, decide explicitly whether the composite health checking system fails closed or degrades. Leaving that choice to chance is how a dependency outage becomes a silent data loss, so make the choice visible in code and in a test.

Security considerations

Validate all composite health checking inputs at the boundary, reject oversized payloads before buffering them, and keep secrets in the environment rather than the repository.

The composite health checking system is a choke point, so it is the right place to reject malformed input before it reaches parallel runner or timeout guard. Validate the shape and the size at the edge, and let the inner components assume what they receive is well-formed.

Never log secrets or full payloads; log enough to localize a failure without recording data that should not be on disk. Treat any external call as untrusted and validate its response before using it, because a composite health checking system that trusts its inputs blindly is one malformed response away from corruption.

Keep dependencies pinned and run an audit in CI. A transitive dependency with a known vulnerability is still a vulnerability in your composite health checking system, and the lockfile is what makes the audit meaningful.

Observability

Emit one structured event per composite health checking operation with the inputs’ shape, the outcome, and a correlation id. Track error rate and latency per component and alert on a step change rather than a single spike.

The correlation id is the thread that ties a user-visible symptom to the composite health checking decision and to the component log entry for the same operation. Without it, an investigation starts from a timestamp and a guess.

Watch the timeout guard failure rate separately from the overall error rate. A jump in timeout guard failures usually means a dependency check that hangs indefinitely and degrades the health endpoint into a timeout for every caller, not a bug in parallel runner, and the two have different owners and different fixes.

Chart the share of composite health checking operations that shed, queue, or succeed. A change in the mix points at the cause faster than an aggregate latency can, because each class has a different root.

Troubleshooting

A dependency check that hangs indefinitely and degrades the health endpoint into a timeout for every caller. Reproduce with a minimal fixture, then add a guard test so the composite health checking system rejects the condition loudly.

Performance regresses under composite health checking load. Profile with the sampling analyzer, locate the hot path in parallel runner, and add a targeted benchmark to lock the regression.

Keep the composite health checking dashboards separate from dependency dashboards. When an operation fails, the correlation id lets you decide in seconds whether the fault is check registry, parallel runner, or timeout guard, instead of guessing from a timeout.

Limitations and next steps

• Single-region; multi-region replication is out of scope.
• The check registry is in-process and not horizontally shared by default.
• No auth layer; assume deployment behind an edge that enforces identity.

The composite health checking system is single-region by design; extending to multi-region means making check registry shareable across regions, which is a real change to the consistency model rather than a config flag. The timeout guard is in-process, which is correct for one instance but must move to a shared store before scaling out.

There is no authentication or authorization layer; the system assumes it is deployed behind an edge that enforces identity. Adding one is straightforward but out of scope for this build, and doing it here would distract from the composite health checking correctness that is the point.

The natural next step, once the composite health checking pipeline is trusted in production, is to add a short-TTL cache for idempotent reads and a richer rollup policy that exports histograms rather than counters. Both are additive and neither changes the contracts this build establishes.