Skip to content

Observability Overview ​

Observability in The Pipeline Framework is designed for distributed pipelines: you should be able to see what each step did, where ownership changed, how long each asynchronous stage took, and where failure semantics changed.

Signal Ownership And Effective Instrumentation ​

Three independent layers decide what you can observe. Keep them separate when diagnosing a missing signal:

LayerQuestionOwner
Build capabilityWas this Quarkus artifact built with the signal capability?The deployable application's Quarkus extensions and build-time settings
TPF telemetry policyShould framework instrumentation emit this signal?pipeline.telemetry.*
Export and runtimeWhere should an enabled signal go, and is a backend available?Deployment Quarkus, OpenTelemetry, Micrometer, and backend configuration

For metrics and tracing, effective framework instrumentation is the intersection of the artifact capability and TPF policy. An OpenTelemetry API dependency alone does not make an artifact tracing- or metrics-capable, and enabling a TPF policy cannot add a signal that was disabled during Quarkus augmentation. Conversely, an enabled signal with no exporter is a valid non-failing configuration: exporter routing and backend health remain deployment-owned.

The master framework switch is also required. A typical telemetry-capable application uses:

properties
pipeline.telemetry.enabled=true
pipeline.telemetry.metrics.enabled=true
pipeline.telemetry.tracing.enabled=true

These properties express TPF intent; they do not install Quarkus extensions, enable a signal that was excluded at build time, or configure an exporter.

When a signal is missing, diagnose the layers in order:

  1. Confirm that the deployable artifact contains the required Quarkus capability and was augmented with that signal enabled.
  2. Confirm that the master TPF policy and the signal-specific TPF policy are enabled in every process that owns part of the pipeline journey, including workers.
  3. Confirm exporter or scrape configuration, then inspect platform exporter logs and backend health.

TPF uses metrics for low-cardinality operational aggregates. Execution, interaction, correlation, and request identities belong in traces, replay, or logs rather than metric labels.

Semantic Coverage ​

TPF records semantic runtime facts explicitly at their ownership seams. Metrics, traces, and replay derive their sink-specific representation from the same fact, but a fact does not need to appear in every signal. Completeness means that each important transition has an explicit observability decision.

For queued, leased, remote, retried, persistent, or durable work, observe paired boundaries rather than only total latency. For example, an Await journey may need interaction creation, provider dispatch, completion admission, live handoff or durable release, continuation, and terminal publication. This is what lets an operator locate ten seconds of delay instead of seeing only a ten-second total.

What You Get Out of the Box ​

Managed external boundaries appear as first-class nodes. Await telemetry distinguishes interaction creation, dispatch, completion admission, live handoff, and durable fallback/release. Command steps appear as command nodes in replay topology and participate in normal step spans and metrics while their effect lifecycle is recorded by the command effect store.