summaryrefslogtreecommitdiff
path: root/vendor/gopkg.in/mcuadros/go-syslog.v2/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/gopkg.in/mcuadros/go-syslog.v2/README.md')
-rw-r--r--vendor/gopkg.in/mcuadros/go-syslog.v2/README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/vendor/gopkg.in/mcuadros/go-syslog.v2/README.md b/vendor/gopkg.in/mcuadros/go-syslog.v2/README.md
new file mode 100644
index 000000000..e17a0fae2
--- /dev/null
+++ b/vendor/gopkg.in/mcuadros/go-syslog.v2/README.md
@@ -0,0 +1,48 @@
+go-syslog [![Build Status](https://travis-ci.org/mcuadros/go-syslog.svg?branch=master)](https://travis-ci.org/mcuadros/go-syslog) [![GoDoc](http://godoc.org/github.com/mcuadros/go-syslog?status.svg)](hhttps://godoc.org/gopkg.in/mcuadros/go-syslog.v2) [![GitHub release](https://img.shields.io/github/release/mcuadros/go-syslog.svg)](https://github.com/mcuadros/go-syslog/releases)
+==============================
+
+Syslog server library for go, build easy your custom syslog server over UDP, TCP or Unix sockets using RFC3164, RFC6587 or RFC5424
+
+Installation
+------------
+
+The recommended way to install go-syslog
+
+```
+go get gopkg.in/mcuadros/go-syslog.v2
+```
+
+Examples
+--------
+
+How import the package
+
+```go
+import "gopkg.in/mcuadros/go-syslog.v2"
+```
+
+Example of a basic syslog [UDP server](example/basic_udp.go):
+
+```go
+channel := make(syslog.LogPartsChannel)
+handler := syslog.NewChannelHandler(channel)
+
+server := syslog.NewServer()
+server.SetFormat(syslog.RFC5424)
+server.SetHandler(handler)
+server.ListenUDP("0.0.0.0:514")
+server.Boot()
+
+go func(channel syslog.LogPartsChannel) {
+ for logParts := range channel {
+ fmt.Println(logParts)
+ }
+}(channel)
+
+server.Wait()
+```
+
+License
+-------
+
+MIT, see [LICENSE](LICENSE)