logger

package module

v1.0.0 Latest Latest Go to latest Published: Jun 17, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/codefuture-io/logger

Links

Open Source Insights

README ¶

logger for OpenPitrix

Install

Install Go1.11+
set GO111MODULE=on
go get github.com/codefuture-io/logger
go run hello.go

Example

package main

import (
	"bytes"
	"context"
	"fmt"

	"github.com/codefuture-io/logger"
	"github.com/codefuture-io/logger/ctxutil"
)

func main() {
	logger.Infof(nil, "hello1 openpitrix")

	logger.HideCallstack()
	logger.Infof(nil, "hello2 openpitrix")

	logger.ShowCallstack()
	logger.Infof(nil, "hello3 openpitrix")

	{
		var buf bytes.Buffer
		logger := logger.New().SetOutput(&buf)

		logger.Infof(nil, "hello4 openpitrix")
		logger.Infof(nil, "hello5 openpitrix\nlogger")
		logger.Infof(nil, "")

		fmt.Print(buf.String())
	}

	ctx := context.Background()
	ctx = ctxutil.SetRequestId(ctx, "req-id-001")

	logger.Infof(ctx, "hello context1")

	ctx = ctxutil.SetMessageId(ctx, "msg-001", "msg-002")
	logger.Infof(ctx, "hello context2")

	ctx = ctxutil.ClearRequestId(ctx)
	logger.Infof(ctx, "hello context3")
}

output:

2018-10-20 07:43:31.70066 -INFO- hello1 openpitrix (hello.go:19)
2018-10-20 07:43:31.70085 -INFO- hello2 openpitrix
2018-10-20 07:43:31.70086 -INFO- hello3 openpitrix (hello.go:25)
2018-10-20 07:43:31.70089 -INFO- hello4 openpitrix (hello.go:31)
2018-10-20 07:43:31.70091 -INFO- hello5 openpitrix\nlogger (hello.go:32)
2018-10-20 07:43:31.70093 -INFO-  (hello.go:33)
2018-10-20 07:43:31.70096 -INFO- hello context1 (hello.go:41){@req-id-001}
2018-10-20 07:43:31.70099 -INFO- hello context2 (hello.go:44){msg-001|msg-002@req-id-001}
2018-10-20 07:43:31.70101 -INFO- hello context3 (hello.go:47){msg-001|msg-002@}

Documentation ¶

Overview ¶

Package logger provides standard logger for OpenPitrix.

Example ¶

package main

import (
	"github.com/codefuture-io/logger"
)

func main() {
	logger.Infof(nil, "hello openpitrix")
}

Output:

Example (WithContext) ¶

package main

import (
	"context"

	"github.com/codefuture-io/logger"
	"github.com/codefuture-io/logger/ctxutil"
)

func main() {
	ctx := context.Background()
	ctx = ctxutil.SetRequestId(ctx, "req-id-001")
	ctx = ctxutil.SetMessageId(ctx, "msg-001", "msg-002")

	logger.Infof(ctx, "hello openpitrix")
}

Output:

Index ¶

func Criticalf(ctx context.Context, format string, a ...interface{})
func Debugf(ctx context.Context, format string, a ...interface{})
func Errorf(ctx context.Context, format string, a ...interface{})
func HideCallstack()
func Infof(ctx context.Context, format string, a ...interface{})
func SetLevelByString(level string)
func SetOutput(output io.Writer)
func ShowCallstack()
func Warnf(ctx context.Context, format string, a ...interface{})
type Level
- func StringToLevel(level string) Level
- func (level Level) String() string
type Logger
- func New() *Logger

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Criticalf ¶

func Criticalf(ctx context.Context, format string, a ...interface{})

func Debugf ¶

func Debugf(ctx context.Context, format string, a ...interface{})

func Errorf ¶

func Errorf(ctx context.Context, format string, a ...interface{})

func HideCallstack ¶

func HideCallstack()

func Infof ¶

func Infof(ctx context.Context, format string, a ...interface{})

func SetLevelByString ¶

func SetLevelByString(level string)

func SetOutput ¶

func SetOutput(output io.Writer)

func ShowCallstack ¶

func ShowCallstack()

func Warnf ¶

func Warnf(ctx context.Context, format string, a ...interface{})

Types ¶

type Level ¶

type Level uint32

const (
	CriticalLevel Level = iota
	ErrorLevel
	WarnLevel
	InfoLevel
	DebugLevel
)

func StringToLevel ¶

func StringToLevel(level string) Level

func (Level) String ¶

func (level Level) String() string

type Logger ¶

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

func New ¶

func New() *Logger

func (*Logger) Criticalf ¶

func (p *Logger) Criticalf(ctx context.Context, format string, args ...interface{})

func (*Logger) Debugf ¶

func (p *Logger) Debugf(ctx context.Context, format string, a ...interface{})

func (*Logger) Errorf ¶

func (p *Logger) Errorf(ctx context.Context, format string, args ...interface{})

func (*Logger) HideCallstack ¶

func (p *Logger) HideCallstack() *Logger

func (*Logger) Infof ¶

func (p *Logger) Infof(ctx context.Context, format string, a ...interface{})

func (*Logger) SetLevel ¶

func (p *Logger) SetLevel(level Level)

func (*Logger) SetLevelByString ¶

func (p *Logger) SetLevelByString(level string)

func (*Logger) SetOutput ¶

func (p *Logger) SetOutput(w io.Writer) *Logger

func (*Logger) ShowCallstack ¶

func (p *Logger) ShowCallstack() *Logger

func (*Logger) Warnf ¶

func (p *Logger) Warnf(ctx context.Context, format string, a ...interface{})

func (*Logger) WithDepth ¶

func (p *Logger) WithDepth(depth int) *Logger

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
ctxutil Package ctxutil provides utilities for grpc context in OpenPitrix.	Package ctxutil provides utilities for grpc context in OpenPitrix.

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