elogger

package module

v1.0.6 Latest Latest Go to latest Published: Oct 7, 2021 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/carousell/elogger

Links

Open Source Insights

README ¶

elogger

Simple Structured logger

Currently only JSON output format

What's new

EventTag func to log with event name only. mostly for the event dashboard
Error func to log error with the event name in pointer receiver fashion
Fatal func to log and kill if err != nill. mostly for critical env missing or in case of resource connection fail

Example:

logData.ID = sessionID
logData.Account = userID
logData.RawInterface = anyInterface

elogger.Event(logData, "error", "eventName", err.Error())

logData.EventTag("AwesomeThingDone")

logData.Error("testEventLog", "test event logger")

logData.Fatal("dbConFail", "Can't connect to database")

Documentation ¶

Index ¶

Variables
func Event(thelog StructuredLog, level, event, msg string)
func LogNew(level, event, msg string)
type StructuredLog

Constants ¶

This section is empty.

Variables ¶

View Source

var ServiceName = ""

ServiceName name of service

Functions ¶

func Event ¶

func Event(thelog StructuredLog, level, event, msg string)

Event in json format

func LogNew ¶

func LogNew(level, event, msg string)

LogNew is to log with a new StructuredLog struct

Types ¶

type StructuredLog ¶

type StructuredLog struct {
	Timestamp string `json:"@timestamp,omitempty"`
	Service   string `json:"service,omitempty"`
	Thread    string `json:"thread,omitempty"`
	IP        string `json:"ip,omitempty"`
	Env       string `json:"env,omitempty"`
	Server    string `json:"server,omitempty"`
	Path      string `json:"path,omitempty"`

	Level        string      `json:"level,omitempty"`
	Event        string      `json:"event,omitempty"`
	Message      string      `json:"message,omitempty"`
	Account      string      `json:"account,omitempty"`
	ID           string      `json:"id,omitempty"`
	Raw          string      `json:"raw,omitempty"`
	RawInterface interface{} `json:"rawInterface,omitempty"`
}

StructuredLog struct for structured loggin

func (*StructuredLog) Error ¶ added in v1.0.4

func (thelog *StructuredLog) Error(event, msg string)

Error log error with event name

func (*StructuredLog) EventTag ¶ added in v1.0.5

func (thelog *StructuredLog) EventTag(event string)

EventTag log info only with event name

func (*StructuredLog) Fatal ¶ added in v1.0.4

func (thelog *StructuredLog) Fatal(event string, err error)

Fatal log error with event name and call log.Fatal()

Source Files ¶

View all Source files

logger.go

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