Local changes: Updated model training, removed debug instrumentation, and configuration improvements
This commit is contained in:
141
docs/user_manual/alerts.md
Normal file
141
docs/user_manual/alerts.md
Normal file
@@ -0,0 +1,141 @@
|
||||
# Alerts Guide
|
||||
|
||||
Set up alerts for price movements, indicators, and system events.
|
||||
|
||||
## Alert Types
|
||||
|
||||
### Price Alerts
|
||||
|
||||
Get notified when prices reach specific levels:
|
||||
|
||||
- **Price Above**: Alert when price exceeds threshold
|
||||
- **Price Below**: Alert when price drops below threshold
|
||||
- **Price Change**: Alert on percentage change
|
||||
|
||||
### Indicator Alerts
|
||||
|
||||
Alert on technical indicator conditions:
|
||||
|
||||
- **RSI**: Overbought/oversold conditions
|
||||
- **MACD**: Crossover signals
|
||||
- **Moving Average**: Price crosses moving average
|
||||
- **Bollinger Bands**: Price touches bands
|
||||
|
||||
### Risk Alerts
|
||||
|
||||
Get notified about risk conditions:
|
||||
|
||||
- **Drawdown**: Portfolio drawdown exceeds limit
|
||||
- **Daily Loss**: Daily loss exceeds threshold
|
||||
- **Position Size**: Position exceeds limit
|
||||
- **Margin**: Margin level warnings
|
||||
|
||||
### System Alerts
|
||||
|
||||
System and application alerts:
|
||||
|
||||
- **Connection Lost**: Exchange connection issues
|
||||
- **Order Filled**: Trade execution notifications
|
||||
- **Error**: Application errors
|
||||
- **Update Available**: New version available
|
||||
|
||||
## Creating Alerts
|
||||
|
||||
1. Navigate to Alerts view
|
||||
2. Click "Create Alert"
|
||||
3. Select alert type
|
||||
4. Configure conditions:
|
||||
- **Symbol**: Trading pair
|
||||
- **Condition**: Alert trigger condition
|
||||
- **Value**: Threshold value
|
||||
5. Choose notification method:
|
||||
- **Desktop**: System notification
|
||||
- **Sound**: Audio alert
|
||||
- **Email**: Email notification (if configured)
|
||||
6. Set alert name
|
||||
7. Click "Save"
|
||||
|
||||
## Alert Examples
|
||||
|
||||
### Price Alert Example
|
||||
|
||||
**Alert**: BTC Price Above $50,000
|
||||
- **Type**: Price Alert
|
||||
- **Symbol**: BTC/USD
|
||||
- **Condition**: Price Above
|
||||
- **Value**: 50000
|
||||
- **Notification**: Desktop + Sound
|
||||
|
||||
### RSI Alert Example
|
||||
|
||||
**Alert**: BTC RSI Oversold
|
||||
- **Type**: Indicator Alert
|
||||
- **Symbol**: BTC/USD
|
||||
- **Indicator**: RSI
|
||||
- **Condition**: RSI Below
|
||||
- **Value**: 30
|
||||
- **Timeframe**: 1h
|
||||
|
||||
### Risk Alert Example
|
||||
|
||||
**Alert**: Portfolio Drawdown Warning
|
||||
- **Type**: Risk Alert
|
||||
- **Condition**: Drawdown Exceeds
|
||||
- **Value**: 10%
|
||||
- **Notification**: Desktop + Email
|
||||
|
||||
## Managing Alerts
|
||||
|
||||
### Enabling/Disabling
|
||||
|
||||
- Toggle alerts on/off without deleting
|
||||
- Disabled alerts don't trigger
|
||||
- Useful for temporary disabling
|
||||
|
||||
### Editing Alerts
|
||||
|
||||
1. Select the alert
|
||||
2. Click "Edit"
|
||||
3. Modify conditions
|
||||
4. Save changes
|
||||
|
||||
### Deleting Alerts
|
||||
|
||||
1. Select the alert
|
||||
2. Click "Delete"
|
||||
3. Confirm deletion
|
||||
|
||||
## Alert History
|
||||
|
||||
View all triggered alerts in the Alert History tab:
|
||||
|
||||
1. Navigate to **Settings** page
|
||||
2. Click on **Alert History** tab
|
||||
3. View the table showing:
|
||||
- **Alert Name**: Name of the alert
|
||||
- **Type**: Alert type (price, indicator, risk, system)
|
||||
- **Condition**: The condition that triggered (e.g., "BTC/USD @ $50000")
|
||||
- **Triggered At**: Timestamp when the alert fired
|
||||
- **Status**: Whether the alert is currently enabled or disabled
|
||||
|
||||
The alert history automatically refreshes every 5 seconds to show newly triggered alerts. Only alerts that have been triggered at least once appear in this view.
|
||||
|
||||
## Notification Settings
|
||||
|
||||
Configure notification preferences:
|
||||
|
||||
1. Navigate to Settings > Notifications
|
||||
2. Configure:
|
||||
- **Desktop Notifications**: Enable/disable
|
||||
- **Sound Alerts**: Enable/disable
|
||||
- **Email Notifications**: Configure email settings
|
||||
3. Test notifications
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Set Meaningful Thresholds**: Avoid too many alerts
|
||||
2. **Use Multiple Channels**: Desktop + sound for important alerts
|
||||
3. **Review Regularly**: Clean up unused alerts
|
||||
4. **Test Alerts**: Verify alerts work correctly
|
||||
5. **Monitor Alert History**: Track what triggered
|
||||
|
||||
Reference in New Issue
Block a user