Git Product home page Git Product logo

rfc5424's Introduction

Build Status

This is a Go library that can read and write RFC-5424 syslog messages:

Example usage:

m := rfc5424.Message{
    Priority:  rfc5424.Daemon | rfc5424.Info,
    Timestamp: time.Now(),
    Hostname:  "myhostname",
    AppName:   "someapp",
    Message:   []byte("Hello, World!"),
}
m.AddDatum("foo@1234", "Revision", "1.2.3.4")
m.WriteTo(os.Stdout)

Produces output like:

107 <7>1 2016-02-28T09:57:10.804642398-05:00 myhostname someapp - - [foo@1234 Revision="1.2.3.4"] Hello, World!

You can also use the library to parse syslog messages:

m := rfc5424.Message{}
_, err := m.ReadFrom(os.Stdin)
fmt.Printf("%s\n", m.Message)

rfc5424's People

Contributors

altenhof avatar brompwnie avatar crewjam avatar danp avatar glinton avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

rfc5424's Issues

UnmarshallBinary produces broken Message part

Hi @crewjam,

thanks for making that code available.

I'm currently experimenting with using your library to parse syslog messages that are received via a HTTPS endpoint, i.e. the client is sending messages via a HTTP POST.

In my ServeHTTP function, I'm doing basically this:

        scanner := bufio.NewScanner(req.Body)
        for scanner.Scan() {
            b := scanner.Bytes()
            if len(b) > 0 {
                var m *rfc5424.Message = &rfc5424.Message{}
                if err = m.UnmarshalBinary(b); err != nil {
                    fmt.Printf("cannot parse msg: %v\n", err)
                } else {
                    h.msgQueue <- *m
                }
            }
        }
        req.Body.Close()

But using this, the Message field gets screwed up if more than one syslog line is sent in the request body.

Looking at func (m *Message) UnmarshalBinary(inputBuffer []byte) I fear that the assignment

      m.Message = r.Bytes()

is unsafe and should be replaced by

    m.Message = make([]byte, len(r.Bytes()))
    copy(m.Message, r.Bytes())

Best

Michael

Parse messages outside of method

The only way to parse syslog messages is by creating an empty message struct and calling its method. I don't think this is idiomatic go. Why not just have a generic parse() function which returns a message or a slice of messages from whatever was parsed?

Would a PR be welcome? Is the library still maintained? There's only one release (0.1.0)

app-name is not set correctly?

We're creating a message like this:

msg := rfc5424.Message{
		Priority:  rfc5424.Daemon | rfc5424.Info,
		Timestamp: time.Now(),
		Hostname:  al.osHostname,
		ProcessID: al.osPid,
		AppName:   "fusion",
		Message:   p,
	}

Here, we've set AppName to "fusion". However, the remote rsyslog server receives the app-name property as "<30>1". Does this library set the app-name property?

https://www.rsyslog.com/doc/master/configuration/properties.html

FYI, the reason I ask is because I would like to filter on app-name, such as:

if $app-name == "fusion" then :omstdout:

Timestamp does not follow RFC5424

When creating a syslog message, this library uses nine digits for the nanoseconds. The RFC stipulates six digits for TIME-SECFRAC here.

See example 5 where nine digits is explicitly called out as invalid.

Are you interested in a PR for this change?

Here is how we fixed the issue in our fork.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.