logs

package
Version: v2.0.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Aug 22, 2019 License: Apache-2.0 Imports: 18 Imported by: 13

README

logs

logs is a Go logs manager. It can use many logs adapters. The repo is inspired by database/sql .

How to install?

go get github.com/astaxie/beego/logs

What adapters are supported?

As of now this logs support console, file,smtp and conn.

How to use it?

First you must import it

import (
	"github.com/astaxie/beego/logs"
)

Then init a Log (example with console adapter)

log := NewLogger(10000)
log.SetLogger("console", "")	

the first params stand for how many channel

Use it like this:

log.Trace("trace")
log.Info("info")
log.Warn("warning")
log.Debug("debug")
log.Critical("critical")

File adapter

Configure file adapter like this:

log := NewLogger(10000)
log.SetLogger("file", `{"filename":"test.log"}`)

Conn adapter

Configure like this:

log := NewLogger(1000)
log.SetLogger("conn", `{"net":"tcp","addr":":7020"}`)
log.Info("info")

Smtp adapter

Configure like this:

log := NewLogger(10000)
log.SetLogger("smtp", `{"username":"beegotest@gmail.com","password":"xxxxxxxx","host":"smtp.gmail.com:587","sendTos":["xiemengjun@gmail.com"]}`)
log.Critical("sendmail critical")
time.Sleep(time.Second * 30)

Documentation

Overview

Package logs provide a general log interface Usage:

import "github.com/astaxie/beego/logs"

log := NewLogger(10000)
log.SetLogger("console", "")

> the first params stand for how many channel

Use it like this:

	log.Trace("trace")
	log.Info("info")
	log.Warn("warning")
	log.Debug("debug")
	log.Critical("critical")

 more docs http://beego.me/docs/module/logs.md

Copyright 2014 mqant Author. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source
const (
	LevelEmergency = iota
	LevelAlert
	LevelCritical
	LevelError
	LevelWarning
	LevelNotice
	LevelInformational
	LevelDebug
)

RFC5424 log message levels.

View Source
const (
	AdapterConsole   = "console"
	AdapterFile      = "file"
	AdapterMultiFile = "multifile"
	AdapterMail      = "smtp"
	AdapterConn      = "conn"
	AdapterEs        = "es"
	AdapterJianLiao  = "jianliao"
	AdapterSlack     = "slack"
	AdapterDingtalk  = "dingtalk"
	AdapterAliLS     = "alils"
)

Name for adapter with beego official support

View Source
const (
	LevelInfo  = LevelInformational
	LevelTrace = LevelDebug
	LevelWarn  = LevelWarning
)

Legacy log level constants to ensure backwards compatibility.

View Source
const (
	DiscardNonColorEscSeq outputMode
	OutputNonColorEscSeq
)

DiscardNonColorEscSeq supports the divided color escape sequence. But non-color escape sequence is not output. Please use the OutputNonColorEscSeq If you want to output a non-color escape sequences such as ncurses. However, it does not support the divided color escape sequence.

Variables

This section is empty.

Functions

func Alert

func Alert(f interface{}, v ...interface{})

Alert logs a message at alert level.

func ColorByMethod

func ColorByMethod(cond bool, method string) string

ColorByMethod return color by http code GET return Blue POST return Cyan PUT return Yellow DELETE return Red PATCH return Green HEAD return Magenta OPTIONS return WHITE

func ColorByStatus

func ColorByStatus(cond bool, code int) string

ColorByStatus return color by http code 2xx return Green 3xx return White 4xx return Yellow 5xx return Red

func Critical

func Critical(f interface{}, v ...interface{})

Critical logs a message at critical level.

func Debug

func Debug(f interface{}, v ...interface{})

Debug logs a message at debug level.

func Emergency

func Emergency(f interface{}, v ...interface{})

Emergency logs a message at emergency level.

func EnableFuncCallDepth

func EnableFuncCallDepth(b bool)

EnableFuncCallDepth enable log funcCallDepth

func Error

func Error(f interface{}, v ...interface{})

Error logs a message at error level.

func GetCallStack

func GetCallStack(skip int, frames int, filter string) (CallStack, sf string)

GetCallStack returns the current call stack information as a string. The skip parameter specifies how many top frames should be skipped, while the frames parameter specifies at most how many frames should be returned.

func GetLogger

func GetLogger(prefixes ...string) *log.Logger

GetLogger returns the default BeeLogger

func Info

func Info(f interface{}, v ...interface{})

Info compatibility alias for Warning()

func Informational

func Informational(f interface{}, v ...interface{})

Informational logs a message at info level.

func NewAnsiColorWriter

func NewAnsiColorWriter(w io.Writer) io.Writer

NewAnsiColorWriter creates and initializes a new ansiColorWriter using io.Writer w as its initial contents. In the console of Windows, which change the foreground and background colors of the text by the escape sequence. In the console of other systems, which writes to w all text.

func NewModeAnsiColorWriter

func NewModeAnsiColorWriter(w io.Writer, mode outputMode) io.Writer

NewModeAnsiColorWriter create and initializes a new ansiColorWriter by specifying the outputMode.

func Notice

func Notice(f interface{}, v ...interface{})

Notice logs a message at notice level.

func Register

func Register(name string, log newLoggerFunc)

Register makes a log provide available by the provided name. If Register is called twice with the same name or if driver is nil, it panics.

func Reset

func Reset()

Reset will remove all the adapter

func SetLevel

func SetLevel(l int)

SetLevel sets the global log level used by the simple logger.

func SetLogFuncCall

func SetLogFuncCall(b bool)

SetLogFuncCall set the CallDepth, default is 4

func SetLogFuncCallDepth

func SetLogFuncCallDepth(d int)

SetLogFuncCallDepth set log funcCallDepth

func SetLogger

func SetLogger(adapter string, config ...string) error

SetLogger sets a new logger.

func Trace

func Trace(f interface{}, v ...interface{})

Trace logs a message at trace level. compatibility alias for Warning()

func W32Debug

func W32Debug(msg string)

W32Debug Helper method to output colored logs in Windows terminals

func Warn

func Warn(f interface{}, v ...interface{})

Warn compatibility alias for Warning()

func Warning

func Warning(f interface{}, v ...interface{})

Warning logs a message at warning level.

Types

type BeeLogger

type BeeLogger struct {
	ProcessID string
	// contains filtered or unexported fields
}

BeeLogger is default logger in beego application. it can contain several providers and log message into all providers.

func Async

func Async(msgLen ...int64) *BeeLogger

Async set the beelogger with Async mode and hold msglen messages

func GetBeeLogger

func GetBeeLogger() *BeeLogger

GetBeeLogger returns the default BeeLogger

func NewLogger

func NewLogger(channelLens ...int64) *BeeLogger

NewLogger returns a new BeeLogger. channelLen means the number of messages in chan(used where asynchronous is true). if the buffering chan is full, logger adapters write to file or other way.

func (*BeeLogger) Alert

func (bl *BeeLogger) Alert(span *BeegoTraceSpan, format string, v ...interface{})

Alert Log ALERT level message.

func (*BeeLogger) Async

func (bl *BeeLogger) Async(msgLen ...int64) *BeeLogger

Async set the log to asynchronous and start the goroutine

func (*BeeLogger) BiReport

func (bl *BeeLogger) BiReport(msg string)

func (*BeeLogger) Close

func (bl *BeeLogger) Close()

Close close logger, flush all chan data and destroy all adapters in BeeLogger.

func (*BeeLogger) Critical

func (bl *BeeLogger) Critical(span *BeegoTraceSpan, format string, v ...interface{})

Critical Log CRITICAL level message.

func (*BeeLogger) Debug

func (bl *BeeLogger) Debug(span *BeegoTraceSpan, format string, v ...interface{})

Debug Log DEBUG level message.

func (*BeeLogger) DelLogger

func (bl *BeeLogger) DelLogger(adapterName string) error

DelLogger remove a logger adapter in BeeLogger.

func (*BeeLogger) Emergency

func (bl *BeeLogger) Emergency(span *BeegoTraceSpan, format string, v ...interface{})

Emergency Log EMERGENCY level message.

func (*BeeLogger) EnableFuncCallDepth

func (bl *BeeLogger) EnableFuncCallDepth(b bool)

EnableFuncCallDepth enable log funcCallDepth

func (*BeeLogger) Error

func (bl *BeeLogger) Error(span *BeegoTraceSpan, format string, v ...interface{})

Error Log ERROR level message.

func (*BeeLogger) Flush

func (bl *BeeLogger) Flush()

Flush flush all chan data.

func (*BeeLogger) GetLogFuncCallDepth

func (bl *BeeLogger) GetLogFuncCallDepth() int

GetLogFuncCallDepth return log funcCallDepth for wrapper

func (*BeeLogger) Info

func (bl *BeeLogger) Info(span *BeegoTraceSpan, format string, v ...interface{})

Info Log INFO level message. compatibility alias for Informational()

func (*BeeLogger) Informational

func (bl *BeeLogger) Informational(span *BeegoTraceSpan, format string, v ...interface{})

Informational Log INFORMATIONAL level message.

func (*BeeLogger) Notice

func (bl *BeeLogger) Notice(span *BeegoTraceSpan, format string, v ...interface{})

Notice Log NOTICE level message.

func (*BeeLogger) Reset

func (bl *BeeLogger) Reset()

Reset close all outputs, and set bl.outputs to nil

func (*BeeLogger) SetContentType

func (bl *BeeLogger) SetContentType(b string)

func (*BeeLogger) SetLevel

func (bl *BeeLogger) SetLevel(l int)

SetLevel Set log message level. If message level (such as LevelDebug) is higher than logger level (such as LevelWarning), log providers will not even be sent the message.

func (*BeeLogger) SetLogFuncCallDepth

func (bl *BeeLogger) SetLogFuncCallDepth(d int)

SetLogFuncCallDepth set log funcCallDepth

func (*BeeLogger) SetLogger

func (bl *BeeLogger) SetLogger(adapterName string, configs ...string) error

SetLogger provides a given logger adapter into BeeLogger with config string. config need to be correct JSON as string: {"interval":360}.

func (*BeeLogger) Trace

func (bl *BeeLogger) Trace(span *BeegoTraceSpan, format string, v ...interface{})

Trace Log TRACE level message. compatibility alias for Debug()

func (*BeeLogger) Warn

func (bl *BeeLogger) Warn(span *BeegoTraceSpan, format string, v ...interface{})

Warn Log WARN level message. compatibility alias for Warning()

func (*BeeLogger) Warning

func (bl *BeeLogger) Warning(span *BeegoTraceSpan, format string, v ...interface{})

Warning Log WARNING level message.

func (*BeeLogger) Write

func (bl *BeeLogger) Write(p []byte) (n int, err error)

type BeegoTraceSpan

type BeegoTraceSpan struct {
	Trace string
	Span  string
}

type DingtalkWriter

type DingtalkWriter struct {
	WebhookURL string `json:"webhookurl"`
	Level      int    `json:"level"`
}

SLACKWriter implements beego LoggerInterface and is used to send jiaoliao webhook

func (*DingtalkWriter) Destroy

func (s *DingtalkWriter) Destroy()

Destroy implementing method. empty.

func (*DingtalkWriter) Flush

func (s *DingtalkWriter) Flush()

Flush implementing method. empty.

func (*DingtalkWriter) Init

func (s *DingtalkWriter) Init(jsonconfig string) error

Init SLACKWriter with json config string

func (*DingtalkWriter) WriteMsg

func (s *DingtalkWriter) WriteMsg(when time.Time, msg string, level int) error

WriteMsg write message in smtp writer. it will send an email with subject and only this message.

func (*DingtalkWriter) WriteOriginalMsg

func (s *DingtalkWriter) WriteOriginalMsg(when time.Time, msg string, level int) error

type JLWriter

type JLWriter struct {
	AuthorName  string `json:"authorname"`
	Title       string `json:"title"`
	WebhookURL  string `json:"webhookurl"`
	RedirectURL string `json:"redirecturl,omitempty"`
	ImageURL    string `json:"imageurl,omitempty"`
	Level       int    `json:"level"`
}

JLWriter implements beego LoggerInterface and is used to send jiaoliao webhook

func (*JLWriter) Destroy

func (s *JLWriter) Destroy()

Destroy implementing method. empty.

func (*JLWriter) Flush

func (s *JLWriter) Flush()

Flush implementing method. empty.

func (*JLWriter) Init

func (s *JLWriter) Init(jsonconfig string) error

Init JLWriter with json config string

func (*JLWriter) WriteMsg

func (s *JLWriter) WriteMsg(when time.Time, msg string, level int) error

WriteMsg write message in smtp writer. it will send an email with subject and only this message.

func (*JLWriter) WriteOriginalMsg

func (s *JLWriter) WriteOriginalMsg(when time.Time, msg string, level int) error

type Logger

type Logger interface {
	Init(config string) error
	WriteMsg(when time.Time, msg string, level int) error
	WriteOriginalMsg(when time.Time, msg string, level int) error
	Destroy()
	Flush()
}

Logger defines the behavior of a log provider.

func NewConn

func NewConn() Logger

NewConn create new ConnWrite returning as LoggerInterface.

func NewConsole

func NewConsole() Logger

NewConsole create ConsoleWriter returning as LoggerInterface.

func NewFileWriter

func NewFileWriter() Logger

newFileWriter create a FileLogWriter returning as LoggerInterface.

type SLACKWriter

type SLACKWriter struct {
	WebhookURL string `json:"webhookurl"`
	Level      int    `json:"level"`
}

SLACKWriter implements beego LoggerInterface and is used to send jiaoliao webhook

func (*SLACKWriter) Destroy

func (s *SLACKWriter) Destroy()

Destroy implementing method. empty.

func (*SLACKWriter) Flush

func (s *SLACKWriter) Flush()

Flush implementing method. empty.

func (*SLACKWriter) Init

func (s *SLACKWriter) Init(jsonconfig string) error

Init SLACKWriter with json config string

func (*SLACKWriter) WriteMsg

func (s *SLACKWriter) WriteMsg(when time.Time, msg string, level int) error

WriteMsg write message in smtp writer. it will send an email with subject and only this message.

func (*SLACKWriter) WriteOriginalMsg

func (s *SLACKWriter) WriteOriginalMsg(when time.Time, msg string, level int) error

type SMTPWriter

type SMTPWriter struct {
	Username           string   `json:"username"`
	Password           string   `json:"password"`
	Host               string   `json:"host"`
	Subject            string   `json:"subject"`
	FromAddress        string   `json:"fromAddress"`
	RecipientAddresses []string `json:"sendTos"`
	Level              int      `json:"level"`
}

SMTPWriter implements LoggerInterface and is used to send emails via given SMTP-server.

func (*SMTPWriter) Destroy

func (s *SMTPWriter) Destroy()

Destroy implementing method. empty.

func (*SMTPWriter) Flush

func (s *SMTPWriter) Flush()

Flush implementing method. empty.

func (*SMTPWriter) Init

func (s *SMTPWriter) Init(jsonconfig string) error

Init smtp writer with json config. config like:

{
	"username":"example@gmail.com",
	"password:"password",
	"host":"smtp.gmail.com:465",
	"subject":"email title",
	"fromAddress":"from@example.com",
	"sendTos":["email1","email2"],
	"level":LevelError
}

func (*SMTPWriter) WriteMsg

func (s *SMTPWriter) WriteMsg(when time.Time, msg string, level int) error

WriteMsg write message in smtp writer. it will send an email with subject and only this message.

func (*SMTPWriter) WriteOriginalMsg

func (s *SMTPWriter) WriteOriginalMsg(when time.Time, msg string, level int) error

Directories

Path Synopsis
Package alils implements the SDK(v0.5.0) of Simple Log Service(abbr.
Package alils implements the SDK(v0.5.0) of Simple Log Service(abbr.

Jump to

Keyboard shortcuts

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