Use Cases

This section collects implementation blueprints for users who want to apply nats-sinks in a specific operational context while keeping the core package generic. The main documentation explains the framework, configuration, sinks, and delivery guarantees. Use-case pages show how those generic capabilities can be assembled for a particular domain.

Current use-case material includes a defence and mission-support family because those environments often need strict event custody, metadata discipline, redaction, idempotency, and auditable delivery behavior. The patterns remain generic: the same ideas apply to public-sector telemetry, industrial control reporting, regulated operations, and any system where premature ACKs or unclear persistence evidence are unacceptable.

flowchart LR
    NATS[NATS JetStream] --> Core[nats-sinks core]
    Core --> Policy[Optional pre-sink policy]
    Core --> Oracle[Oracle sink]
    Core --> File[File sink]
    Core --> Future[Future sinks]
    UseCases[Use-case blueprints] -. explain profiles .-> Core

Available Blueprints

• Mission-Support Operational Examples
• Restricted Event Storage
• Disconnected File Handoff
• DLQ Triage And Replay Preparation
• Destination Outage Recovery
• Defence And Mission Support
• F2T2EA Event Phase Tagging
• Persisting Link 16 / TADIL-J J-Series Messages To Oracle Database
• Persisting LOGFAS-Related Mission Logistics Events To Oracle Database
• Oracle Label Security With Oracle Database
• Sensor Event Custody
• Classification And Labels
• Chain Of Custody
• Cross-Domain Handoff Preparation
• Cross-Domain Handoff Package
• Edge Operation
• Audit-Oriented Persistence
• Synthetic Mission Testing

The mission-support operational examples show complete patterns such as restricted event storage, disconnected file handoff, DLQ triage, and outage recovery. The defence pages then add domain-specific blueprint language on top of the same generic features. None of these pages define separate product modes, and they do not make nats-sinks a targeting, fire-control, weapons-release, or autonomous decision platform.

Many of these blueprints can use the optional pre-sink policy gate to require classification, labels, mission metadata, encrypted payloads, or payload-size limits before data reaches Oracle, file, or future sinks. The policy remains a generic core feature; the use-case pages simply show how an organization might apply it.

Contribution Guidance

When adding a new use-case page:

1. Keep the feature generic in code and domain-specific in documentation.
2. Use fake subjects, payloads, classifications, and labels.
3. Avoid live service names, IP addresses, connection strings, credentials, certificates, keys, and real operational terminology that could reveal private deployments.
4. Explain which parts are implemented today and which parts are future patterns.
5. Use Mission Metadata for richer structured context instead of adding domain-specific fixed fields to the core.
6. Link back to the generic framework documentation whenever possible.