pandamy619 / jlog

Simple logger for golang

jlog

Installation

go get github.com/pandamy619/jlog

Usage

func Init

func Init(pkg string, location string, consoleLog string) *Jlogs

Create new Logger.

• pkg: Name package.
• location: Folder where logs will be saved.
• consoleLog: Method output to console, simple or json.

example

package main

import (
	"jlog"
)

func main() {
    jlog.Init("SomePackage", "tmp", "simple")
}

func (*Jlogs) Main

func (l *Jlogs) Main(name string) *Jlogs

Usually called at the beginning of a function.

• name: Function name.

example

package main

import (
	"jlog"
)

func main() {
    j := jlog.Init("SomePackage", "tmp", "simple")
    j.Main("main")
}

func (*Jlogs) Sub

func (l *Jlogs) Sub(status string, message string, time string) *Jlogs

• status: Status log (info/warning/error/customStatus).
• message: Message containing information about the log.
• time: Date and time.

package main

import (
	"jlog"
)

func main() {
    j := jlog.Init("SomePackage", "tmp", "simple")
    jMain := j.Main("main")
    jMain.Sub(
        "info",
        "message fun1",
        time.Now().Format("2006-01-02T15:04:05"),
    ).Info("Info message")
}

func (*Jlogs) SubWithFields

func (l *Jlogs) SubWithFields(status string, message string, time string, field Fields) *Jlogs

• status: Status log (info/warning/error/customStatus).
• message: Message containing information about the log.
• time: Date and time.
• fields: Fields.

example

package main

import (
	"jlog"
)

func main() {
    j := jlog.Init("SomePackage", "tmp", "simple")
    jMain := j.Main("main")
    lMain.SubWithFields(
        "warning",
        "message subfun1",
        time.Now().Format("2006-01-02T15:04:05"),
        jlog.Fields{
            "fun": "subfun1",
    }).Warning("Warning message")
}

Status

Info/Warning/Error

func (l *Jlogs) Info(message string)

func (l *Jlogs) Warning(message string)

func (l *Jlogs) Error(message string)

Console log

simple log

[INFO] package:some_package func:fun1 detail:Info message
[WARN] package:some_package func:fun1 detail:warning message
[ERROR] package:some_package func:fun1 detail:error message

json log

-------------------------
[INFO] Info message
package:some_package
func:fun1
{
    "message": "message fun1",
    "status": "info",
    "time": "2020-06-17T11:21:59"
}
-------------------------
-------------------------
[WARN] warning message
package:some_package
func:fun1
{
    "message": "message fun1",
    "status": "warning",
    "time": "2020-06-17T11:21:59"
}
-------------------------
-------------------------
[ERROR] error message
package:some_package
func:fun1
{
    "message": "message fun1",
    "status": "error",
    "time": "2020-06-17T11:21:59"
}
-------------------------

File output

format file YYYY-MM-DDTHH:MM:SS.json

{
    "package": "Logging",
    "functions": {
        "fun1": [
            {
                "message": "message fun1",
                "status": "info",
                "time": "2020-06-18T09:06:03"
            },
            {
                "message": "message fun1",
                "status": "warning",
                "time": "2020-06-18T09:06:03"
            },
            {
                "message": "message subfun1",
                "meta": {
                    "fun": "subfun1"
                },
                "status": "warning",
                "time": "2020-06-18T09:06:03"
            }
        ],
        "fun2": [
            {
                "message": "message fun2",
                "status": "info",
                "time": "2020-06-18T09:06:03"
            }
        ],
        "fun3": [
            {
                "message": "message fun3",
                "status": "other",
                "time": "2020-06-18T09:06:03"
            }
        ]
    }
}