log-design

Log Design Check - ログ設計チェック

プロジェクトのログ設計が一般的な基準と法的要件を満たしているか体系的にチェックし、不足があれば実装パターンを提示する。

参照: セキュリティ関連のログルールは documents/development/coding-rules/common-rules.md Section 4 も併せて確認すること。

実行フロー

Step 1: 現状分析（既存のログ設定・出力を確認）
  ↓
Step 2: 一般的ログ基準チェック
  ↓
Step 3: 法的要件チェック
  ↓
Step 4: 不足箇所の実装パターン提示
  ↓
Step 5: レポート出力

---

Step 1: 現状分析

以下を確認する：

• ログライブラリ・設定ファイル（logback-spring.xml、pino設定等）
• 既存のログ出力箇所
• 取り扱うデータの種類（取引データ、個人情報、メール送信等）

---

Step 2: 一般的ログ基準チェック

ログレベル基準

レベル	用途	例
ERROR	システム異常、復旧不可能なエラー	DB接続失敗、外部API障害、未処理例外
WARN	想定内だが注意が必要な事象	リトライ発生、閾値超過、非推奨API使用
INFO	ビジネス上重要なイベント	ユーザーログイン/ログアウト、決済完了、重要な状態遷移
DEBUG	開発・調査用の詳細情報	リクエスト/レスポンス詳細、SQL実行詳細（本番では無効化）

構造化ログ実装パターン

Spring Boot + Logback (JSON形式):

// logback-spring.xml で net.logstash.logback.encoder.LogstashEncoder を使用
// または logback-spring.xml で JSON パターンを定義

// 出力例:
// {
//   "timestamp": "2025-01-08T10:00:00.000+09:00",
//   "level": "INFO",
//   "logger": "com.example.service.PaymentService",
//   "message": "Payment completed",
//   "traceId": "abc123",
//   "userId": "user-001",
//   "action": "PAYMENT_COMPLETE",
//   "amount": 10000,
//   "paymentId": "pay-001"
// }

@Slf4j
@Service
public class PaymentService {
    public void completePayment(Payment payment) {
        // MDC にトレース情報をセット
        MDC.put("action", "PAYMENT_COMPLETE");
        MDC.put("paymentId", payment.getId().toString());
        log.info("Payment completed: amount={}", payment.getAmount());
        MDC.clear();
    }
}

Next.js (API Routes / Server Actions):

// lib/logger.ts - 構造化ログユーティリティ
import pino from 'pino';

export const logger = pino({
  level: process.env.LOG_LEVEL || 'info',
  formatters: {
    level: (label) => ({ level: label }),
  },
  timestamp: pino.stdTimeFunctions.isoTime,
});

// 使用例: API Route
export async function POST(request: Request) {
  const body = await request.json();
  logger.info(
    { action: 'ORDER_CREATED', orderId: body.id, userId: session.userId },
    'Order created'
  );
}