Skip to content

Feat/slot monitoring#66

Merged
SwaroopH merged 16 commits intomainfrom
feat/slot_monitoring
Jul 25, 2025
Merged

Feat/slot monitoring#66
SwaroopH merged 16 commits intomainfrom
feat/slot_monitoring

Conversation

@Seth-Schmidt
Copy link
Contributor

@Seth-Schmidt Seth-Schmidt commented Jul 17, 2025

Fixes #67

Checklist

  • My branch is up-to-date with upstream/main branch.
  • Everything works and tested for major version of Python/NodeJS/Go and above.
  • I ran pre-commit checks against my changes.
  • I've written tests against my changes and all the current present tests are passing.

Current behaviour

The monitoring.md file contains basic troubleshooting guidance but lacks comprehensive documentation for the new
slot monitoring service. The existing documentation is wordy and contains grammatical inconsistencies.

New expected behaviour

  • Added comprehensive documentation for the PowerLoom Slot Monitoring Service in monitoring.md
  • Created a new dedicated setup page (slot-monitoring-setup.md) for the monitoring service
  • Improved grammatical consistency and clarity throughout monitoring.md
  • Added webhook-based notifications support for Slack and Discord
  • Streamlined instructions and fixed numbering issues in environment file editing section

Change logs

Added

  • New "Slot Monitoring Service" section in monitoring.md with comprehensive feature overview
  • New slot-monitoring-setup.md page with complete setup instructions for the monitoring service
  • Documentation for three monitoring modes: Slot Monitor, Active Node Monitor, and Slot Rewards Monitor
  • Webhook configuration examples for both single and multiple webhook setups
  • JSON message format specification for webhook notifications

Changed

  • Improved grammatical consistency and clarity throughout monitoring.md
  • Streamlined section headings for better readability (e.g., "Check Status of Running Docker Containers")
  • Fixed numbered list formatting in environment file editing section
  • Updated container naming patterns to use consistent bullet points
  • Simplified command descriptions and removed redundant phrasing
  • Updated RPC URL provider descriptions for better clarity

Fixed

  • Corrected broken Telegram Bot Setup link path
  • Fixed grammatical errors and inconsistent formatting
  • Improved code block formatting and consistency
  • Fixed numbering sequence in environment file editing instructions

Removed

  • Removed Microsoft Teams references from webhook platform examples

Deployment Instructions

No special deployment instructions required. The changes are documentation-only updates that will be automatically
available once merged to main branch.

…ot Monitoring Service setup guide with detailed instructions and images.
…add titles and sidebar positions for improved navigation.
…instructions for node status checks, troubleshooting, and environment file editing.
@Seth-Schmidt Seth-Schmidt self-assigned this Jul 17, 2025
xadahiya
xadahiya previously approved these changes Jul 21, 2025
Copy link
Contributor

@xadahiya xadahiya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Member

@SwaroopH SwaroopH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Seth-Schmidt you need to remove the /docs prefix - we don't use it anymore. This is breaking the links

@SwaroopH
Copy link
Member

SwaroopH commented Jul 23, 2025

I have* setup the branch to autodeploy here:

https://powerloom-docs-245iq.ondigitalocean.app/

…mpts and webhook configuration details for improved user experience.
…rvice documentation to streamline content and improve clarity.
…e direct links for Docker and Git installation, enhancing clarity and accessibility for users.
…tup documentation for improved clarity and user understanding.
…Service documentation and update the description of the monitoring service modes for clarity.
…necessary quotes around the 'Getting Started' link for improved clarity.
@SwaroopH SwaroopH self-requested a review July 25, 2025 03:17
Copy link
Member

@SwaroopH SwaroopH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@SwaroopH SwaroopH merged commit ffadf6c into main Jul 25, 2025
1 check passed
@SwaroopH SwaroopH deleted the feat/slot_monitoring branch July 30, 2025 02:06
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.

Update monitoring documentation to include the slot monitoring service

4 participants