Skip to content

New dashboards added - #2

Merged
hkir-dev merged 6 commits into
mainfrom
monitors
Sep 18, 2026
Merged

hkir-dev merged 6 commits into
mainfrom
monitors

Conversation

@hkir-dev

Copy link
Copy Markdown
Contributor

This pull request introduces comprehensive documentation and configuration updates to support two new types of dashboard monitors: quality and coverage monitors. The changes clarify how these new monitor types are integrated into the app, how their data is shaped and displayed, and what steps are required to add them. The documentation now thoroughly explains the distinct data flows, registry fields, and UI behaviors for incident, quality, and coverage monitors, and provides clear guidance for contributors extending the dashboard.

Key documentation and configuration updates:

1. Documentation: Monitor Types and Data Flows

  • Expanded both CLAUDE.md and docs/adding-a-dashboard.md to explain the three monitor types (INCIDENTS, QUALITY, COVERAGE), their data sources, shaping modules, page renderers, and the implications for registry fields and UI components. This includes new sections "The backing reads" and detailed comparison tables for monitor behaviors and required sample payloads. [1] [2] [3] [4] [5]

2. Contributor Guidance: Adding New Monitors

  • Updated the step-by-step instructions for adding a new dashboard monitor to account for the new monitor types, including which sample payloads are needed, how to declare sources in the registry, and what additional fields (like rows_id) are required for coverage monitors. [1] [2]

3. API Endpoint and Repository Read Documentation

  • Added new API endpoint patterns and repository read functions for quality and coverage monitors, with explicit mapping for both logical and admin URL shapes. The documentation now covers how each monitor type's data is fetched and used throughout the app. [1] [2] [3]

4. Test Coverage and Validation

  • Clarified how the unit tests (test_registry.py) are parametrized to validate all monitor types, skipping checks that don't apply based on the monitor's declared source, ensuring robust coverage for future extensions. [1] [2]

5. Configuration and Workflow Updates

  • Added example configuration for the coverage report endpoint in .streamlit/secrets.toml.example. Updated deployment workflow (cd.yml) to use the correct Azure endpoint for health checks and reporting. [1] [2] [3]

These changes provide a solid foundation for supporting multiple monitor types, making it easier for contributors to extend the dashboard and for users to understand the data and UI differences between incident, quality, and coverage monitors.

@hkir-dev
hkir-dev merged commit 1f28552 into main Sep 18, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant