Add 'internal/syslogparser/' from commit '88f35f5a85156bf3cfea115ae813dcfc7f81201a'

git-subtree-dir: internal/syslogparser
git-subtree-mainline: 74812b9
git-subtree-split: 88f35f5

Author: mcuadros

internal/syslogparser/.gitignore

@@ -0,0 +1 @@
+*.test

internal/syslogparser/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2013, Jérôme Renard
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

internal/syslogparser/Makefile

@@ -0,0 +1,19 @@
+SUBPACKAGES=. rfc3164 rfc5424
+help:
+	@echo "Available targets:"
+	@echo "- tests: run tests"
+	@echo "- installdependencies: installs dependencies declared in dependencies.txt"
+	@echo "- clean: cleans directory"
+	@echo "- benchmarks: run benchmarks"
+
+installdependencies:
+	@cat dependencies.txt | xargs go get
+
+tests: installdependencies
+	@for pkg in $(SUBPACKAGES); do cd $$pkg && go test -i && go test ; cd -;done
+
+clean:
+	find . -type 'f' -name '*.test' -print | xargs rm -f
+
+benchmarks:
+	@for pkg in $(SUBPACKAGES); do cd $$pkg && go test -gocheck.b ; cd -;done

internal/syslogparser/README

@@ -0,0 +1,93 @@
+Syslogparser
+============
+
+This is a syslog parser for the Go programming language.
+
+
+Installing
+----------
+
+go get github.com/jeromer/syslogparser
+
+
+Supported RFCs
+--------------
+
+RFC 3164 : https://tools.ietf.org/html/rfc3164
+RFC 5424 : https://tools.ietf.org/html/rfc5424
+
+Not all features described in RFCs above are supported but only the most part of
+it. For exaple SDIDs are not supported in RFC5424 and STRUCTURED-DATA are
+parsed as a whole string.
+
+This parser should solve 80% of use cases. If your use cases are in the 20%
+remaining ones I would recommend you to fully test what you want to achieve and
+provide a patch if you want.
+
+Parsing an RFC 3164 syslog message
+----------------------------------
+
+	b := "<34>Oct 11 22:14:15 mymachine su: 'su root' failed for lonvick on /dev/pts/8"
+	buff := []byte(b)
+
+	p := rfc3164.NewParser(buff)
+	err := p.Parse()
+	if err != nil {
+		panic(err)
+	}
+
+	for k, v := range p.Dump() {
+		fmt.Println(k, ":", v)
+	}
+
+You should see
+
+    timestamp : 2013-10-11 22:14:15 +0000 UTC
+    hostname  : mymachine
+    tag       : su
+    content   : 'su root' failed for lonvick on /dev/pts/8
+    priority  : 34
+    facility  : 4
+    severity  : 2
+
+Parsing an RFC 5424 syslog message
+----------------------------------
+
+	b := `<165>1 2003-10-11T22:14:15.003Z mymachine.example.com evntslog - ID47 [exampleSDID@32473 iut="3" eventSource="Application" eventID="1011"] An application event log entry...`
+	buff := []byte(b)
+
+	p := rfc5424.NewParser(buff)
+	err := p.Parse()
+	if err != nil {
+		panic(err)
+	}
+
+	for k, v := range p.Dump() {
+		fmt.Println(k, ":", v)
+	}
+
+You should see
+
+    version : 1
+    timestamp : 2003-10-11 22:14:15.003 +0000 UTC
+    app_name : evntslog
+    msg_id : ID47
+    message : An application event log entry...
+    priority : 165
+    facility : 20
+    severity : 5
+    hostname : mymachine.example.com
+    proc_id : -
+    structured_data : [exampleSDID@32473 iut="3" eventSource="Application" eventID="1011"]
+
+
+Running tests
+-------------
+
+make tests
+
+
+Running benchmarks
+------------------
+
+make benchmarks

internal/syslogparser/dependencies.txt

@@ -0,0 +1 @@
+launchpad.net/gocheck

internal/syslogparser/rfc3164/example_test.go

@@ -0,0 +1,19 @@
+package rfc3164_test
+
+import (
+	"fmt"
+	"github.com/Xiol/syslogparser/rfc3164"
+)
+
+func ExampleNewParser() {
+	b := "<34>Oct 11 22:14:15 mymachine su: 'su root' failed for lonvick on /dev/pts/8"
+	buff := []byte(b)
+
+	p := rfc3164.NewParser(buff)
+	err := p.Parse()
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(p.Dump())
+}