Class StoreAndForwardDiagnostics

java.lang.Object
com.inductiveautomation.ignition.gateway.storeforward.diagnostic.StoreAndForwardDiagnostics

public final class StoreAndForwardDiagnostics extends Object
Renders the parts of the store-and-forward digest that the resource system cannot supply: live engine state, buffer and throughput symptoms, pipeline and sink status, and quarantined batches, all read from EngineInformation rather than from stored configuration. Engine inventory, health, metrics and log events come from the generic resource digest instead.

configure(DefaultResourceAiDelegate.Builder) hangs two sections on the engine resource type's AI delegate, one per flow, and each reads engine state once and renders all of its parts from that read. A section's parts therefore describe the same instant, and a request reads engine state once for the summary and twice for the analysis, rather than once per part.

The shared section carries only what the status page's own poll already computes. Pulling quarantine detail issues a query against every engine's cache and the summary flow runs on every page load, so it is read only for the analysis flow.

  • Method Details

    • configure

      public static void configure(DefaultResourceAiDelegate.Builder builder)
      Declares the subsystem framing, the MDC key that ties log events to an engine, and the sections rendered from live engine state. Call this from the engine resource type's AI delegate declaration; the Store & Forward page then needs no digest registration of its own.

      Takes no gateway context, because the delegate is built when the resource type is declared. Each section receives the live context when it renders.

      Parameters:
      builder - the AI delegate builder for the store-and-forward engine resource type.