HealthReport class

Constructors

HealthReport({bool? datastore, HealthLenses? lenses, Loss? lost, HealthPlane? plane, String? reason, String? service, String? status, String? warehouse})
Returns a new HealthReport instance.

Properties

datastore ↔ bool?
Datastore reports whether the shared warehouse client has a live connection. It is load-bearing for the READ path: false is one of the two ways this answers 503.
getter/setter pair
hashCode → int
The hash code for this object.
no setteroverride
lenses ↔ HealthLenses?
Lenses is per-lens table availability, probed only when connected — so it is absent from a degraded report, which has nothing to say about tables it could not reach.
getter/setter pair
lost ↔ Loss?
Lost is the count of facts the sink irrecoverably dropped since boot (warehouse.go). It is reported on the DEGRADED report too, and deliberately: a warehouse that is unreachable is exactly when facts start failing their deliveries, so suppressing the number here would hide it precisely when it moves. ANY NON-ZERO VALUE IS AN ALARM — it counts data the endpoint already answered 200 for.
getter/setter pair
plane ↔ HealthPlane?
Plane reports the event plane — the bus and the stream every accepted event is published to BEFORE any of it reaches the warehouse. It is load-bearing for the WRITE path, and it is here because its absence was a real outage: this endpoint answered 200/ok on warehouse connectivity alone while every POST /v1/event 503'd on a stream that could not bind, so 100% ingest loss was invisible to monitoring. A probe that cannot see the write path cannot report the write path.
getter/setter pair
reason ↔ String?
Reason is the human-readable cause, present only on a degraded report.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
service ↔ String?
Service names the subsystem answering, so a probe aggregating several health endpoints can attribute a degraded one.
getter/setter pair
status ↔ String?
Status is ok or degraded. Degraded is the 503 and means EITHER load-bearing dependency is down — the warehouse this subsystem reads, or the event plane it writes. It is not moved by a missing lens table, which is honest-empty.
getter/setter pair
warehouse ↔ String?
Warehouse names the datastore database every lens reads.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override

Static Methods

fromJson(dynamic value) → HealthReport?
Returns a new HealthReport instance and imports its values from value if it's a Map, null otherwise.
listFromJson(dynamic json, {bool growable = false}) → List<HealthReport>
mapFromJson(dynamic json) → Map<String, HealthReport>
mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<HealthReport>>

Constants

requiredKeys → const Set<String>
The list of required keys that must be present in a JSON.