1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
// Package syslog provides generic interfaces and structs for syslog messages and transport.
// Subpackages contains various parsers or scanners for different syslog formats.
package syslog
import (
"io"
"time"
)
// BestEfforter is an interface that wraps the HasBestEffort method.
type BestEfforter interface {
WithBestEffort()
HasBestEffort() bool
}
// Machine represent a FSM able to parse an entire syslog message and return it in an structured way.
type Machine interface {
Parse(input []byte) (Message, error)
BestEfforter
}
// MachineOption represents the type of option setters for Machine instances.
type MachineOption func(m Machine) Machine
// Parser is an interface that wraps the Parse method.
type Parser interface {
Parse(r io.Reader)
WithListener(ParserListener)
BestEfforter
}
// ParserOption represent the type of option setters for Parser instances.
type ParserOption func(p Parser) Parser
// ParserListener is a function that receives syslog parsing results, one by one.
type ParserListener func(*Result)
// Result wraps the outcomes obtained parsing a syslog message.
type Result struct {
Message Message
Error error
}
// Message represent a structured representation of a syslog message.
type Message interface {
Valid() bool
Priority() *uint8
Version() uint16
Facility() *uint8
Severity() *uint8
FacilityMessage() *string
FacilityLevel() *string
SeverityMessage() *string
SeverityLevel() *string
SeverityShortLevel() *string
Timestamp() *time.Time
Hostname() *string
ProcID() *string
Appname() *string
MsgID() *string
Message() *string
StructuredData() *map[string]map[string]string
}
|
