Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/hunterhug/golog

💐 Log The World Very Easy With Zap
https://github.com/hunterhug/golog
golanglog golog logger zap zap-log
Last synced: about 2 months ago
JSON representation
💐 Log The World Very Easy With Zap
Host: GitHub
URL: https://github.com/hunterhug/golog
Owner: hunterhug
License: apache-2.0
Created: 2021-08-27T03:38:25.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2021-09-29T03:09:41.000Z (almost 3 years ago)
Last Synced: 2024-06-20T22:44:22.280Z (3 months ago)
Topics: golanglog, golog, logger, zap, zap-log
Language: Go
Homepage:
Size: 23.4 KB
Stars: 9
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # Log the world very easy

[![GitHub forks](https://img.shields.io/github/forks/hunterhug/golog.svg?style=social&label=Forks)](https://github.com/hunterhug/golog/network)

[![GitHub stars](https://img.shields.io/github/stars/hunterhug/golog.svg?style=social&label=Stars)](https://github.com/hunterhug/golog/stargazers)

[![GitHub last commit](https://img.shields.io/github/last-commit/hunterhug/golog.svg)](https://github.com/hunterhug/golog)

[![GitHub issues](https://img.shields.io/github/issues/hunterhug/golog.svg)](https://github.com/hunterhug/golog/issues)

[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

Thanks To Uber ZapLog! Log to console or file very easy and fast!

[中文说明](README_ZH.md)

## How to use

Simple：

```

go get -v github.com/hunterhug/golog

```

## Demo

default logger is InfoLevel, and has long func caller.

### Demo1

```go

package main

import . "github.com/hunterhug/golog"

func main() {

	// use default log

	Info("now is Info", 2, " good")

	Debug("now is Debug", 2, " good")

	Warn("now is Warn", 2, " good")

	Error("now is Error", 2, " good")

	Infof("now is Infof: %d,%s", 2, "good")

	Debugf("now is Debugf: %d,%s", 2, "good")

	Warnf("now is Warnf: %d,%s", 2, "good")

	Errorf("now is Errorf: %d,%s", 2, "good")

	Sync()

	// config log

	SetLevel(DebugLevel).SetCallerShort(true).SetOutputJson(true).InitLogger()

	Info("now is Info", 2, " good")

	Debug("now is Debug", 2, " good")

	Warn("now is Warn", 2, " good")

	Error("now is Error", 2, " good")

	Infof("now is Infof: %d,%s", 2, "good")

	Debugf("now is Debugf: %d,%s", 2, "good")

	Warnf("now is Warnf: %d,%s", 2, "good")

	Errorf("now is Errorf: %d,%s", 2, "good")

	Sync()

}

```

Output:

```

2021-08-27T11:16:10.455+0800    INFO    /Users/pika/Documents/code/github/golog/demo/demo1/main.go:7    main.main       now is Info2 good

2021-08-27T11:16:10.455+0800    WARN    /Users/pika/Documents/code/github/golog/demo/demo1/main.go:9    main.main       now is Warn2 good

2021-08-27T11:16:10.455+0800    ERROR   /Users/pika/Documents/code/github/golog/demo/demo1/main.go:10   main.main       now is Error2 good

2021-08-27T11:16:10.455+0800    INFO    /Users/pika/Documents/code/github/golog/demo/demo1/main.go:11   main.main       now is Infof: 2,good

2021-08-27T11:16:10.455+0800    WARN    /Users/pika/Documents/code/github/golog/demo/demo1/main.go:13   main.main       now is Warnf: 2,good

2021-08-27T11:16:10.455+0800    ERROR   /Users/pika/Documents/code/github/golog/demo/demo1/main.go:14   main.main       now is Errorf: 2,good

{"l":"info","t":"2021-08-27T11:16:10.455+0800","caller":"demo1/main.go:19","func":"main.main","msg":"now is Info2 good"}

{"l":"debug","t":"2021-08-27T11:16:10.455+0800","caller":"demo1/main.go:20","func":"main.main","msg":"now is Debug2 good"}

{"l":"warn","t":"2021-08-27T11:16:10.455+0800","caller":"demo1/main.go:21","func":"main.main","msg":"now is Warn2 good"}

{"l":"error","t":"2021-08-27T11:16:10.455+0800","caller":"demo1/main.go:22","func":"main.main","msg":"now is Error2 good"}

{"l":"info","t":"2021-08-27T11:16:10.455+0800","caller":"demo1/main.go:23","func":"main.main","msg":"now is Infof: 2,good"}

{"l":"debug","t":"2021-08-27T11:16:10.455+0800","caller":"demo1/main.go:24","func":"main.main","msg":"now is Debugf: 2,good"}

{"l":"warn","t":"2021-08-27T11:16:10.455+0800","caller":"demo1/main.go:25","func":"main.main","msg":"now is Warnf: 2,good"}

{"l":"error","t":"2021-08-27T11:16:10.455+0800","caller":"demo1/main.go:26","func":"main.main","msg":"now is Errorf: 2,good"}

```

### Demo2

you can config log to file and auto rotate.

```go

package main

import (

	"context"

	"fmt"

	. "github.com/hunterhug/golog"

	"time"

)

func main() {

	SetName("log_demo")

	SetLevel(InfoLevel)

	SetCallerShort(true).SetOutputJson(true)

	AddFieldFunc(func(ctx context.Context, m map[string]interface{}) {

		m["diy_filed"] = ctx.Value("diy")

	})

	SetOutputFile("./log", "demo").SetFileRotate(30*24*time.Hour, 24*time.Hour)

	SetIsOutputStdout(true)

	InitLogger()

	Info("now is Info", 2, " good")

	Debug("now is Debug", 2, " good")

	Warn("now is Warn", 2, " good")

	Error("now is Error", 2, " good")

	Infof("now is Infof: %d,%s", 2, "good")

	Debugf("now is Debugf: %d,%s", 2, "good")

	Warnf("now is Warnf: %d,%s", 2, "good")

	Errorf("now is Errorf: %d,%s", 2, "good")

	ctx := context.WithValue(context.Background(), "diy", []interface{}{"ahhahahahahh"})

	InfoContext(ctx, "InfoContext")

	InfoContext(ctx, "InfoContext, %s:InfoContext, %d", "ss", 333)

	InfoWithFields(map[string]interface{}{"k1": "sss"}, "InfoWithFields:%s，%d", "sss", 33333)

	InfoWithFields(map[string]interface{}{"k1": "sss"}, "InfoWithFields")

	err := Sync()

	if err != nil {

		fmt.Println(err.Error())

	}

}

```

Output is in the file dir `·/log`, due to `SetIsOutputStdout` is true it also output to console.

## Usage

very easy to understand.

```go

type LoggerInterface interface {

	SetOutputFile(logPath, fileName string)

	SetFileRotate(fileMaxAge, fileRotation time.Duration)

	SetLevel(level Level)

	SetCallerShort(short bool)

	SetName(name string)

	SetIsOutputStdout(isOutputStdout bool)

	SetCallerSkip(skip int)

	SetOutputJson(json bool)

	GetOutputFile() (logPath, fileName string)

	GetFileRotate() (fileMaxAge, fileRotation time.Duration)

	GetLevel() (level Level)

	GetCallerShort() (short bool)

	GetName() (name string)

	GetIsOutputStdout() (isOutputStdout bool)

	GetCallerSkip() (skip int)

	GetOutputJson() bool

	InitLogger()

	Sync() error

	Panicf(template string, args ...interface{})

	Fatalf(template string, args ...interface{})

	Errorf(template string, args ...interface{})

	Warnf(template string, args ...interface{})

	Infof(template string, args ...interface{})

	Debugf(template string, args ...interface{})

	Panic(args ...interface{})

	Fatal(args ...interface{})

	Error(args ...interface{})

	Warn(args ...interface{})

	Info(args ...interface{})

	Debug(args ...interface{})

	PanicWithFields(fields map[string]interface{}, template string, args ...interface{})

	FatalWithFields(fields map[string]interface{}, template string, args ...interface{})

	ErrorWithFields(fields map[string]interface{}, template string, args ...interface{})

	WarnWithFields(fields map[string]interface{}, template string, args ...interface{})

	InfoWithFields(fields map[string]interface{}, template string, args ...interface{})

	DebugWithFields(fields map[string]interface{}, template string, args ...interface{})

	PanicContext(ctx context.Context, template string, args ...interface{})

	FatalContext(ctx context.Context, template string, args ...interface{})

	ErrorContext(ctx context.Context, template string, args ...interface{})

	WarnContext(ctx context.Context, template string, args ...interface{})

	InfoContext(ctx context.Context, template string, args ...interface{})

	DebugContext(ctx context.Context, template string, args ...interface{})

	PanicContextWithFields(ctx context.Context, fields map[string]interface{}, template string, args ...interface{})

	FatalContextWithFields(ctx context.Context, fields map[string]interface{}, template string, args ...interface{})

	ErrorContextWithFields(ctx context.Context, fields map[string]interface{}, template string, args ...interface{})

	WarnContextWithFields(ctx context.Context, fields map[string]interface{}, template string, args ...interface{})

	InfoContextWithFields(ctx context.Context, fields map[string]interface{}, template string, args ...interface{})

	DebugContextWithFields(ctx context.Context, fields map[string]interface{}, template string, args ...interface{})

	AddFieldFunc(func(context.Context, map[string]interface{}))

}

```

# License

```

Copyright [2021-2021] [github.com/hunterhug]

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

```