diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a3da5a85c6..e0c1051dd2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,6 +7,8 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! + + **💡 Tip:** See our [Troubleshooting Guide](https://docs.litellm.ai/docs/troubleshoot) for what information to include. - type: textarea id: what-happened attributes: diff --git a/docs/my-website/docs/troubleshoot.md b/docs/my-website/docs/troubleshoot.md index 9aa9985e07..c51e5d88b0 100644 --- a/docs/my-website/docs/troubleshoot.md +++ b/docs/my-website/docs/troubleshoot.md @@ -1,12 +1,51 @@ -# Support & Talk with founders +# Troubleshooting & Support + +## Information to Provide When Seeking Help + +When reporting issues, please include as much of the following as possible. It's okay if you can't provide everything—especially in production scenarios where the trigger might be unknown. Sharing most of this information will help us assist you more effectively. + +### 1. LiteLLM Configuration File + +Your `config.yaml` file (redact sensitive info like API keys). Include number of workers if not in config. + +### 2. Initialization Command + +The command used to start LiteLLM (e.g., `litellm --config config.yaml --num_workers 8 --detailed_debug`). + +### 3. Environment Variables + +Non-sensitive environment variables not in your config (e.g., `NUM_WORKERS`, `LITELLM_LOG`, `LITELLM_MODE`, `HOST`, `PORT`, `REDIS_HOST`, `REDIS_PORT`). Do not include passwords or API keys. + +### 4. Server Specifications + +- **Testing/Development:** CPU cores, RAM, OS, Python version, LiteLLM version +- **Production (if different):** CPU cores, RAM, deployment method, number of instances/replicas + +### 5. Database and Redis Usage + +- **Database:** Using database? (`DATABASE_URL` set), database type and version +- **Redis:** Using Redis? Redis version, configuration type (Standalone/Cluster/Sentinel). + +### 6. Endpoints + +The endpoint(s) you're using that are experiencing issues (e.g., `/chat/completions`, `/embeddings`). + +### 7. Request Example + +A realistic example of the request causing issues, including expected vs. actual response and any error messages. + +--- + +## Support Channels + [Schedule Demo 👋](https://calendly.com/d/4mp-gd3-k5k/berriai-1-1-onboarding-litellm-hosted-version) [Community Discord 💭](https://discord.gg/wuPM9dRgDw) [Community Slack 💭](https://www.litellm.ai/support) -Our numbers 📞 +1 (770) 8783-106 / ‭+1 (412) 618-6238‬ +Our numbers 📞 +1 (770) 8783-106 / +1 (412) 618-6238 Our emails ✉️ ishaan@berri.ai / krrish@berri.ai -[![Chat on WhatsApp](https://img.shields.io/static/v1?label=Chat%20on&message=WhatsApp&color=success&logo=WhatsApp&style=flat-square)](https://wa.link/huol9n) [![Chat on Discord](https://img.shields.io/static/v1?label=Chat%20on&message=Discord&color=blue&logo=Discord&style=flat-square)](https://discord.gg/wuPM9dRgDw) +[![Chat on WhatsApp](https://img.shields.io/static/v1?label=Chat%20on&message=WhatsApp&color=success&logo=WhatsApp&style=flat-square)](https://wa.link/huol9n) [![Chat on Discord](https://img.shields.io/static/v1?label=Chat%20on&message=Discord&color=blue&logo=Discord&style=flat-square)](https://discord.gg/wuPM9dRgDw)