Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add information about default alert settings #611 #637

Closed
wants to merge 2 commits into from

Conversation

Unnati-Gupta24
Copy link

@Unnati-Gupta24 Unnati-Gupta24 commented Feb 9, 2025

Checklist

  • I have read the OpenWISP Contributing Guidelines.
  • I have manually tested the changes proposed in this pull request.
  • I have written new test cases for new code and/or updated existing tests for changes to existing code.
  • I have updated the documentation.

Reference to Existing Issue

Closes #611.

Description of Changes

This PR adds a new section explaining the default alert settings in OpenWISP Monitoring. The updated documentation includes:

  • A new Default Alert Settings section listing predefined alerts.
  • A description of common default alerts such as Ping Loss, High Latency, Low Disk Space, High CPU Usage, and Iperf3 Bandwidth Drop.
  • Clarification that these alerts are customizable via the device page.

These changes enhance the documentation by making it easier for users to understand the built-in monitoring alerts and their behavior.

@nemesifier kindly review it

- **High CPU Usage**: Triggered if CPU usage exceeds **90%** for more than **15 minutes**.
- **Iperf3 Bandwidth Drop**: Triggered if **TCP bandwidth** is less than **10Mbit/s** for more than **2 days**.

These settings can be customized through the device page.
Copy link
Member

Choose a reason for hiding this comment

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

Haven't you noticed that this section is inserted in the middle of the explanation of the iperf3 settings?

Copy link
Author

Choose a reason for hiding this comment

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

Hello @nemesifier,

I apologize for my oversight in placing the "Default Alert Settings" section in the middle of the Iperf3 settings documentation. I have now reorganized the document structure to improve readability and flow.

I have updated it:

  1. Introduction to device checks and alert settings
  2. Default alert settings (moved to the beginning)
  3. Adding custom checks
  4. Customizing specific checks (Iperf3 example)

Please review the changes and let me know if any further improvements are needed.

Thank you for reviewing it.

Copy link
Member

@nemesifier nemesifier left a comment

Choose a reason for hiding this comment

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

I read more closely what's written in there and it looks completely made up. Are you using generative AI to do this?

The default alerts include:

- **Ping Loss**: Triggered if packet loss exceeds **30%** over **5 minutes**.
- **High Latency**: Triggered if response time is greater than **200ms** for **10 consecutive pings**.
Copy link
Member

Choose a reason for hiding this comment

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

Can you please point out the configuration file from which you're getting this?


- **Ping Loss**: Triggered if packet loss exceeds **30%** over **5 minutes**.
- **High Latency**: Triggered if response time is greater than **200ms** for **10 consecutive pings**.
- **Low Disk Space**: Triggered if available disk space falls below **10%**.
Copy link
Member

Choose a reason for hiding this comment

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

Why does the point below mention tolerance while this doesn't?


The default alerts include:

- **Ping Loss**: Triggered if packet loss exceeds **30%** over **5 minutes**.
Copy link
Member

Choose a reason for hiding this comment

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

Can you please point out the configuration file from which you're getting this?

@Unnati-Gupta24 Unnati-Gupta24 closed this by deleting the head repository Feb 19, 2025
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.

[docs] Add information about default alert settings
2 participants