aboutsummaryrefslogtreecommitdiffstats
path: root/ethlog/loggers.go
diff options
context:
space:
mode:
authorFelix Lange <fjl@twurst.com>2014-10-15 17:15:59 +0800
committerFelix Lange <fjl@twurst.com>2014-10-17 23:20:44 +0800
commit0165c1833017963a280f135a5733974a9fc3ec0b (patch)
treef639827843761216bf5daba09bf03eed26d0a268 /ethlog/loggers.go
parente0f93c74c54f04e8da18ee0f0eee58e322ddc89b (diff)
downloaddexon-0165c1833017963a280f135a5733974a9fc3ec0b.tar
dexon-0165c1833017963a280f135a5733974a9fc3ec0b.tar.gz
dexon-0165c1833017963a280f135a5733974a9fc3ec0b.tar.bz2
dexon-0165c1833017963a280f135a5733974a9fc3ec0b.tar.lz
dexon-0165c1833017963a280f135a5733974a9fc3ec0b.tar.xz
dexon-0165c1833017963a280f135a5733974a9fc3ec0b.tar.zst
dexon-0165c1833017963a280f135a5733974a9fc3ec0b.zip
ethlog: use Godoc for code examples in documentation
This ensures that examples will actually compile.
Diffstat (limited to 'ethlog/loggers.go')
-rw-r--r--ethlog/loggers.go36
1 files changed, 8 insertions, 28 deletions
diff --git a/ethlog/loggers.go b/ethlog/loggers.go
index d1a4c5863..b8a7b0455 100644
--- a/ethlog/loggers.go
+++ b/ethlog/loggers.go
@@ -1,35 +1,14 @@
/*
Package ethlog implements a multi-output leveled logger.
-Features
+Other packages use tagged logger to send log messages to shared
+(process-wide) logging engine. The shared logging engine dispatches to
+multiple log systems. The log level can be set separately per log
+system.
-Other packages use tagged logger to send log messages to shared (process-wide) logging engine.
-The shared logging engine dispatches to multiple log systems.
-The log level can be set separately per log system.
-
-Logging is asynchrounous and does not block the main thread. Message
+Logging is asynchrounous and does not block the caller. Message
formatting is performed by the caller goroutine to avoid incorrect
logging of mutable state.
-
-Usage
-
-The Logger type provides named Printf and Println style methods for
-all loglevels. Each ethereum component should have its own logger with
-a unique prefix.
-
- logger.Infoln("this is info") # > [TAG] This is info
- logger.Infof("this %v is info", object) # > [TAG] This object is info
-
-ethlog also provides constructors for that wrap io.Writers into a
-standard logger with a settable level:
-
- filename := "test.log"
- file, _ := os.OpenFile(filename, os.O_RDWR|os.O_CREATE, os.ModePerm)
- fileLogSystem := NewStdLogSystem(file, 0, WarnLevel)
- AddLogSystem(fileLogSystem)
- stdOutLogSystem := NewStdLogSystem(os.Stdout, 0, WarnLevel)
- AddLogSystem(stdOutLogSystem)
-
*/
package ethlog
@@ -160,8 +139,9 @@ func AddLogSystem(logSystem LogSystem) {
mutex.Unlock()
}
-// A Logger prints messages prefixed by a given tag.
-// You should create one with a unique tag for each high-level component.
+// A Logger prints messages prefixed by a given tag. It provides named
+// Printf and Println style methods for all loglevels. Each ethereum
+// component should have its own logger with a unique prefix.
type Logger struct {
tag string
}