メトリクス

このドキュメントでは、LibreChatにPrometheus用のメトリクスエクスポーターを追加する方法を説明します。

一般

LibreChatのアクティブユーザー

Prometheus やその他の OpenMetrics 互換の監視ツールを使用して、LibreChat のアクティブな使用状況に関するメトリクスを取得できます。これには、トークンの使用量といった技術的な情報だけでなく、合計ユーザー数やアクティブユーザー数といったエンドユーザーに関する情報も含まれます。

LibreChatは、METRICS_SECRETが設定されている場合、APIサーバーの /metrics で組み込みのPrometheusメトリクスを公開します。Authorization: Bearer <METRICS_SECRET> を使用してスクレイピングしてください。ブラウザのRUMプロキシの結果は rum_proxy_requests_total{endpoint,result} として報告されます。ここで endpoint は traces、logs、または unknown であり、result は success、auth_drop、auth_error、bad_request、not_configured、collector_4xx、collector_5xx、collector_error、または collector_timeout となります。

メトリクスエクスポーターは virtUOS/librechat_exporter で利用可能です。これは LibreChat と並行してデプロイする独立したツールです。

セットアップ

exporterをデプロイするには、以下のようにcompose設定に必要なコンテナを追加するだけです：

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

オプションでエクスポーターを設定することもできます。しかし通常は、デフォルト設定のままで問題ありません。

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

使用方法

これで、Prometheusのスクレイプ設定にエクスポーターを追加できるようになりました：

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

メトリクスのスクレイピングが開始されたら、librechat_* メトリクス（例: librechat_registered_users）を探してください。このエクスポーターは、いくつかのメトリクスを提供します。

Grafanaダッシュボードの構築を楽しんでください！