Métriques

Général

Vous pouvez utiliser Prometheus ou tout autre outil de surveillance compatible OpenMetrics pour obtenir des métriques sur l'utilisation active de LibreChat. Cela inclut des informations techniques comme l'utilisation des jetons, mais aussi des informations sur les utilisateurs finaux comme le nombre total ou actif d'utilisateurs.

LibreChat expose également des métriques Prometheus intégrées depuis le serveur API sur /metrics lorsque METRICS_SECRET est configuré. Récupérez-les avec Authorization: Bearer <METRICS_SECRET>. Les résultats du proxy RUM du navigateur sont rapportés sous la forme rum_proxy_requests_total{endpoint,result}, où endpoint est traces, logs ou unknown, et result peut être success, auth_drop, auth_error, bad_request, not_configured, collector_4xx, collector_5xx, collector_error ou collector_timeout.

L'exportateur de métriques est disponible sur virtUOS/librechat_exporter. Il s'agit d'un outil distinct que vous déployez aux côtés de LibreChat.

Configuration

Pour déployer l'exporter, ajoutez simplement le conteneur nécessaire à votre configuration compose comme ceci :

services:
  metrics:
    image: ghcr.io/virtuos/librechat_exporter:main
    depends_on:
      - mongodb
    ports:
      - '8000:8000'
    restart: unless-stopped

Vous pouvez également configurer l'exportateur en option. Mais en général, les paramètres par défaut devraient très bien convenir.

services:
  metrics:
    environment:
      - MONGODB_URI=mongodb://mongodb:27017/
      - LOGGING_LEVEL=info

Utilisation

Vous pouvez maintenant ajouter l'exportateur à votre configuration de scrape Prometheus :

- job_name: librechat
  static_configs:
    - targets:
        - 'librechat.example.com:8000'

Une fois que la collecte des métriques a commencé, recherchez les métriques librechat_* (par exemple, librechat_registered_users). L'exportateur fournit plusieurs métriques.

Amusez-vous bien à construire votre tableau de bord Grafana !