inslogger

package
v0.10.1 Latest Latest
Warning

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

Go to latest
Published: May 29, 2024 License: Apache-2.0 Imports: 2 Imported by: 1

README

Inslogger

Inslogger is a logging package designed to provide flexible and comprehensive logging capabilities in Go applications.

Features

  • Multi-Level Logging: Supports logging at various levels including Debug, Info, Warn, Error, and Fatal.
  • Error Handling: Provides methods to log errors with different formatting options.

Installation

go get github.com/yourusername/inslogger

Usage

import "github.com/yourusername/inslogger"

// Initialize a logger
logger := inslogger.NewLogger(inslogger.Debug)

// Log an error
err := someFunction()
if err != nil {
    logger.Error(err)
}

// Log a message
logger.Log("This is a log message")

// Set log level
logger.SetLevel(inslogger.Info)

Interface

The package provides an Interface that exposes various logging methods:

type Interface interface {
    LogMultiple(errs []error)
    Log(i interface{})
    Logf(format string, args ...interface{})
    Warn(i interface{})
    Warnf(format string, args ...interface{})
    Error(err error)
    Errorf(format string, args ...interface{})
    Debug(i interface{})
    Debugf(format string, args ...interface{})
    Fatal(err error)
    Fatalf(format string, args ...interface{})
    initLogger() error
    SetLevel(level LogLevel)
}

Configuration

The inslogger package offers configuration options to customize logging behavior.

Log Levels

The package supports the following log levels:

  • DEBUG
  • INFO
  • WARN
  • ERROR
  • FATAL

Setting Log Level

The default log level is INFO. To set a different log level:

logger := inslogger.NewLogger(inslogger.Debug)

Example

// Initialize a logger with Debug level
logger := inslogger.NewLogger(inslogger.Debug)

// Log an error
err := someFunction()
if err != nil {
    logger.Error(err)
}

// Log a debug message
logger.Debugf("Debug message with arguments: %s", arg)

// Change log level to Info
logger.SetLevel(inslogger.Info)

// Log an informational message
logger.Infof("Informational message")

Contribution

Feel free to contribute by forking this repository and creating pull requests. Please ensure to adhere to the existing code style and conventions.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppLogger

type AppLogger struct {
	Logger *zap.Logger
	Sugar  *zap.SugaredLogger

	Level LogLevel
}

func (*AppLogger) Debug

func (al *AppLogger) Debug(i interface{})

func (*AppLogger) Debugf

func (al *AppLogger) Debugf(format string, args ...interface{})

func (*AppLogger) Error

func (al *AppLogger) Error(err error)

func (*AppLogger) Errorf

func (al *AppLogger) Errorf(format string, args ...interface{})

func (*AppLogger) Fatal

func (al *AppLogger) Fatal(err error)

func (*AppLogger) Fatalf

func (al *AppLogger) Fatalf(format string, args ...interface{})

func (*AppLogger) Log

func (al *AppLogger) Log(i interface{})

func (*AppLogger) LogMultiple

func (al *AppLogger) LogMultiple(errs []error)

func (*AppLogger) Logf

func (al *AppLogger) Logf(format string, args ...interface{})

func (*AppLogger) SetLevel

func (al *AppLogger) SetLevel(level LogLevel)

func (*AppLogger) Warn

func (al *AppLogger) Warn(i interface{})

func (*AppLogger) Warnf

func (al *AppLogger) Warnf(format string, args ...interface{})

type Interface

type Interface interface {
	LogMultiple(errs []error)
	Log(i interface{})
	Logf(format string, args ...interface{})
	Warn(i interface{})
	Warnf(format string, args ...interface{})
	Error(err error)
	Errorf(format string, args ...interface{})
	Debug(i interface{})
	Debugf(format string, args ...interface{})
	Fatal(err error)
	Fatalf(format string, args ...interface{})

	SetLevel(level LogLevel)
	// contains filtered or unexported methods
}

func NewLogger

func NewLogger(level LogLevel) Interface

func NewNopLogger

func NewNopLogger() Interface

type LogLevel

type LogLevel string
const (
	Debug LogLevel = "DEBUG"
	Info  LogLevel = "INFO"
	Warn  LogLevel = "WARN"
	Error LogLevel = "ERROR"
	Fatal LogLevel = "FATAL"
)

Jump to

Keyboard shortcuts

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