JL
JA
ドキュメントホーム
メニュー
ガイド

メトリクスとヘルス

health と stats エンドポイントでサービス可用性と書き込み経路状態を監視します。

guide jsonlog

メトリクスとヘルス

目的: サービス可用性を検証し、取り込みバッファの高レベル状態を確認すること。

前提条件

  • JsonLog サービスに到達できること。
  • query ストレージメトリクスには認証付き /query/stats を使うこと。

API/Script フロー

  1. 稼働確認:
    • GET /health{"status":"ok"} を返すべきです。
  2. 書き込み経路統計:
    • GET /stats はアクティブアカウントのバッファ統計を返します。
  3. アカウントストレージ統計:
    • Bearer 認証付き GET /query/stats はアップロード済みファイル集計を返します。

HTTP/curl フロー

JSONLOG_BASE_URL="http://localhost:3002"
ACCESS_TOKEN="<account_scoped_token>"

curl -sS "${JSONLOG_BASE_URL}/health"

curl -sS "${JSONLOG_BASE_URL}/stats"

curl -sS "${JSONLOG_BASE_URL}/query/stats" \
  -H "authorization: Bearer ${ACCESS_TOKEN}"

検証

  • /health は HTTP 200 とステータスペイロードを返します。
  • /stats は HTTP 200 と書き込み経路統計オブジェクトを返します。
  • /query/stats は認証なしで HTTP 401、有効認証で 200 を返します。

関連ドキュメント