Monitor report
Overview
monitor-report evaluates configured checks against a selected pond and writes static report artifacts. Supported checks cover observed values, staleness, ranges, graded scores, and conditional rates.
Example configuration
pond: /path/to/pond # Required: example pond to inspect.
title: Example monitor # Required: report heading.
output_dir: /path/to/report # Required: example artifact destination.
checks: # Required: example with one complete check.
- type: stale-after # Select the staleness-check variant.
id: temperature-freshness # Required: unique check identifier.
label: Temperature freshness # Required: short display label.
description: Sensor reporting # Required: explanation for the report.
href: /temperature.html # Required: example detail-page link.
source: series:///sensors/temperature # Required: example input URL.
value_column: temperature # Required: source measurement column.
timestamp_column: timestamp # Default: event-time column.
unit: "" # Default: no display-unit suffix.
window: 1h # Required: example freshness window.
This is a full configuration for the stale-after check variant, not a
collection of mutually incompatible check options. The reference below
lists every other supported check shape and its required fields.
Use and behavior
Install with pond mknod monitor-report /etc/monitor --config-path monitor.yaml, then run pond run /etc/monitor -- push. Replace the example paths and check with sources and criteria meaningful for your pond.
Nonempty checks require real sources and semantic validation. Missing or stale data follows each check's contract and must not be interpreted as a healthy zero. Rendered reports are snapshots, not proof of collector health or alert delivery.
Full configuration
Settings
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
checks | array of Check | yes | not specified | |
output_dir | string | yes | not specified | |
pond | string | yes | not specified | |
title | string | yes | not specified |
Accumulation
Accepted value: "positive-deltas".
Alarm
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
operator | Alarm Operator | yes | not specified | |
unit | string | no | "" | |
value | number | yes | not specified | Constraints: format="double". |
Alarm Operator
Accepted value: "lt".
Alignment
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
method | Alignment Method | yes | not specified | |
tolerance | string | yes | not specified |
Alignment Method
Accepted value: "previous".
Any Observed Below Check
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
description | string | yes | not specified | |
href | string | yes | not specified | |
id | string | yes | not specified | |
label | string | yes | not specified | |
source | string | yes | not specified | |
threshold | number | yes | not specified | Constraints: format="double". |
timestamp_column | string | no | "timestamp" | |
type | Any Observed Below Type | yes | not specified | |
unit | string | no | "" | |
value_column | string | yes | not specified | |
window | string | yes | not specified |
Any Observed Below Type
Accepted value: "any-observed-below".
Average Range Check
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
description | string | yes | not specified | |
href | string | yes | not specified | |
id | string | yes | not specified | |
label | string | yes | not specified | |
lower_bound | number | yes | not specified | Constraints: format="double". |
source | string | yes | not specified | |
timestamp_column | string | no | "timestamp" | |
type | Average Range Type | yes | not specified | |
unit | string | no | "" | |
upper_bound | number | yes | not specified | Constraints: format="double". |
value_column | string | yes | not specified | |
window | string | yes | not specified |
Average Range Type
Accepted value: "average-range".
Below Check
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
description | string | yes | not specified | |
href | string | yes | not specified | |
id | string | yes | not specified | |
label | string | yes | not specified | |
source | string | yes | not specified | |
threshold | number | yes | not specified | Constraints: format="double". |
timestamp_column | string | no | "timestamp" | |
unit | string | no | "" | |
value_column | string | yes | not specified | |
window | string | yes | not specified |
Check
Choose one of the following:
- Rate While Check
- Any Observed Below Check
- Average Range Check
- Below Check
- Stale After Check
- Graded Score Check
- Stale Or Below Check
- Stale Or All Below Check
- Stale Or Below Any Column Check
Condition
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
predicate | Predicate | yes | not specified | |
source | string | yes | not specified | |
timestamp | string | no | "timestamp" |
Graded Score Check
Classifies the latest sample of a continuous 0.0-1.0-style score into one of four quality bands (good/watch/concern/alarm) instead of a plain pass/fail threshold, for signals like the leak-probability score where a single alarm/healthy split loses the gradient the operator cares about. good_max < watch_max < concern_max must hold; values above concern_max, and a missing/no-data window, both land in the worst (alarm) band -- absence of a recent score is treated as the worst case, not as "unknown", so a quiet source can't hide a real leak behind a gray card.
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
concern_max | number | yes | not specified | Constraints: format="double". |
description | string | yes | not specified | |
good_max | number | yes | not specified | Constraints: format="double". |
href | string | yes | not specified | |
id | string | yes | not specified | |
label | string | yes | not specified | |
source | string | yes | not specified | |
timestamp_column | string | no | "timestamp" | |
type | Graded Score Type | yes | not specified | |
unit | string | no | "" | |
value_column | string | yes | not specified | |
watch_max | number | yes | not specified | Constraints: format="double". |
window | string | yes | not specified |
Graded Score Type
Accepted value: "graded-score".
Measurement
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
accumulation | Accumulation | yes | not specified | |
column | string | yes | not specified | |
source | string | yes | not specified | |
timestamp | string | no | "timestamp" |
Predicate
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
column | string | yes | not specified | |
operator | Predicate Operator | yes | not specified | |
value | string | yes | not specified |
Predicate Operator
Accepted value: "eq".
Rate While Check
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
alarm | Alarm | yes | not specified | |
alignment | Alignment | yes | not specified | |
condition | Condition | yes | not specified | |
description | string | yes | not specified | |
href | string | yes | not specified | |
id | string | yes | not specified | |
label | string | yes | not specified | |
measurement | Measurement | yes | not specified | |
minimum_active_time | string | yes | not specified | |
type | Rate While Type | yes | not specified | |
window | string | yes | not specified |
Rate While Type
Accepted value: "rate-while".
Stale After Check
Alarms when a source has produced zero non-null samples within window. Unlike the other scalar checks, an empty sample set here is the alarm condition rather than an unknown/indeterminate state: it means the data source has stopped producing new data.
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
description | string | yes | not specified | |
href | string | yes | not specified | |
id | string | yes | not specified | |
label | string | yes | not specified | |
source | string | yes | not specified | |
timestamp_column | string | no | "timestamp" | |
type | Stale After Type | yes | not specified | |
unit | string | no | "" | |
value_column | string | yes | not specified | |
window | string | yes | not specified |
Stale After Type
Accepted value: "stale-after".
Stale Or All Below Check
Alarms if the source has produced zero samples at all in the longer stale_window (ingestion has stalled), or if every sample observed within the shorter window is below threshold -- combining the staleness and sustained-low-value failure modes of a single instrument (e.g. well depth) into one check instead of requiring two separate cards. Unlike stale-or-below, this uses "all observed" polarity: a single recent reading at or above threshold is enough to stay healthy.
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
description | string | yes | not specified | |
href | string | yes | not specified | |
id | string | yes | not specified | |
label | string | yes | not specified | |
source | string | yes | not specified | |
stale_window | string | yes | not specified | |
threshold | number | yes | not specified | Constraints: format="double". |
timestamp_column | string | no | "timestamp" | |
type | Stale Or All Below Type | yes | not specified | |
unit | string | no | "" | |
value_column | string | yes | not specified | |
window | string | yes | not specified |
Stale Or All Below Type
Accepted value: "stale-or-all-below".
Stale Or Below Any Column Check
Combines a staleness check on value_column (zero samples within window means the source has stopped reporting, same polarity as stale-after) with a threshold check spread across one or more secondary threshold_columns -- alarm if ANY sample on ANY of those columns is below threshold within the same window -- into a single check/card. Useful when a device's primary signal and some auxiliary signals (e.g. two redundant radio batteries) should be reported as one pass/fail instead of three separate cards. Staleness on the primary column is checked first and takes priority: if the device has stopped reporting at all, the secondary columns (which live on the same stalled device) aren't evaluated separately.
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
description | string | yes | not specified | |
href | string | yes | not specified | |
id | string | yes | not specified | |
label | string | yes | not specified | |
source | string | yes | not specified | |
threshold | number | yes | not specified | Constraints: format="double". |
threshold_columns | array of string | yes | not specified | |
timestamp_column | string | no | "timestamp" | |
type | Stale Or Below Any Column Type | yes | not specified | |
unit | string | no | "" | |
value_column | string | yes | not specified | |
window | string | yes | not specified |
Stale Or Below Any Column Type
Accepted value: "stale-or-below-any-column".
Stale Or Below Check
Alarms if the source has produced zero samples in window (stale or missing), or if any observed sample is below threshold -- combining the staleness and low-value failure modes of a single instrument (e.g. a pH probe) into one check instead of requiring two separate cards.
| Field | Accepted type | Required | Default | Description |
|---|---|---|---|---|
description | string | yes | not specified | |
href | string | yes | not specified | |
id | string | yes | not specified | |
label | string | yes | not specified | |
source | string | yes | not specified | |
threshold | number | yes | not specified | Constraints: format="double". |
timestamp_column | string | no | "timestamp" | |
type | Stale Or Below Type | yes | not specified | |
unit | string | no | "" | |
value_column | string | yes | not specified | |
window | string | yes | not specified |
Stale Or Below Type
Accepted value: "stale-or-below".