rfc5424

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 8, 2018 License: MIT Imports: 4 Imported by: 25

Documentation

Overview

Example 
i := []byte(`<165>4 2018-10-11T22:14:15.003Z mymach.it e - 1 [ex@32473 iut="3"] An application event log entry...`)
p := NewParser()
m, _ := p.Parse(i, nil)
output(m)

Output:

(*rfc5424.SyslogMessage)({
 priority: (*uint8)(165),
 facility: (*uint8)(20),
 severity: (*uint8)(5),
 version: (uint16) 4,
 timestamp: (*time.Time)(2018-10-11 22:14:15.003 +0000 UTC),
 hostname: (*string)((len=9) "mymach.it"),
 appname: (*string)((len=1) "e"),
 procID: (*string)(<nil>),
 msgID: (*string)((len=1) "1"),
 structuredData: (*map[string]map[string]string)((len=1) {
  (string) (len=8) "ex@32473": (map[string]string) (len=1) {
   (string) (len=3) "iut": (string) (len=1) "3"
  }
 }),
 message: (*string)((len=33) "An application event log entry...")
})
Example (Besteffort) 
bestEffortOn := true
i := []byte(`<1>1 A - - - - - -`)
p := NewParser()
m, e := p.Parse(i, &bestEffortOn)
output(m)
fmt.Println(e)

Output:

(*rfc5424.SyslogMessage)({
 priority: (*uint8)(1),
 facility: (*uint8)(0),
 severity: (*uint8)(1),
 version: (uint16) 1,
 timestamp: (*time.Time)(<nil>),
 hostname: (*string)(<nil>),
 appname: (*string)(<nil>),
 procID: (*string)(<nil>),
 msgID: (*string)(<nil>),
 structuredData: (*map[string]map[string]string)(<nil>),
 message: (*string)(<nil>)
})
expecting a RFC3339MICRO timestamp or a nil value [col 5]
Example (Builder) 
msg := &SyslogMessage{}
msg.SetTimestamp("not a RFC3339MICRO timestamp")
fmt.Println("Valid?", msg.Valid())
msg.SetPriority(191)
msg.SetVersion(1)
fmt.Println("Valid?", msg.Valid())
output(msg)
str, _ := msg.String()
fmt.Println(str)

Output:

Valid? false
Valid? true
(*rfc5424.SyslogMessage)({
 priority: (*uint8)(191),
 facility: (*uint8)(23),
 severity: (*uint8)(7),
 version: (uint16) 1,
 timestamp: (*time.Time)(<nil>),
 hostname: (*string)(<nil>),
 appname: (*string)(<nil>),
 procID: (*string)(<nil>),
 msgID: (*string)(<nil>),
 structuredData: (*map[string]map[string]string)(<nil>),
 message: (*string)(<nil>)
})
<191>1 - - - - - -

Index

Examples

Constants

View Source 
const RFC3339MICRO = "2006-01-02T15:04:05.999999Z07:00"

Variables

This section is empty.

Functions

func NewMachine 

func NewMachine() *machine

NewMachine creates a new FSM able to parse RFC5424 syslog messages.

Types

type Parser 

type Parser struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Parser represent a RFC5424 FSM with mutex capabilities.

func NewParser 

func NewParser() *Parser

NewParser creates a new parser and the underlying FSM.

func (Parser) Err 

func (m Parser) Err() error

Err returns the error that occurred on the last call to Parse.

If the result is nil, then the line was parsed successfully.

func (*Parser) Parse 

func (p *Parser) Parse(input []byte, bestEffort *bool) (*SyslogMessage, error)

Parse parses the input RFC5424 syslog message using its FSM.

Best effort mode enables the partial parsing.

type SyslogMessage 

type SyslogMessage struct {
	// contains filtered or unexported fields
}

SyslogMessage represents a syslog message.

func (*SyslogMessage) Appname 

func (sm *SyslogMessage) Appname() *string

Appname returns the syslog appname or nil when not set

func (*SyslogMessage) Facility 

func (sm *SyslogMessage) Facility() *uint8

Facility returns the facility code.

func (*SyslogMessage) FacilityLevel 

func (sm *SyslogMessage) FacilityLevel() *string

FacilityLevel returns the

func (*SyslogMessage) FacilityMessage 

func (sm *SyslogMessage) FacilityMessage() *string

FacilityMessage returns the text message for the current facility value.

func (*SyslogMessage) Hostname 

func (sm *SyslogMessage) Hostname() *string

Hostname returns the syslog hostname or nil when not set

func (*SyslogMessage) Message 

func (sm *SyslogMessage) Message() *string

Message returns the syslog message or nil when not set

func (*SyslogMessage) MsgID 

func (sm *SyslogMessage) MsgID() *string

MsgID returns the syslog msg ID or nil when not set

func (*SyslogMessage) Priority 

func (sm *SyslogMessage) Priority() *uint8

Priority returns the syslog priority or nil when not set

func (*SyslogMessage) ProcID 

func (sm *SyslogMessage) ProcID() *string

ProcID returns the syslog proc ID or nil when not set

func (*SyslogMessage) SetAppname 

func (sm *SyslogMessage) SetAppname(value string) *SyslogMessage

SetAppname set the appname value.

func (*SyslogMessage) SetElementID 

func (sm *SyslogMessage) SetElementID(value string) *SyslogMessage

SetElementID set a structured data id.

When the provided id already exists the operation is discarded.

func (*SyslogMessage) SetHostname 

func (sm *SyslogMessage) SetHostname(value string) *SyslogMessage

SetHostname set the hostname value.

func (*SyslogMessage) SetMessage 

func (sm *SyslogMessage) SetMessage(value string) *SyslogMessage

SetMessage set the message value.

func (*SyslogMessage) SetMsgID 

func (sm *SyslogMessage) SetMsgID(value string) *SyslogMessage

SetMsgID set the msgid value.

func (*SyslogMessage) SetParameter 

func (sm *SyslogMessage) SetParameter(id string, name string, value string) *SyslogMessage

SetParameter set a structured data parameter belonging to the given element.

If the element does not exist it creates one with the given element id. When a parameter with the given name already exists for the given element the operation is discarded.

func (*SyslogMessage) SetPriority 

func (sm *SyslogMessage) SetPriority(value uint8) *SyslogMessage

SetPriority set the priority value and the computed facility and severity codes accordingly.

It ignores incorrect priority values (range [0, 191]).

func (*SyslogMessage) SetProcID 

func (sm *SyslogMessage) SetProcID(value string) *SyslogMessage

SetProcID set the procid value.

func (*SyslogMessage) SetTimestamp 

func (sm *SyslogMessage) SetTimestamp(value string) *SyslogMessage

SetTimestamp set the timestamp value.

func (*SyslogMessage) SetVersion 

func (sm *SyslogMessage) SetVersion(value uint16) *SyslogMessage

SetVersion set the version value.

It ignores incorrect version values (range ]0, 999]).

func (*SyslogMessage) Severity 

func (sm *SyslogMessage) Severity() *uint8

Severity returns the severity code.

func (*SyslogMessage) SeverityLevel 

func (sm *SyslogMessage) SeverityLevel() *string

SeverityLevel returns the text level for the current severity value.

func (*SyslogMessage) SeverityMessage 

func (sm *SyslogMessage) SeverityMessage() *string

SeverityMessage returns the text message for the current severity value.

func (*SyslogMessage) SeverityShortLevel 

func (sm *SyslogMessage) SeverityShortLevel() *string

SeverityShortLevel returns the short text level for the current severity value.

func (*SyslogMessage) String 

func (sm *SyslogMessage) String() (string, error)

func (*SyslogMessage) StructuredData 

func (sm *SyslogMessage) StructuredData() *map[string]map[string]string

StructuredData returns the syslog structured data or nil when not set

func (*SyslogMessage) Timestamp 

func (sm *SyslogMessage) Timestamp() *time.Time

Timestamp returns the syslog timestamp or nil when not set

func (*SyslogMessage) Valid 

func (sm *SyslogMessage) Valid() bool

Valid tells whether the receiving SyslogMessage is well-formed or not.

A minimally well-formed syslog message contains at least a priority ([1, 191] or 0) and the version (]0, 999]).

func (*SyslogMessage) Version 

func (sm *SyslogMessage) Version() uint16

Version returns the syslog version or nil when not set

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.