Skip to content

Commit 4095cee

Browse files
Dean KarnDean Karn
authored andcommitted
Add handlers + GODOC links to README
1 parent 226ff72 commit 4095cee

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Features
1818
- [x] Logger is simple, only logic to create the log entry and send it off to the handlers and they take it from there.
1919
- [x] Sends the log entry to the handlers asynchronously, but waits for all to complete; meaning all your handlers can be dealing with the log entry at the same time, but log will wait until all have completed before moving on.
2020
- [x] Ability to specify which log levels get sent to each handler
21-
- [x] Built-in console, syslog, http and email handlers
21+
- [x] Built-in console, syslog, http, HipChat and email handlers
2222
- [x] Handlers are simple to write + easy to register
2323
- [x] Logger is a singleton ( one of the few instances a singleton is desired ) so the root package registers which handlers are used and any libraries just follow suit.
2424

@@ -181,10 +181,18 @@ Log Level Definitions
181181

182182
**FatalLevel** - Should be corrected immediately, but indicates failure in a primary system, an example is a loss of a backup ISP connection. ( same as SYSLOG CRITICAL )
183183

184-
More Handlers
184+
Handlers
185185
-------------
186186
Pull requests for new handlers are welcome, please provide test coverage is all I ask.
187187

188+
| Handler | Description | Docs |
189+
| ------- | ---- | ----------- |
190+
| console | Allows for log messages to be sent to a any writer, default os.Stderr | [![GoDoc](https://godoc.org/github.com/go-playground/log/handlers/console?status.svg)](https://godoc.org/github.com/go-playground/log/handlers/console) |
191+
| syslog | Allows for log messages to be sent via syslog. | [![GoDoc](https://godoc.org/github.com/go-playground/log/handlers/syslog?status.svg)](https://godoc.org/github.com/go-playground/log/handlers/syslog) |
192+
| http | Allows for log messages to be sent via http. Can use the HTTP handler as a base for creating other handlers requiring http transmission. | [![GoDoc](https://godoc.org/github.com/go-playground/log/handlers/http?status.svg)](https://godoc.org/github.com/go-playground/log/handlers/http) |
193+
| email | Allows for log messages to be sent via email. | [![GoDoc](https://godoc.org/github.com/go-playground/log/handlers/email?status.svg)](https://godoc.org/github.com/go-playground/log/handlers/email) |
194+
| hipchat | Allows for log messages to be sent to a hipchat room. | [![GoDoc](https://godoc.org/github.com/go-playground/log/handlers/http/hipchat?status.svg)](https://godoc.org/github.com/go-playground/log/handlers/http/hipchat) |
195+
188196
Package Versioning
189197
----------
190198
I'm jumping on the vendoring bandwagon, you should vendor this package as I will not

0 commit comments

Comments
 (0)