OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-19 18:58:41 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix final instances of OpenWeb UI to Open WebUI

Browse Source
This commit is contained in:
chrishart0 2025-02-17 14:34:16 -05:00
parent 5bdd30aadf
commit 1db80f9760
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/getting-started/advanced-topics/monitoring.md
View File

@ -3,21 +3,21 @@ sidebar_position: 6
title: "📊 Monitoring" title: "📊 Monitoring"
--- ---
# Monitoring OpenWeb UI # Monitoring Open WebUI
Monitoring your OpenWeb UI instance is crucial for ensuring reliable service and quickly identifying issues. This guide covers three levels of monitoring: Monitoring your Open WebUI instance is crucial for ensuring reliable service and quickly identifying issues. This guide covers three levels of monitoring:
- Basic health checks for service availability - Basic health checks for service availability
- Model connectivity verification - Model connectivity verification
- Deep health checks with model response testing - Deep health checks with model response testing
## Basic Health Check Endpoint ## Basic Health Check Endpoint
OpenWeb UI exposes a health check endpoint at `/health` that returns a 200 OK status when the service is running properly. Open WebUI exposes a health check endpoint at `/health` that returns a 200 OK status when the service is running properly.
```bash ```bash
# No auth needed for this endpoint # No auth needed for this endpoint
curl https://your-openweb-instance/health curl https://your-open-webuiinstance/health
``` ```
### Using Uptime Kuma ### Using Uptime Kuma
@ -26,8 +26,8 @@ OpenWeb UI exposes a health check endpoint at `/health` that returns a 200 OK st
1. In your Uptime Kuma dashboard, click "Add New Monitor" 1. In your Uptime Kuma dashboard, click "Add New Monitor"
2. Set the following configuration: 2. Set the following configuration:
- Monitor Type: HTTP(s) - Monitor Type: HTTP(s)
- Name: OpenWeb UI - Name: Open WebUI
- URL: `http://your-openweb-instance:8080/health` - URL: `http://your-open-webuiinstance:8080/health`
- Monitoring Interval: 60 seconds (or your preferred interval) - Monitoring Interval: 60 seconds (or your preferred interval)
- Retry count: 3 (recommended) - Retry count: 3 (recommended)
@ -36,16 +36,16 @@ The health check will verify:
- The application is running - The application is running
- Basic database connectivity - Basic database connectivity
## OpenWeb UI Model Connectivity ## Open WebUI Model Connectivity
To verify that OpenWeb UI can successfully connect to and list your configured models, you can monitor the models endpoint. This endpoint requires authentication and checks OpenWeb UI's ability to communicate with your model providers. To verify that Open WebUI can successfully connect to and list your configured models, you can monitor the models endpoint. This endpoint requires authentication and checks Open WebUI's ability to communicate with your model providers.
See [API documentation](https://docs.openwebui.com/getting-started/api-endpoints/#-retrieve-all-models) for more details about the models endpoint. See [API documentation](https://docs.openwebui.com/getting-started/api-endpoints/#-retrieve-all-models) for more details about the models endpoint.
```bash ```bash
# See steps below to get an API key # See steps below to get an API key
curl -H "Authorization: Bearer sk-adfadsflkhasdflkasdflkh" https://your-openweb-instance/api/models curl -H "Authorization: Bearer sk-adfadsflkhasdflkasdflkh" https://your-open-webuiinstance/api/models
``` ```
### Authentication Setup ### Authentication Setup
@ -57,7 +57,7 @@ See [API documentation](https://docs.openwebui.com/getting-started/api-endpoints
2. Get your API key [docs](https://docs.openwebui.com/getting-started/api-endpoints): 2. Get your API key [docs](https://docs.openwebui.com/getting-started/api-endpoints):
- (Optional), consider making a non-admin user for the monitoring API key - (Optional), consider making a non-admin user for the monitoring API key
- Go to Settings > Account in OpenWeb UI - Go to Settings > Account in Open WebUI
- Generate a new API key specifically for monitoring - Generate a new API key specifically for monitoring
- Copy the API key for use in Uptime Kuma - Copy the API key for use in Uptime Kuma
@ -67,8 +67,8 @@ Note: If you don't see the option to generate API keys in your Settings > Accoun
1. Create a new monitor in Uptime Kuma: 1. Create a new monitor in Uptime Kuma:
- Monitor Type: HTTP(s) - JSON Query - Monitor Type: HTTP(s) - JSON Query
- Name: OpenWeb UI Model Connectivity - Name: Open WebUI Model Connectivity
- URL: `http://your-openweb-instance:8080/api/models` - URL: `http://your-open-webuiinstance:8080/api/models`
- Method: GET - Method: GET
- Expected Status Code: 200 - Expected Status Code: 200
- JSON Query: `$count(data[*])>0` - JSON Query: `$count(data[*])>0`
@ -104,7 +104,7 @@ To verify that models can actually process requests, you can monitor the chat co
```bash ```bash
# Test model response # Test model response
curl -X POST https://your-openweb-instance/api/chat/completions \ curl -X POST https://your-open-webuiinstance/api/chat/completions \
-H "Authorization: Bearer sk-adfadsflkhasdflkasdflkh" \ -H "Authorization: Bearer sk-adfadsflkhasdflkasdflkh" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{ -d '{