54 lines
2.0 KiB
Markdown
54 lines
2.0 KiB
Markdown
|
---
|
||
|
|
name: evolv-telemetry-analytics-dashboards
|
||
|
|
description: Design telemetry-to-dashboard contracts for EVOLV operations analytics. Use when defining KPI semantics, chart/topic contracts, aggregation windows, operator diagnostics, and compatibility between node outputs, Influx schema, and dashboard consumers.
|
||
|
|
---
|
||
|
|
|
||
|
|
# EVOLV Telemetry Analytics Dashboards
|
||
|
|
|
||
|
|
## Mission
|
||
|
|
Keep EVOLV telemetry contracts stable, queryable, and useful for operators and performance analysis.
|
||
|
|
|
||
|
|
## Harness Execution Contract
|
||
|
|
- Start from current output payloads, Influx schema assumptions, and dashboard queries.
|
||
|
|
- Define invariants before edits:
|
||
|
|
- KPI semantics remain explicit and comparable over time
|
||
|
|
- topic/field naming stability is preserved or migrated
|
||
|
|
- dashboard failure modes are diagnosable
|
||
|
|
- Validate with query-level and chart-level evidence.
|
||
|
|
|
||
|
|
## Scope
|
||
|
|
- Node outputs in `nodes/*/src/nodeClass.js`
|
||
|
|
- Influx-related contract points and dashboard config/manuals
|
||
|
|
- FlowFuse chart usage and topic/category consistency
|
||
|
|
|
||
|
|
## Workflow
|
||
|
|
1. Inventory KPI producers and consumers.
|
||
|
|
2. Define measurement/tag/field/topic contracts.
|
||
|
|
3. Validate aggregation/downsampling assumptions.
|
||
|
|
4. Ensure chart wiring remains consistent (`msg.topic` category baseline).
|
||
|
|
5. Verify operator readability and anomaly visibility.
|
||
|
|
|
||
|
|
## Standards
|
||
|
|
- Keep KPI definitions versioned and unambiguous.
|
||
|
|
- Preserve backward compatibility for released dashboards.
|
||
|
|
- Avoid overloading fields with mixed semantics.
|
||
|
|
- Pair every contract change with migration notes.
|
||
|
|
|
||
|
|
## Test Expectations
|
||
|
|
Cover:
|
||
|
|
- payload field presence/types for key KPIs
|
||
|
|
- topic/category compatibility for charts
|
||
|
|
- query compatibility for existing dashboards
|
||
|
|
- behavior under missing/null data windows
|
||
|
|
|
||
|
|
## Deliverables
|
||
|
|
Return:
|
||
|
|
- KPI and telemetry contract map
|
||
|
|
- changed files/tests and dashboard impact notes
|
||
|
|
- migration/deprecation notes if compatibility changed
|
||
|
|
|
||
|
|
Decision interview triggers:
|
||
|
|
- KPI definition changes affecting reporting decisions
|
||
|
|
- dashboard contract breaks requiring migration
|
||
|
|
- retention/aggregation changes impacting trend interpretation
|