prettylogs

README

Go Prettylogs

Golang structured logging library

Usage

Get the go-prettylogs library

$ go get github.com/ashokhirpara1/golang-prettylogs

package main

import (
    prettylogs "github.com/ashokhirpara1/golang-prettylogs"
)

func main() {
    prettylogs.Info("main function to boot up everything")
}

Expected output

{"level":"info","method":"main","msg":"main function to boot up everything","time":"2022-09-23T22:59:01+05:30"}

Measure function's execution time in logs

func functionName() {
    defer prettylogs.Exit(prettylogs.Enter())
}

Documentation

Overview

Package prettylogs uses concept of structured logging and the methods to default add structure to log entry payload fields.

The prettylogs package can be used to log entries that use the jsonPayload field to add structure to their payloads. By default it logs "level", "method", "msg", "time" json fields.

Index

• func Enter() (time.Time, string)
• func Error(msg string, errr error)
• func Exit(start time.Time, name string)
• func Fatal(method string, msg string, errr error)
• func Info(str string)

Functions

func Enter

func Enter() (time.Time, string)

Enter logs the start time of the method

func Error

func Error(msg string, errr error)

Error accepts the string message and error It logs the error level message with method name and timestamp

func Exit

func Exit(start time.Time, name string)

Exit mesures the execution time of the method

func Fatal

func Fatal(method string, msg string, errr error)

Fatal accepts the method name, string message and error It logs the message and exits the program

func Info

func Info(str string)

Info accepts the string message It logs the info level message with method name and timestamp