mirror of
https://github.com/tiennm99/litellm.git
synced 2026-08-18 04:28:19 +00:00
docs
This commit is contained in:
@@ -554,6 +554,8 @@ router_settings:
|
||||
| EMAIL_SIGNATURE | Custom HTML footer/signature for all emails. Can include HTML tags for formatting and links.
|
||||
| EMAIL_SUBJECT_INVITATION | Custom subject template for invitation emails.
|
||||
| EMAIL_SUBJECT_KEY_CREATED | Custom subject template for key creation emails.
|
||||
| EMAIL_BUDGET_ALERT_MAX_SPEND_ALERT_PERCENTAGE | Percentage of max budget that triggers alerts (as decimal: 0.8 = 80%). Default is 0.8
|
||||
| EMAIL_BUDGET_ALERT_TTL | Time-to-live for budget alert deduplication in seconds. Default is 86400 (24 hours)
|
||||
| ENKRYPTAI_API_BASE | Base URL for EnkryptAI Guardrails API. **Default is https://api.enkryptai.com**
|
||||
| ENKRYPTAI_API_KEY | API key for EnkryptAI Guardrails service
|
||||
| EXPERIMENTAL_MULTI_INSTANCE_RATE_LIMITING | Flag to enable new multi-instance rate limiting. **Default is False**
|
||||
|
||||
@@ -94,6 +94,35 @@ On the LiteLLM Proxy UI, go to users > create a new user.
|
||||
|
||||
After creating a new user, they will receive an email invite a the email you specified when creating the user.
|
||||
|
||||
### 3. Configure Budget Alerts (Optional)
|
||||
|
||||
Enable budget alert emails by adding "email" to the `alerts` list in your proxy configuration:
|
||||
|
||||
```yaml showLineNumbers title="proxy_config.yaml"
|
||||
general_settings:
|
||||
alerts: ["email"]
|
||||
```
|
||||
|
||||
#### Budget Alert Types
|
||||
|
||||
**Soft Budget Alerts**: Automatically triggered when a key exceeds its soft budget limit. These alerts help you monitor spending before reaching critical thresholds.
|
||||
|
||||
**Max Budget Alerts**: Automatically triggered when a key reaches a specified percentage of its maximum budget (default: 80%). These alerts warn you when you're approaching budget exhaustion.
|
||||
|
||||
Both alert types send a maximum of one email per 24-hour period to prevent spam.
|
||||
|
||||
#### Configuration Options
|
||||
|
||||
Customize budget alert behavior using these environment variables:
|
||||
|
||||
```yaml showLineNumbers title=".env"
|
||||
# Percentage of max budget that triggers alerts (as decimal: 0.8 = 80%)
|
||||
EMAIL_BUDGET_ALERT_MAX_SPEND_ALERT_PERCENTAGE=0.8
|
||||
|
||||
# Time-to-live for alert deduplication in seconds (default: 24 hours)
|
||||
EMAIL_BUDGET_ALERT_TTL=86400
|
||||
```
|
||||
|
||||
## Email Templates
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
@@ -53,9 +53,19 @@ pip install litellm==1.80.11
|
||||
- **Azure Sentinel Logging** - [New logging integration for Azure Sentinel](../../docs/observability/azure_sentinel)
|
||||
- **Guardrails Load Balancing** - [Load balance between multiple guardrail providers](../../docs/proxy/guardrails)
|
||||
- **Email Budget Alerts** - [Send email notifications when budgets are reached](../../docs/proxy/email)
|
||||
- **Cloudzero Integration on UI** - Setup your Cloudzero Integration Directly on the UI
|
||||
|
||||
---
|
||||
|
||||
### Cloudzero Integration on UI
|
||||
|
||||
<Image
|
||||
img={require('../../img/ui_cloudzero.png')}
|
||||
style={{width: '100%', display: 'block', margin: '2rem auto'}}
|
||||
/>
|
||||
|
||||
Users can now configure their Cloudzero Integration directly on the UI.
|
||||
---
|
||||
## New Providers and Endpoints
|
||||
|
||||
### New Providers (4 new providers)
|
||||
|
||||
Reference in New Issue
Block a user