運用ガイド
概要
Yabanin は、3 つのサービスからなるシステムです。
| サービス | 役割 | 既定ポート |
|---|---|---|
gateway | HTTP API プロキシ + 経路 | 8082 / 9090 |
admin | 管理パネル + 利用分析 API | 8086 |
loggerd | イベント取り込み → Postgres ライター | 8085 |
モジュール: github.com/reireirei/yabanin
Go バージョン: 1.25.0
ビルド: モノレポのルートから go build ./...。
サービスエンドポイント
ゲートウェイ(pkg/gateway/gateway.go)
| アドレス | 目的 |
|---|---|
:8082 | HTTP API(転送プロキシ) |
:9090 | 管理サーバー(メトリクス、トレース) |
- ヘルス:
GET http://localhost:8082/healthz— Redis の接続状態を含む JSON を返します。 - メトリクス:
GET http://localhost:9090/metrics— Prometheus の exposition 形式です。 - トレース: OTLP/HTTP エクスポータです。環境変数で設定します(下記を参照)。
Admin サービス(services/admin/cmd/main.go)
| アドレス | 目的 |
|---|---|
:8086 | HTTP API(管理 + 利用分析) |
- ルート:
/auth/*、/api/analytics/* - ヘルス:
GET http://localhost:8086/health— 200 で"ok"を返します。 - メトリクス:
GET http://localhost:8086/metrics— Prometheus の exposition 形式です。 - ポートの上書き: 設定キー
listen_addrで設定します。
Loggerd サービス(services/loggerd/cmd/main.go)
| アドレス | 目的 |
|---|---|
:8085 | HTTP API(イベント取り込み) |
- ヘルス:
GET http://localhost:8085/healthz— 200 OK を返します。 - トレース: OTLP/HTTP エクスポータです。環境変数で設定します(下記を参照)。
ヘルスチェック
| サービス | エンドポイント | 応答 | 確認する依存関係 |
|---|---|---|---|
| ゲートウェイ | GET /healthz | JSON: {"status":"ok","redis":{"status":"up"}} または "down" | Redis の接続 |
| Admin | GET /health | プレーンテキスト: ok | なし |
| Loggerd | GET /healthz | HTTP 200 OK | なし |
ゲートウェイのヘルス詳細
ゲートウェイのヘルスエンドポイントは、Redis へ PING を実行します。応答には次が含まれます。
{
"status": "ok",
"redis": {
"status": "up"
}
}
Redis に到達できない場合、redis.status フィールドは "down" になり、全体のステータスは劣化した状態を反映します。これは、Kubernetes の liveness/readiness プローブや、ロードバランサのヘルスチェックに有用です。
メトリクス
すべてのメトリクスは、Prometheus client-go(github.com/prometheus/client_golang/prometheus)を介して、サブシステム gateway の下に登録されます。各サービスの /metrics エンドポイントで、標準の Prometheus exposition 形式として公開されます。
リクエストメトリクス(ゲートウェイ)
| メトリクス | 型 | ラベル | 説明 |
|---|---|---|---|
gateway_requests_total | カウンタ | method、path、status | 処理した HTTP リクエストの合計 |
gateway_request_duration_seconds | ヒストグラム | method |