mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2026-03-25 10:53:05 -04:00
- Updated test cases to reflect new column names (eve_MAC -> eveMac, eve_DateTime -> eveDateTime, etc.) across various test files. - Modified SQL table definitions in the database cleanup and migration tests to use camelCase naming conventions. - Implemented migration tests to ensure legacy column names are correctly renamed to camelCase equivalents. - Ensured that existing data is preserved during the migration process and that views referencing old column names are dropped before renaming. - Verified that the migration function is idempotent, allowing for safe re-execution without data loss.
2.4 KiB
Executable File
2.4 KiB
Executable File
Notifications User Guide
Overview
This guide explains how the notification system works, including its dependencies, available notification types, and device-specific overrides.
Notification Dependencies
The notification system relies on event data from devices and plugins. For notifications to function correctly:
- Devices must have alerts enabled in their settings.
- The notification processor uses the
NTFPRCS_INCLUDED_SECTIONSsetting to determine which types of notifications to send. - Device-specific settings can override global notification rules.
Notification Types
The following notification types are available based on the NTFPRCS_INCLUDED_SECTIONS setting:
new_devices
- Notifies when a new device is detected on the network.
- Only sent if
new_devicesis enabled inNTFPRCS_INCLUDED_SECTIONS.
down_devices
- Notifies when a device goes offline.
- The device must have Alert Down enabled in its settings.
- The notification is only sent if the device has not reconnected within the configured time window of
NTFPRCS_alert_down_time.
down_reconnected
- Notifies when a device that was previously reported as down reconnects.
- The device must have Alert Down enabled.
events
- Notifies about specific events triggered by a device.
- The device must have Alert Events enabled in its settings.
- Includes events:
Connected,Down Reconnected,Disconnected,IP Changed
- you can exclude devices with a custom where condition via the
NTFPRCS_event_conditionsetting
plugins
- Notifies when an event is triggered by a plugin.
- These notifications depend on the plugin's configuration of the
watchedValue1-4values and the<plugin>_REPORT_ONsettings.
Device-Specific Overrides
Certain notifications can be disabled per device:
Alert Events Disabled
- If a device has Alert Events disabled, it will not receive notifications for general events (
eventssection). - This does not affect notifications for
down_devices,down_reconnected, ornew_devices.
Alert Down Disabled
- If a device has Alert Down disabled, it will not receive notifications when it goes offline (
down_devices) or reconnects (down_reconnected).
Usage
- Review the Settings page to configure which notification types should be enabled.
- Ensure that device-specific alert settings align with your requirements.
For additional details, check the Notifications Guide.