Go言語の標準logパッケージ：初心者から上級者への詳細な使い方について紹介

はじめに
基本的な使い方
エラーログ出力
カスタマイゼーション
ログレベルの実装
まとめ

はじめに

Go言語の標準ライブラリの中にあるlogパッケージは、基本的なログ出力機能を提供します。しかし、このパッケージの力はそのシンプルさの中にあり、その機能を適切に利用すれば、高度なロギングを実現することも可能です。この記事では、Go言語のlogパッケージの基本的な使い方からカスタマイズ方法までを詳しく解説します。

Go log package

log package - log - Go Packages

Package log implements a simple logging package.

基本的な使い方

logパッケージは非常にシンプルなAPIを提供しています。最も基本的な使い方は、次のコードで示されています。

package main

import (
	"log"
)

func main() {
	log.Println("Hello, World!")
}

このコードを実行すると、次のような出力が得られます。

2009/11/10 23:00:00 Hello, World!

ログ出力には日付と時間が自動的にプレフィックスとして追加されます。このプレフィックスはカスタマイズ可能で、後ほどその方法を説明します。

エラーログ出力

エラーログを出力する場合、logパッケージのFatallnやPanicln関数を使用することができます。これらの関数はメッセージをログに出力した後、さらに追加のアクションを行います。Fatallnはプログラムを終了させ、Paniclnはパニックを引き起こします。

package main

import (
	"log"
)

func main() {
	log.Fatalln("Fatal error!")
}

このコードを実行すると、次のような出力が得られ、プログラムは終了します。

2009/11/10 23:00:00 Fatal error! 
exit status 1

カスタマイゼーション

デフォルト設定だけでも強力ですが、さらにカスタマイズすることで、より詳細な制御が可能になります。ログのプレフィックスや出力先、出力形式など、様々な設定を変更することができます。

例えば、ログのプレフィックスを変更するにはSetPrefix関数を使用します。また、ログの出力先を変更するにはSetOutput関数を利用します。

package main

import (
	"log"
	"os"
)

func main() {
	// ファイルを作成
	file, err := os.Create("logfile.log")
	if err != nil {
		log.Fatalln("Failed to create log file:", err)
	}
	
	// logの出力先をファイルに設定
	log.SetOutput(file)
	
	// ログのプレフィックスを設定
	log.SetPrefix("LOG: ")
	
	log.Println("Hello, World!")
}

このコードを実行すると、ログメッセージはlogfile.logに書き込まれ、各行の先頭には”LOG: “が追加されます。

ログレベルの実装

標準ライブラリのlogパッケージにはログレベルの概念がありませんが、自分自身でこれを実装することは比較的簡単です。例えば、以下のように各ログレベルに対応する関数を作成することができます。

package main

import (
	"log"
	"os"
)

var (
	Info  *log.Logger
	Error *log.Logger
)

func Init() {
	Info = log.New(os.Stdout, "INFO: ", log.Ldate|log.Ltime|log.Lshortfile)
	Error = log.New(os.Stderr, "ERROR: ", log.Ldate|log.Ltime|log.Lshortfile)
}

func main() {
	Init()
	
	Info.Println("This is some info.")
	Error.Println("This is an error.")
}

このコードは2つのロガーを作成します。一つは”INFO”レベルのメッセージ用で、もう一つは”ERROR”レベルのメッセージ用です。これらのロガーはそれぞれ異なるプレフィックスと出力先を持ちます。