forked from phoenix/litellm-mirror
docs(alerting.md): add slack alerting to docs
This commit is contained in:
parent
d17ffdbc83
commit
ff4eb5a5d4
2 changed files with 37 additions and 0 deletions
36
docs/my-website/docs/proxy/alerting.md
Normal file
36
docs/my-website/docs/proxy/alerting.md
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
# Slack Alerting
|
||||||
|
|
||||||
|
Get alerts for failed db read/writes, hanging api calls, failed api calls.
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
Set up a slack alert channel to receive alerts from proxy.
|
||||||
|
|
||||||
|
### Step 1: Add a Slack Webhook URL to env
|
||||||
|
|
||||||
|
Get a slack webhook url from https://api.slack.com/messaging/webhooks
|
||||||
|
|
||||||
|
|
||||||
|
### Step 2: Update config.yaml
|
||||||
|
|
||||||
|
Let's save a bad key to our proxy
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
model_list:
|
||||||
|
model_name: "azure-model"
|
||||||
|
litellm_params:
|
||||||
|
model: "azure/gpt-35-turbo"
|
||||||
|
api_key: "my-bad-key" # 👈 bad key
|
||||||
|
|
||||||
|
general_settings:
|
||||||
|
alerting: ["slack"]
|
||||||
|
|
||||||
|
environment_variables:
|
||||||
|
SLACK_WEBHOOK_URL: "https://hooks.slack.com/services/<>/<>/<>"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 3: Start proxy
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ litellm /path/to/config.yaml
|
||||||
|
```
|
|
@ -113,6 +113,7 @@ const sidebars = {
|
||||||
"proxy/health",
|
"proxy/health",
|
||||||
"proxy/call_hooks",
|
"proxy/call_hooks",
|
||||||
"proxy/caching",
|
"proxy/caching",
|
||||||
|
"proxy/alerting",
|
||||||
"proxy/logging",
|
"proxy/logging",
|
||||||
"proxy/streaming_logging",
|
"proxy/streaming_logging",
|
||||||
"proxy/deploy",
|
"proxy/deploy",
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue