README
¶
waterlog
Go Logging that just works
Motivation
Logging is terribly boring, but can be an important part of a project. This library provides logging capabilities that attempt to "spice up" what is otherwise a very utilitarian aspect of programming.
Goals
- Styling that is easy to look at
- More granular logging severities ("levels")
- Compatibility with the existing
log.Loggerinterface
Implementation
Waterlog consists of two sets of code. The first is an implementation
in Go which is able to be used as a drop-in replacement for the Go
log.Logger. The second is a set of Makefile definitions that
provide similar styling for GNU Make project.
Message Types
The traditional log.Logger implementation only provides three
different message types:
| Type | Behavior |
|---|---|
| Fatal | Log message and os.Exit(1) |
| Panic | Log message and panic() |
| Log message |
For each level it also supports a Print, Printf, and Println variant of the output.
Waterlog, on the other hand, provides a total of 8 message types.
These levels also support Print, Printf, and Println output modes.
Unlike log.Logger, Waterlog supports logging levels which
correspond with these message types. Higher levels allow more types
of message to be shown. The logging level may be changed at any time
by the SetLevel() method. The psuedo-type Disable is also
provided to allow quiet operation. A default level of Fatal is
assigned to new Waterlog instances. Lastly, Print messages are always
written as unformatted text with no timestamp and ignore the logging
level.
| Type | Behavior | Level |
|---|---|---|
| Disable | No messages | 0 |
| Panic | Runtime "exception" message and panic() |
1 |
| Fatal | Unrecoverable error message and os.Exit(1) |
2 |
| Error | Recoverable error message | 3 |
| Warn | Warning message | 4 |
| Good | Success message | 5 |
| Info | General information message | 6 |
| Debug | Developer Debug information. | 7 |
| Always print unstyled text | n/a |
Examples
format.Full Logger
format.Min Logger
format.Un Logger
Makefile
License
Copyright 2017-2021 Bryan T. Meyers [email protected]
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.
Documentation
¶
Overview ¶
Package waterlog provides an extended and styled log.Logger functionality.
Index ¶
- func Debug(v ...interface{})
- func Debugf(f string, v ...interface{})
- func Debugln(v ...interface{})
- func Error(v ...interface{})
- func Errorf(f string, v ...interface{})
- func Errorln(v ...interface{})
- func Fatal(v ...interface{})
- func Fatalf(f string, v ...interface{})
- func Fatalln(v ...interface{})
- func Flags() int
- func Good(v ...interface{})
- func Goodf(f string, v ...interface{})
- func Goodln(v ...interface{})
- func Info(v ...interface{})
- func Infof(f string, v ...interface{})
- func Infoln(v ...interface{})
- func Level() uint8
- func Panic(v ...interface{})
- func Panicf(f string, v ...interface{})
- func Panicln(v ...interface{})
- func Print(v ...interface{})
- func Printf(f string, v ...interface{})
- func Println(v ...interface{})
- func SetFlags(flag int)
- func SetFormat(format format.Func)
- func SetLevel(level uint8)
- func SetOutput(output io.Writer)
- func Warn(v ...interface{})
- func Warnf(f string, v ...interface{})
- func Warnln(v ...interface{})
- type WaterLog
- func (w *WaterLog) Debug(v ...interface{})
- func (w *WaterLog) Debugf(f string, v ...interface{})
- func (w *WaterLog) Debugln(v ...interface{})
- func (w *WaterLog) Error(v ...interface{})
- func (w *WaterLog) Errorf(f string, v ...interface{})
- func (w *WaterLog) Errorln(v ...interface{})
- func (w *WaterLog) Fatal(v ...interface{})
- func (w *WaterLog) Fatalf(f string, v ...interface{})
- func (w *WaterLog) Fatalln(v ...interface{})
- func (w *WaterLog) Flags() int
- func (w *WaterLog) Good(v ...interface{})
- func (w *WaterLog) Goodf(f string, v ...interface{})
- func (w *WaterLog) Goodln(v ...interface{})
- func (w *WaterLog) Info(v ...interface{})
- func (w *WaterLog) Infof(f string, v ...interface{})
- func (w *WaterLog) Infoln(v ...interface{})
- func (w *WaterLog) Level() uint8
- func (w *WaterLog) Output(calldepth int, s string) error
- func (w *WaterLog) Panic(v ...interface{})
- func (w *WaterLog) Panicf(f string, v ...interface{})
- func (w *WaterLog) Panicln(v ...interface{})
- func (w *WaterLog) Print(v ...interface{})
- func (w *WaterLog) Printf(f string, v ...interface{})
- func (w *WaterLog) Println(v ...interface{})
- func (w *WaterLog) SetFlags(flag int)
- func (w *WaterLog) SetFormat(format format.Func)
- func (w *WaterLog) SetLevel(level uint8)
- func (w *WaterLog) SetOutput(output io.Writer)
- func (w *WaterLog) Time() string
- func (w *WaterLog) Warn(v ...interface{})
- func (w *WaterLog) Warnf(f string, v ...interface{})
- func (w *WaterLog) Warnln(v ...interface{})
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Fatal ¶ added in v1.0.5
func Fatal(v ...interface{})
Fatal is a styled Print followed by os.Exit(1)
func Fatalf ¶ added in v1.0.5
func Fatalf(f string, v ...interface{})
Fatalf is a styled Printf followed by os.Exit(1)
func Fatalln ¶ added in v1.0.5
func Fatalln(v ...interface{})
Fatalln is a styled Println followed by os.Exit(1)
func Panic ¶ added in v1.0.5
func Panic(v ...interface{})
Panic is a styled Print followed by a call to panic("")
func Panicf ¶ added in v1.0.5
func Panicf(f string, v ...interface{})
Panicf is a styled Printf followed by a call to panic("")
func Panicln ¶ added in v1.0.5
func Panicln(v ...interface{})
Panicln is a styled Println followed by a call to panic("")
func Printf ¶ added in v1.0.5
func Printf(f string, v ...interface{})
Printf is a mutex protect fmt.Fprintf
func Println ¶ added in v1.0.5
func Println(v ...interface{})
Println is a mutex protect fmt.Fprintln
Types ¶
type WaterLog ¶
type WaterLog struct {
// contains filtered or unexported fields
}
WaterLog is a styled log.Logger
func (*WaterLog) Fatal ¶
func (w *WaterLog) Fatal(v ...interface{})
Fatal is a styled Print followed by os.Exit(1)
func (*WaterLog) Fatalln ¶
func (w *WaterLog) Fatalln(v ...interface{})
Fatalln is a styled Println followed by os.Exit(1)
func (*WaterLog) Panic ¶
func (w *WaterLog) Panic(v ...interface{})
Panic is a styled Print followed by a call to panic("")
func (*WaterLog) Panicln ¶
func (w *WaterLog) Panicln(v ...interface{})
Panicln is a styled Println followed by a call to panic("")
func (*WaterLog) Print ¶
func (w *WaterLog) Print(v ...interface{})
Print is a mutex protect fmt.Fprint
func (*WaterLog) Println ¶
func (w *WaterLog) Println(v ...interface{})
Println is a mutex protect fmt.Fprintln
Source Files
Directories