Skip to main content
FlowWarden Reporter is an open-source Spring Boot library that bridges FlowWarden Stream Core and the FlowWarden Console. Drop it onto your classpath and your application automatically starts reporting stream health, metrics, and checkpoint status — no code changes required.

​
Two Modes of Operation

The Reporter supports two independent modes that can run simultaneously: Both modes share the same StreamMetricsAggregator — no duplicate collection.

​
What Gets Reported

Each heartbeat (Console mode) or scrape (Prometheus mode) contains:

​
Key Features

Zero-code integration

Just add the dependency. The Reporter auto-configures via Spring Boot.

Dual mode

Console mode, Prometheus mode, or both simultaneously. Use what fits your stack.

Resilient

Retries with exponential backoff. Graceful degradation if the Console is unreachable.

Dynamic interval

The Console controls the heartbeat frequency via the ACK response — no restart needed.

​
Prerequisites

  • FlowWarden Stream Core on your classpath (the Reporter implements its StreamMetricsProvider SPI)
  • Java 17+ and Spring Boot 3.2+
  • For Console mode: a FlowWarden Console account with an API key
  • For Prometheus mode: spring-boot-starter-actuator + micrometer-registry-prometheus on the classpath

​
Next Steps

Quick Start

Add the Reporter to your project in 5 minutes.

Configuration

Full reference of all Reporter properties.