-
Notifications
You must be signed in to change notification settings - Fork 74
/
syslogd.go
241 lines (212 loc) · 7.57 KB
/
syslogd.go
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
// Copyright 2015-2018 trivago N.V.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package consumer
import (
"os"
"strconv"
"sync"
"time"
"github.com/trivago/gollum/core"
"github.com/trivago/tgo/tnet"
syslog "gopkg.in/mcuadros/go-syslog.v2"
"gopkg.in/mcuadros/go-syslog.v2/format"
)
// Syslogd consumer plugin
//
// The syslogd consumer creates a syslogd-compatible log server and
// receives messages on a TCP or UDP port or a UNIX filesystem socket.
//
// Parameters
//
// - Address: Defines the IP address or UNIX socket to listen to.
// This can take one of the four forms below, to listen on a TCP, UDP
// or UNIX domain socket. However, see the "Format" option for details on
// transport support by different formats.
// * [hostname|ip]:<tcp-port>
// * tcp://<hostname|ip>:<tcp-port>
// * udp://<hostname|ip>:<udp-port>
// * unix://<filesystem-path>
// By default this parameter is set to "udp://0.0.0.0:514"
//
// - Format: Defines which syslog standard the server will support.
// Three standards, listed below, are currently available. All
// standards support listening to UDP and UNIX domain sockets.
// RFC6587 additionally supports TCP sockets. Default: "RFC6587".
// * RFC3164 (https://tools.ietf.org/html/rfc3164) - unix, udp
// * RFC5424 (https://tools.ietf.org/html/rfc5424) - unix, udp
// * RFC6587 (https://tools.ietf.org/html/rfc6587) - unix, upd, tcp
// By default this parameter is set to "RFC6587".
//
// - SetMetadata: When set to true, syslog based metadata will be attached to
// the message. The metadata fields added depend on the protocol version used.
// RFC3164 supports: tag, timestamp, hostname, priority, facility, severity.
// RFC5424 and RFC6587 support: app_name, version, proc_id , msg_id, timestamp,
// hostname, priority, facility, severity.
// By default this parameter is set to "false".
//
// - TimestampFormat: When using SetMetadata this string denotes the go time
// format used to convert syslog timestamps into strings.
// By default this parameter is set to "2006-01-02T15:04:05.000 MST".
//
// Examples
//
// Replace the system's standard syslogd with Gollum
//
// SyslogdSocketConsumer:
// Type: consumer.Syslogd
// Streams: "system_syslog"
// Address: "unix:///dev/log"
// Format: "RFC3164"
//
// Listen on a TCP socket
//
// SyslogdTCPSocketConsumer:
// Type: consumer.Syslogd
// Streams: "tcp_syslog"
// Address: "tcp://0.0.0.0:5599"
// Format: "RFC6587"
//
type Syslogd struct {
core.SimpleConsumer `gollumdoc:"embed_type"`
format format.Format // RFC3164, RFC5424 or RFC6587?
protocol string
address string
withMetadata bool `config:"SetMetadata" default:"false"`
timestampFormat string `config:"TimestampFormat" default:"2006-01-02T15:04:05.000 MST"`
}
func init() {
core.TypeRegistry.Register(Syslogd{})
}
// Configure initializes this consumer with values from a plugin config.
func (cons *Syslogd) Configure(conf core.PluginConfigReader) {
cons.protocol, cons.address = tnet.ParseAddress(
conf.GetString("Address", "udp://0.0.0.0:514"), "tcp")
syslogFormat := conf.GetString("Format", "RFC6587")
switch cons.protocol {
case "udp", "tcp", "unix":
default:
conf.Errors.Pushf("Unknown protocol type %s", cons.protocol) // ### return, unknown protocol ###
}
switch syslogFormat {
// http://www.ietf.org/rfc/rfc3164.txt
case "RFC3164":
cons.format = syslog.RFC3164
if cons.protocol == "tcp" {
cons.Logger.Warning("RFC3164 demands UDP")
cons.protocol = "udp"
}
// https://tools.ietf.org/html/rfc5424
case "RFC5424":
cons.format = syslog.RFC5424
if cons.protocol == "tcp" {
cons.Logger.Warning("RFC5424 demands UDP")
cons.protocol = "udp"
}
// https://tools.ietf.org/html/rfc6587
case "RFC6587":
cons.format = syslog.RFC6587
default:
conf.Errors.Pushf("Format %s is not supported", syslogFormat)
}
}
// Handle implements the syslog handle interface
func (cons *Syslogd) Handle(parts format.LogParts, code int64, err error) {
content := ""
isString := false
metaData := core.Metadata{}
switch cons.format {
case syslog.RFC3164:
content, isString = parts["content"].(string)
if cons.withMetadata {
hostname, _ := parts["hostname"].(string)
tag, _ := parts["tag"].(string)
priority, _ := parts["priority"].(int)
facility, _ := parts["facility"].(int)
severity, _ := parts["severity"].(int)
timestamp, _ := parts["timestamp"].(time.Time)
metaData.SetValue("tag", []byte(tag))
metaData.SetValue("timestamp", []byte(timestamp.Format(cons.timestampFormat)))
metaData.SetValue("hostname", []byte(hostname))
metaData.SetValue("priority", []byte(strconv.Itoa(priority)))
metaData.SetValue("facility", []byte(strconv.Itoa(facility)))
metaData.SetValue("severity", []byte(strconv.Itoa(severity)))
}
case syslog.RFC5424, syslog.RFC6587:
content, isString = parts["message"].(string)
if cons.withMetadata {
hostname, _ := parts["hostname"].(string)
app, _ := parts["app_name"].(string)
version, _ := parts["version"].(string)
procID, _ := parts["proc_id"].(string)
msgID, _ := parts["msg_id"].(string)
priority, _ := parts["priority"].(int)
facility, _ := parts["facility"].(int)
severity, _ := parts["severity"].(int)
timestamp, _ := parts["timestamp"].(time.Time)
metaData.SetValue("app_name", []byte(app))
metaData.SetValue("version", []byte(version))
metaData.SetValue("proc_id", []byte(procID))
metaData.SetValue("msg_id", []byte(msgID))
metaData.SetValue("timestamp", []byte(timestamp.Format(cons.timestampFormat)))
metaData.SetValue("hostname", []byte(hostname))
metaData.SetValue("priority", []byte(strconv.Itoa(priority)))
metaData.SetValue("facility", []byte(strconv.Itoa(facility)))
metaData.SetValue("severity", []byte(strconv.Itoa(severity)))
}
default:
cons.Logger.Error("Could not determine the format to retrieve message/content")
}
if !isString {
cons.Logger.Error("Message/Content is not a string")
return
}
if cons.withMetadata {
cons.EnqueueWithMetadata([]byte(content), metaData)
} else {
cons.Enqueue([]byte(content))
}
}
// Consume opens a new syslog socket.
// Messages are expected to be separated by \n.
func (cons *Syslogd) Consume(workers *sync.WaitGroup) {
server := syslog.NewServer()
server.SetFormat(cons.format)
server.SetHandler(cons)
switch cons.protocol {
case "unix":
if err := server.ListenUnixgram(cons.address); err != nil {
if errRemove := os.Remove(cons.address); errRemove != nil {
cons.Logger.WithError(errRemove).Error("Failed to remove exisiting socket")
} else {
cons.Logger.Warning("Found existing socket ", cons.address, ". Removing.")
err = server.ListenUnixgram(cons.address)
}
if err != nil {
cons.Logger.WithError(err).Error("Failed to open unix://", cons.address)
}
}
case "udp":
if err := server.ListenUDP(cons.address); err != nil {
cons.Logger.Error("Failed to open udp://", cons.address)
}
case "tcp":
if err := server.ListenTCP(cons.address); err != nil {
cons.Logger.Error("Failed to open tcp://", cons.address)
}
}
server.Boot()
defer server.Kill()
cons.ControlLoop()
server.Wait()
}