mirror of
https://github.com/status-im/status-go.git
synced 2025-01-10 22:56:40 +00:00
cf7a9949a3
Updates and adds some package docs. It also provides autogenerated README's using https://github.com/jimmyfrasche/autoreadme tool. To use it, make sure it's installed on your system, and every time you update documentation, run go generate to update the README.md file.
53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
# log [![GoDoc](https://godoc.org/github.com/status-im/status-go/geth/log?status.png)](https://godoc.org/github.com/status-im/status-go/geth/log)
|
|
Package log implements logger for status-go.
|
|
|
|
Download:
|
|
```shell
|
|
go get github.com/status-im/status-go/geth/log
|
|
```
|
|
|
|
* * *
|
|
Package log implements logger for status-go.
|
|
|
|
This logger handles two loggers - it's own and ethereum-go logger.
|
|
Both are used as "singletons" - using global shared variables.
|
|
|
|
## Usage
|
|
First, import package into your code:
|
|
|
|
```
|
|
import "github.com/status-im/status-go/geth/log
|
|
```
|
|
|
|
Then simply use `Info/Error/Debug/etc` functions to log at desired level:
|
|
|
|
```
|
|
log.Info("Info message")
|
|
log.Debug("Debug message")
|
|
log.Error("Error message")
|
|
```
|
|
|
|
Slightly more complicated logging:
|
|
|
|
```
|
|
log.Warn("abnormal conn rate", "rate", curRate, "low", lowRate, "high", highRate)
|
|
```
|
|
|
|
Note, in this case parameters should be in in pairs (key, value).
|
|
|
|
This logger is based upon log15-logger, so see its documentation for advanced usage: https://github.com/inconshreveable/log15
|
|
|
|
## Initialization
|
|
By default logger is set to log to stdout with Error level via `init()` function.
|
|
You may change both level and file output by `log.SetLevel()` and `log.SetLogFile()` functions:
|
|
|
|
```
|
|
log.SetLevel("DEBUG")
|
|
log.SetLogFile("/path/to/geth.log")
|
|
```
|
|
|
|
|
|
|
|
* * *
|
|
Automatically generated by [autoreadme](https://github.com/jimmyfrasche/autoreadme) on 2017.09.15
|