Go言語のロガー、TDDで爆速化！安全にパフォーマンスを改善した話

// 改善前: pkg/logger/structured_logger.go

// LogEntryはログの情報をまとめた構造体です
type LogEntry struct { ... }

// outputメソッドがログを実際に出力します
func (l *Logger) output(entry *LogEntry) {
    // 1. まず、ログ情報をJSONのバイト配列に変換します
    jsonBytes, err := json.Marshal(entry)
    if err != nil {
        log.Printf("JSON変換エラー: %v", err)
        return
    }
    // 2. 次に、そのバイト配列を「文字列」に変換して、画面に出力します
    fmt.Println(string(jsonBytes))
}

// 改善前: 複雑な出力キャプチャ
func captureOutput(fn func()) string {
    // os.Pipeを使って、画面出力をパイプに繋ぎ変える…
    r, w, _ := os.Pipe()
    originalStdout := os.Stdout
    os.Stdout = w
    // ...この後もgoroutineを使った複雑な処理が続く...
}

// TDD Red Phase: TestNewWithWriter
// 新しいコンストラクタのテスト
func TestNewWithWriter(t *testing.T) {
    // strings.Builderは、テストでよく使われる「書き込み可能なバッファ」です
    var buf strings.Builder
    // 理想の新しい関数 `NewWithWriter` を呼び出す（まだ存在しない！）
    logger := NewWithWriter("test-service", &buf)

    // 正しく設定されたかチェック
    if logger.writer != &buf {
        t.Error("期待: 出力先が正しく設定されていません")
    }
}

// TDD Red Phase: TestOutputToCustomWriter
// カスタムライターへの出力テスト
func TestOutputToCustomWriter(t *testing.T) {
    var buf strings.Builder
    logger := NewWithWriter("test-service", &buf)

    logger.Info("テストメッセージ") // 何かログを出力してみる

    // バッファに何か書き込まれたはず！
    if buf.String() == "" {
        t.Error("期待: カスタムライターに出力されていません")
    }
}

$ go test -v ./pkg/logger
# ...
pkg/logger/structured_logger_test.go:396:12: undefined: NewWithWriter
FAIL    poc-cognite/pkg/logger [build failed]

import "io" // io.Writerを使うためにインポート

// Logger構造体に、書き込み先を保持する`writer`フィールドを追加
type Logger struct {
    service string
    context context.Context
    writer  io.Writer  // 👈 ココ！
}

// NewWithWriter は、出力先を指定できる新しいコンストラクタ
func NewWithWriter(service string, writer io.Writer) *Logger {
    return &Logger{
        service: service,
        context: context.Background(),
        writer:  writer, // 受け取ったwriterを設定
    }
}

// 既存のNew関数も、デフォルトで画面に出力するように修正
func New(service string) *Logger {
    // 内部で新しい関数を呼び出す形にする
    return NewWithWriter(service, os.Stdout)
}

// 改善後: json.NewEncoderで直接ストリームに出力！
func (l *Logger) output(entry *LogEntry) {
    // 1. Loggerが持つwriterを使って、JSONエンコーダーを作成
    encoder := json.NewEncoder(l.writer)
    // 2. エンコーダーに直接データを渡して、JSONに変換しつつ出力！
    if err := encoder.Encode(entry); err != nil {
        // もしエンコードに失敗したら、標準エラー出力にログを残す
        log.Printf("ログエンコードエラー: %v, 元データ: %+v", err, entry)
    }
}

$ go test -v ./pkg/logger
=== RUN   TestNewWithWriter
--- PASS: TestNewWithWriter (0.00s)
=== RUN   TestOutputToCustomWriter
--- PASS: TestOutputToCustomWriter (0.00s)
PASS
ok      poc-cognite/pkg/logger  0.002s

// 改善前: 複雑なos.Pipe()ベース
func captureOutput(fn func()) string {
    // ... 複雑な処理 ...
}

// 改善後: シンプルなbytes.Bufferベース
func createTestLogger() (*Logger, *bytes.Buffer) {
    // bytes.Bufferもio.Writerインターフェースを満たしているので、出力先に指定できる
    var buf bytes.Buffer
    logger := NewWithWriter("test-service", &buf)
    return logger, &buf
}

// 改善前
func TestDebugLog(t *testing.T) {
    logger := New("test-service")
    // 複雑なヘルパーで出力をキャプチャ
    output := captureOutput(func() {
        logger.Debug("デバッグメッセージ")
    })
    // ...
}

// 改善後
func TestDebugLog(t *testing.T) {
    // シンプルなヘルパーでロガーとバッファを取得
    logger, buf := createTestLogger()
    logger.Debug("デバッグメッセージ")
    // バッファから直接結果を取得
    output := buf.String()
    // ...
}

$ go test -v ./pkg/logger
# ... 全18テストケース ...
PASS
ok      poc-cognite/pkg/logger  0.002s

// ファイルにログを出力する
file, _ := os.Create("app.log")
logger := NewWithWriter("app", file)

// ネットワーク経由でログサーバーに送る
conn, _ := net.Dial("tcp", "log-server:514")
logger := NewWithWriter("app", conn)

// テストで使うメモリ上のバッファ
var buf bytes.Buffer
logger := NewWithWriter("test", &buf)