logger

package module
v0.0.0-...-701feda Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 3, 2021 License: MIT Imports: 7 Imported by: 35

README

go-logger

Loging library.

Set up

go build

Usage

	// Working directory
	wd, err := os.Getwd()
	if err != nil {
		panic(err)
	}

	tracePath := filepath.Join(wd, "output/trace.log")
	debugPath := filepath.Join(wd, "output/debug.log")
	infoPath := filepath.Join(wd, "output/info.log")
	noticePath := filepath.Join(wd, "output/notice.log")
	warnPath := filepath.Join(wd, "output/warn.log")
	errorPath := filepath.Join(wd, "output/error.log")
	fatalPath := filepath.Join(wd, "output/fatal.log")
	printPath := filepath.Join(wd, "output/print.log")

	// ロガーの作成。ディレクトリが存在しなければ、強制終了してしまいます
	log = *NewLogger(
		tracePath,
		debugPath,
		infoPath,
		noticePath,
		warnPath,
		errorPath,
		fatalPath,
		printPath)

	// 既存のログ・ファイルを削除
	log.RemoveAllOldLogs()

	// ログ・ファイルの開閉
	err = log.OpenAllLogs()
	if err != nil {
		// ログ・ファイルを開くのに失敗したのだから、ログ・ファイルへは書き込めません
		panic(err)
	}
	defer log.CloseAllLogs()

	log.Trace("Hello, world!!\n")

	// チャッターの作成。 標準出力とロガーを一緒にしたラッパーです
	chat = *NewChatter(log)
	stderrChat = *NewStderrChatter(log)

	chat.Trace("Hello, Japan!!\n")
	stderrChat.Trace("Hello, Saitama!!\n")
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Chatter

type Chatter struct {
	// contains filtered or unexported fields
}

Chatter - チャッター。 標準出力とロガーを一緒にしただけです。

func NewChatter

func NewChatter(logger Logger) *Chatter

NewChatter - チャッターを作成します。

func (Chatter) Debug

func (chatter Chatter) Debug(text string, args ...interface{})

Debug - 本番運用時にもデバッグを取りたいような内容を書くのに使います。

func (Chatter) Error

func (chatter Chatter) Error(text string, args ...interface{})

Error - 動作不良の内容や、理由を書くのに使います。

func (Chatter) Fatal

func (chatter Chatter) Fatal(text string, args ...interface{}) string

Fatal - 強制終了したことを伝えます。

func (Chatter) Info

func (chatter Chatter) Info(text string, args ...interface{})

Info - 多めの情報を書くのに使います。

func (Chatter) Notice

func (chatter Chatter) Notice(text string, args ...interface{})

Notice - 定期的に動作確認を取りたいような、節目、節目の重要なポイントの情報を書くのに使います。

func (Chatter) Print

func (chatter Chatter) Print(text string, args ...interface{})

Print - 必ず出力します。

func (Chatter) Send

func (chatter Chatter) Send(conn net.Conn, text string, args ...interface{})

Send - メッセージを送信します。

func (Chatter) Trace

func (chatter Chatter) Trace(text string, args ...interface{})

Trace - 本番運用時にはソースコードにも残っていないような内容を書くのに使います。

func (Chatter) Warn

func (chatter Chatter) Warn(text string, args ...interface{})

Warn - ハードディスクの残り容量が少ないなど、当面は無視できるが対応はしたいような情報を書くのに使います。

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

Logger - ロガー。

func NewLogger

func NewLogger(
	tracePath string,
	debugPath string,
	infoPath string,
	noticePath string,
	warnPath string,
	errorPath string,
	fatalPath string,
	printPath string) *Logger

NewLogger - ロガーを作成します。

func (*Logger) CloseAllLogs

func (logger *Logger) CloseAllLogs() error

CloseAllLogs - 全てのログ・ファイルを閉じます

func (Logger) Debug

func (logger Logger) Debug(text string, args ...interface{})

Debug - ログファイルに書き込みます。

func (Logger) Error

func (logger Logger) Error(text string, args ...interface{})

Error - ログファイルに書き込みます。

func (Logger) Fatal

func (logger Logger) Fatal(text string, args ...interface{}) string

Fatal - ログファイルに書き込みます。

func (*Logger) FlushAllLogs

func (logger *Logger) FlushAllLogs() error

FlushAllLogs - バッファーに溜まっている分をファイルに書き出します。定期的に行ってください

func (Logger) Info

func (logger Logger) Info(text string, args ...interface{})

Info - ログファイルに書き込みます。

func (Logger) Notice

func (logger Logger) Notice(text string, args ...interface{})

Notice - ログファイルに書き込みます。

func (*Logger) OpenAllLogs

func (logger *Logger) OpenAllLogs() error

OpenAllLogs - 全てのログ・ファイルを開けます

func (Logger) Print

func (logger Logger) Print(text string, args ...interface{})

Print - ログファイルに書き込みます。 Chatter から呼び出してください。

func (*Logger) RemoveAllOldLogs

func (logger *Logger) RemoveAllOldLogs()

RemoveAllOldLogs - 既存のログファイルを削除します 誤動作防止のため、 basename の末尾が '.log' か、または basename に '.log.' が含まれるものだけ削除できるものとします。

func (Logger) Trace

func (logger Logger) Trace(text string, args ...interface{})

Trace - ログファイルに書き込みます。

func (Logger) Warn

func (logger Logger) Warn(text string, args ...interface{})

Warn - ログファイルに書き込みます。

type StderrChatter

type StderrChatter struct {
	// contains filtered or unexported fields
}

StderrChatter - 標準エラー・チャッター。 標準エラー出力とロガーを一緒にしただけです。

func NewStderrChatter

func NewStderrChatter(logger Logger) *StderrChatter

NewStderrChatter - チャッターを作成します。

func (StderrChatter) Debug

func (chatter StderrChatter) Debug(text string, args ...interface{})

Debug - 本番運用時にもデバッグを取りたいような内容を書くのに使います。

func (StderrChatter) Error

func (chatter StderrChatter) Error(text string, args ...interface{})

Error - 動作不良の内容や、理由を書くのに使います。

func (StderrChatter) Fatal

func (chatter StderrChatter) Fatal(text string, args ...interface{}) string

Fatal - 強制終了したことを伝えます。

func (StderrChatter) Info

func (chatter StderrChatter) Info(text string, args ...interface{})

Info - 多めの情報を書くのに使います。

func (StderrChatter) Notice

func (chatter StderrChatter) Notice(text string, args ...interface{})

Notice - 定期的に動作確認を取りたいような、節目、節目の重要なポイントの情報を書くのに使います。

func (StderrChatter) Print

func (chatter StderrChatter) Print(text string, args ...interface{})

Print - 必ず出力します。

func (StderrChatter) Send

func (chatter StderrChatter) Send(conn net.Conn, text string, args ...interface{})

Send - メッセージを送信します。

func (StderrChatter) Trace

func (chatter StderrChatter) Trace(text string, args ...interface{})

Trace - 本番運用時にはソースコードにも残っていないような内容を書くのに使います。

func (StderrChatter) Warn

func (chatter StderrChatter) Warn(text string, args ...interface{})

Warn - ハードディスクの残り容量が少ないなど、当面は無視できるが対応はしたいような情報を書くのに使います。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL