Skip to content

Conversation

@Jim8y
Copy link
Contributor

@Jim8y Jim8y commented Dec 12, 2025

Summary

This PR adds comprehensive documentation and monitoring configuration files for the Telemetry plugin.

Changes

  • Add README.md with:
    • Installation instructions
    • Configuration reference
    • Complete metrics reference
    • Prometheus integration examples
    • PromQL query examples
    • Troubleshooting guide
  • Add Grafana dashboard JSON (dashboards/neo-node-dashboard.json)
  • Add Prometheus alerting rules (alerting/neo-alerts.yml)
  • Add Prometheus scrape configuration (alerting/prometheus-scrape.yml)

Files Changed

  • src/Plugins/Telemetry/README.md
  • src/Plugins/Telemetry/dashboards/neo-node-dashboard.json
  • src/Plugins/Telemetry/alerting/neo-alerts.yml
  • src/Plugins/Telemetry/alerting/prometheus-scrape.yml

Test Plan

  • Documentation is accurate and matches code
  • Grafana dashboard imports successfully
  • Alerting rules are syntactically valid
  • Example configurations work with Prometheus

Depends On

@Jim8y Jim8y changed the base branch from telemetry-3 to telemetry December 12, 2025 01:53
@Jim8y Jim8y marked this pull request as draft December 12, 2025 02:13
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.

2 participants