Message Broker CLI And SDK Reference

Maturity Status

Reference Summary

Lifecycle CLI

Local CLI Examples

Remote CLI Examples

Remote mode accepts --target http://host:port and optional --api-key <TOKEN>. The CLI sends Authorization: Bearer <TOKEN> for remote GETs and redacts that value in diagnostics bundles.

Diagnostics Bundles

Diagnostics collection writes a validated stornamics.diagnostics_bundle.v1 JSON document with configuration, topology, metrics, stream metadata, cursor state, recent errors, version information, command outputs, and redactions.

Remote collection calls GET /health, GET /metrics, GET /v1/streams, GET /v1/replication/status, and GET /v1/audit/events?start_offset=0&max_records=100. Current collectors reject --include-payloads.

Release Artifact CLI

Rust SDK Entry Points

SDK Publish And Replay Example

use stornamics_message_broker_native::{
    ClientConfig, DurabilityMode, InMemoryBroker, NativeClient, PublishMessage,
    RetentionPolicy, StartPosition, Timestamp,
};

let broker = InMemoryBroker::with_start_time(Timestamp::from_unix_millis(10_000));
let mut client = NativeClient::new(broker, ClientConfig::new("analytics-producer"))?;

client.create_stream("telemetry", DurabilityMode::LocalDisk, RetentionPolicy::default())?;
client.publish(
    PublishMessage::new(
        "telemetry",
        Timestamp::from_unix_millis(1_700_000_000_000),
        b"reading-1".to_vec(),
    )
    .with_message_id("reading-1"),
)?;

let replay = client.subscribe_replay("telemetry", "analytics", StartPosition::Earliest)?;
let fetched = client.fetch(&replay, 100)?;
client.commit_cursor("telemetry", "analytics", "processed", fetched.next_offset)?;

SDK HTTP Queue Example

use stornamics_message_broker_native::{ClientConfig, HttpNativeClient};

let mut client = HttpNativeClient::connect(
    "http://127.0.0.1:9101",
    ClientConfig::new("worker-a"),
)?;

let claim = client.claim_queue("jobs", "workers", 0, 1, Some(30_000))?;
let delivery = &claim.messages[0];
client.retry_delivery(&claim, delivery, "dependency unavailable", 250)?;

HttpNativeClient currently builds unauthenticated http:// requests. Use it against local insecure endpoints or provide a custom SdkHttpTransport when the caller must inject credentials, TLS, tracing, or test fixtures.

Errors And Limits

Review Boundary

Internal review records track this CLI and SDK reference and the evidence required to change release, diagnostic, or SDK status.

Safe Next Steps

• 

  Available: DOCS-031

  Read HTTP reference

  Map the CLI and SDK helpers back to implemented health, stream, record, cursor, queue, replication, audit, metrics, and storage routes.

• 

  Available now

  Run stream and queue quickstart

  Exercise local stream create, publish, replay, queue claim, ack, and inspection behavior.

• 

  Available now

  Review Message Broker evidence

  Check evidence records before strengthening CLI, SDK, support, or pilot-readiness wording.

• 

  Available: DOCS-040

  Compare route and auth scope

  Separate controlled-beta routes from auth, replication, queue, CLI, SDK, and Kafka protocol boundaries.