OpenWebUI Prometheus Exporter

A Prometheus exporter for OpenWebUI that provides detailed metrics about users, chats, documents, models, and system status.

Features

• Comprehensive metrics collection from OpenWebUI's PostgreSQL database
• Connection pooling for efficient database access
• Time-windowed queries to prevent database overload
• Flexible time window specification (seconds, minutes, hours, days)
• Modular collector design for easy maintenance and extensions
• Detailed monitoring of:
  • User activity and authentication
  • Chat conversations and folders
  • Documents and knowledge bases
  • AI models and tools
  • System configuration and health

Deployment Options

Quick Start with Docker Compose

1. Create a docker-compose.yml file:

services:
  exporter:
    image: nicholascecere/exporter-openwebui:latest
    ports:
      - "9091:9090"
    environment:
      - OPENWEBUI_DB_PASSWORD=your_password_here
      - OPENWEBUI_DB_HOST=your_db_host

2. Start the exporter:

docker-compose up -d

Kubernetes Deployment

1. Create or download the k8s/deployment.yaml file and configure your database connection:

# In ConfigMap section
data:
  OPENWEBUI_DB_HOST: "your_db_host"

# In Secret section
stringData:
  OPENWEBUI_DB_PASSWORD: "your_password_here"

2. Apply the Kubernetes manifests:

kubectl apply -f k8s/deployment.yaml

The exporter will start on port 9090. Metrics will be available at:

http://localhost:9090/metrics  # Docker Compose
http://openwebui-exporter:9090/metrics  # Kubernetes

Configuration

All configuration is done through environment variables. For a complete list of available environment variables, their descriptions, defaults, and examples, see ENV-VARS.md.

Key configuration features:

• Time windows for limiting SQL query ranges
• Database connection pooling
• Configurable metric update intervals

Metrics Overview

User Metrics

• openwebui_users_total: Total number of registered users
• openwebui_users_active: Number of active users (within request window)
• openwebui_users_by_role: Number of users by role
• openwebui_auth_active: Number of active auth entries
• openwebui_oauth_users: Number of users using OAuth
• openwebui_user_last_active_seconds: Timestamp of last user activity

Chat Metrics

• openwebui_chats_total{model_name="..."}: Total number of chats by model
• openwebui_chats_active{model_name="..."}: Number of non-archived chats by model
• openwebui_chats_archived{model_name="..."}: Number of archived chats by model
• openwebui_chats_pinned{model_name="..."}: Number of pinned chats by model
• openwebui_chats_by_user{model_name="..."}: Number of chats per user by model
• openwebui_chats_shared: Number of shared chats
• openwebui_chat_messages_total{model_name="..."}: Total number of chat messages by model
• openwebui_chat_age_seconds: Age distribution of chats
• openwebui_folders_total: Total number of chat folders
• openwebui_chats_in_folders: Number of chats organized in folders

Document Metrics

• openwebui_documents_total: Total number of documents
• openwebui_documents_by_collection: Number of documents by collection
• openwebui_documents_by_user: Number of documents per user
• openwebui_files_total{knowledge_base_id="...",knowledge_base_name="..."}: Total number of files by knowledge base
• openwebui_files_by_user: Number of files per user
• openwebui_knowledge_bases_total: Total number of knowledge bases
• openwebui_knowledge_bases_by_user: Number of knowledge bases per user
• openwebui_memories_total: Total number of memories
• openwebui_memories_by_user: Number of memories per user
• openwebui_document_age_seconds: Age distribution of documents

Model Metrics

• openwebui_models_total: Total number of models
• openwebui_models_active: Number of active models
• openwebui_models_by_user: Number of models per user
• openwebui_models_by_base: Number of models by base model
• openwebui_tools_total: Total number of tools
• openwebui_tools_by_user: Number of tools per user
• openwebui_functions_total: Total number of functions
• openwebui_functions_active: Number of active functions
• openwebui_functions_global: Number of global functions
• openwebui_functions_by_type: Number of functions by type
• openwebui_functions_by_user: Number of functions per user

System Metrics

• openwebui_config_version: Current configuration version
• openwebui_config_last_update: Timestamp of last configuration update
• openwebui_groups_total: Total number of groups
• openwebui_users_in_groups: Number of users in groups
• openwebui_feedback_total: Total number of feedback entries
• openwebui_feedback_by_type: Number of feedback entries by type

Prometheus Configuration

Add the following to your prometheus.yml:

scrape_configs:
  - job_name: 'openwebui'
    scrape_interval: 15s
    static_configs:
      - targets: ['localhost:9090']  # Docker Compose
      # Or for Kubernetes:
      # - targets: ['openwebui-exporter:9090']

Development

The exporter is organized into modular collectors:

• user_metrics.py: User and authentication metrics
• chat_metrics.py: Chat and conversation metrics
• document_metrics.py: Document and file metrics
• model_metrics.py: AI model and tool metrics
• system_metrics.py: System configuration metrics

Each collector can be extended or modified independently to add new metrics or modify existing ones.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License