https://github.com/tmc/log
Package log wraps logrus to include source line/function information
https://github.com/tmc/log
Last synced: about 1 year ago
JSON representation
Package log wraps logrus to include source line/function information
- Host: GitHub
- URL: https://github.com/tmc/log
- Owner: tmc
- License: mit
- Created: 2016-09-03T22:12:11.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-06-16T09:01:33.000Z (about 8 years ago)
- Last Synced: 2025-06-25T13:03:04.751Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 5.86 KB
- Stars: 10
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# log
`import "github.com/tmc/log"`
* [Overview](#pkg-overview)
* [Index](#pkg-index)
## Overview
Package log wraps logrus to include source line/function information
inspired by prometheus/common/log
## Index
* [func Debug(args ...interface{})](#Debug)
* [func Debugln(args ...interface{})](#Debugln)
* [func Error(args ...interface{})](#Error)
* [func Errorln(args ...interface{})](#Errorln)
* [func Fatal(args ...interface{})](#Fatal)
* [func Fatalln(args ...interface{})](#Fatalln)
* [func Info(args ...interface{})](#Info)
* [func Infoln(args ...interface{})](#Infoln)
* [func SetLevel(level Level)](#SetLevel)
* [func Warn(args ...interface{})](#Warn)
* [func Warnln(args ...interface{})](#Warnln)
* [type Level](#Level)
* [type Logger](#Logger)
* [func Base() Logger](#Base)
* [func New() Logger](#New)
* [func With(key string, value interface{}) Logger](#With)
* [func WithError(err error) Logger](#WithError)
#### Package files
[doc.go](/src/github.com/tmc/log/doc.go) [log.go](/src/github.com/tmc/log/log.go)
## func [Debug](/src/target/log.go?s=4370:4401#L164)
``` go
func Debug(args ...interface{})
```
Debug logs a message at level Debug on the standard logger.
## func [Debugln](/src/target/log.go?s=4509:4542#L169)
``` go
func Debugln(args ...interface{})
```
Debugln logs a message at level Debug on the standard logger.
## func [Error](/src/target/log.go?s=5194:5225#L194)
``` go
func Error(args ...interface{})
```
Error logs a message at level Error on the standard logger.
## func [Errorln](/src/target/log.go?s=5333:5366#L199)
``` go
func Errorln(args ...interface{})
```
Errorln logs a message at level Error on the standard logger.
## func [Fatal](/src/target/log.go?s=5474:5505#L204)
``` go
func Fatal(args ...interface{})
```
Fatal logs a message at level Fatal on the standard logger.
## func [Fatalln](/src/target/log.go?s=5613:5646#L209)
``` go
func Fatalln(args ...interface{})
```
Fatalln logs a message at level Fatal on the standard logger.
## func [Info](/src/target/log.go?s=4648:4678#L174)
``` go
func Info(args ...interface{})
```
Info logs a message at level Info on the standard logger.
## func [Infoln](/src/target/log.go?s=4783:4815#L179)
``` go
func Infoln(args ...interface{})
```
Infoln logs a message at level Info on the standard logger.
## func [SetLevel](/src/target/log.go?s=3912:3938#L149)
``` go
func SetLevel(level Level)
```
SetLevel sets the Level of the base logger
## func [Warn](/src/target/log.go?s=4920:4950#L184)
``` go
func Warn(args ...interface{})
```
Warn logs a message at level Warn on the standard logger.
## func [Warnln](/src/target/log.go?s=5055:5087#L189)
``` go
func Warnln(args ...interface{})
```
Warnln logs a message at level Warn on the standard logger.
## type [Level](/src/target/log.go?s=134:150#L3)
``` go
type Level uint8
```
Level describes the log severity level.
``` go
const (
// PanicLevel level, highest level of severity. Logs and then calls panic with the
// message passed to Debug, Info, ...
PanicLevel Level = iota
// FatalLevel level. Logs and then calls `os.Exit(1)`. It will exit even if the
// logging level is set to Panic.
FatalLevel
// ErrorLevel level. Logs. Used for errors that should definitely be noted.
// Commonly used for hooks to send errors to an error tracking service.
ErrorLevel
// WarnLevel level. Non-critical entries that deserve eyes.
WarnLevel
// InfoLevel level. General operational entries about what's going on inside the
// application.
InfoLevel
// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
DebugLevel
)
```
## type [Logger](/src/target/log.go?s=926:1312#L25)
``` go
type Logger interface {
SetLevel(level Level)
SetOut(out io.Writer)
Debug(...interface{})
Debugln(...interface{})
Info(...interface{})
Infoln(...interface{})
Warn(...interface{})
Warnln(...interface{})
Error(...interface{})
Errorln(...interface{})
Fatal(...interface{})
Fatalln(...interface{})
With(key string, value interface{}) Logger
WithError(err error) Logger
}
```
Logger is an interface that describes logging.
### func [Base](/src/target/log.go?s=3823:3841#L144)
``` go
func Base() Logger
```
Base returns the base logger.
### func [New](/src/target/log.go?s=3716:3733#L139)
``` go
func New() Logger
```
New returns a new logger.
### func [With](/src/target/log.go?s=4037:4084#L154)
``` go
func With(key string, value interface{}) Logger
```
With attaches a key,value pair to a logger.
### func [WithError](/src/target/log.go?s=4210:4242#L159)
``` go
func WithError(err error) Logger
```
WithError returns a Logger that will print an error along with the next message.