logging

package

v0.1.8 Latest Latest Go to latest Published: Sep 8, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Details

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

Repository

github.com/colibriproject-dev/colibri-sdk-go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Initialize()
func InjectCorrelationIDInContext(ctx context.Context, id string) context.Context
type Logging

Constants ¶

View Source

const (
	CorrelationIDParam string = "correlationId"
)

Variables ¶

This section is empty.

Functions ¶

func Initialize ¶

func Initialize()

Initialize initializes the logging.

func InjectCorrelationIDInContext ¶

func InjectCorrelationIDInContext(ctx context.Context, id string) context.Context

InjectCorrelationIDInContext injects the correlation ID into the provided context, that allow to log with this ID making easy to identify all logs related to the same execution.

Types ¶

type Logging ¶

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

Logging is a struct that contains the parameters for the logging.

func Debug ¶

func Debug(ctx context.Context) *Logging

Debug returns a new Logging instance configured for DEBUG level log.

func Error ¶

func Error(ctx context.Context) *Logging

Error returns a new Logging instance configured for ERROR level log.

func Fatal ¶

func Fatal(ctx context.Context) *Logging

Fatal returns a new Logging instance configured for ERROR level log. After the log is printed, a panic is thrown.

func Info ¶

func Info(ctx context.Context) *Logging

Info returns a new Logging instance configured for INFO level log.

func Warn ¶

func Warn(ctx context.Context) *Logging

Warn returns a new Logging instance configured for WARN level log.

func (*Logging) AddParam ¶

func (l *Logging) AddParam(key string, val any) *Logging

AddParam adds a key-value pair to the logging parameters. Example:

logging.Info(ctx).AddParam("userID", 123).Msg("User logged in")

func (*Logging) Err ¶

func (l *Logging) Err(err error) *Logging

Err sets the error field in the Logging instance. When an error is added, the log will include a specific field for the error. error. Example:

err := errors.New("database connection failed")

logging.Error(ctx).Err(err).Msg("Database error")

func (*Logging) Msg ¶

func (l *Logging) Msg(msg string)

Msg logs a message with the appropriate log level and parameters. Example:

logging.Info(ctx).AddParam("userID", 123).Msg("User logged in")

func (*Logging) Msgf ¶

func (l *Logging) Msgf(msg string, args ...any)

Msgf logs a formatted message with the appropriate log level. Example:

logging.Info(ctx).Msgf("User %s logged in at %s", "John", time.Now().Format(time.RFC3339))

Source Files ¶

View all Source files

logging.go

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