Métricas

Geral

Você pode usar o Prometheus ou qualquer outra ferramenta de monitoramento compatível com OpenMetrics para obter métricas sobre o uso ativo do LibreChat. Isso inclui informações técnicas, como o uso de tokens, mas também informações sobre os usuários finais, como o número total ou de usuários ativos.

O LibreChat também expõe métricas integradas do Prometheus a partir do servidor da API em /metrics quando METRICS_SECRET está configurado. Colete-as com Authorization: Bearer <METRICS_SECRET>. Os resultados do proxy RUM do navegador são reportados como rum_proxy_requests_total{endpoint,result}, onde endpoint é traces, logs ou unknown, e result pode ser success, auth_drop, auth_error, bad_request, not_configured, collector_4xx, collector_5xx, collector_error ou collector_timeout.

O exportador de métricas está disponível em virtUOS/librechat_exporter. É uma ferramenta separada que você implanta junto ao LibreChat.

Configuração

Para implantar o exporter, basta adicionar o container necessário à sua configuração do compose desta forma:

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

Opcionalmente, você também pode configurar o exporter. Mas, geralmente, os padrões devem ser suficientes.

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

Uso

Agora você pode adicionar o exporter à sua configuração de scrape do Prometheus:

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

Assim que a coleta de métricas for iniciada, procure por métricas librechat_* (por exemplo, librechat_registered_users). O exportador fornece várias métricas.

Divirta-se criando seu dashboard no Grafana!