new(rfc3164): option to set the time zone on the Stamp timestamps of the syslog messages

Signed-off-by: Leonardo Di Donato <[email protected]>

Author: leodido

rfc3164/machine.go

@@ -35,6 +35,7 @@ type machine struct {
 	bestEffort bool
 	yyyy       int
 	rfc3339    bool
+	loc        *time.Location
 }
 
 // NewMachine creates a new FSM able to parse RFC3164 syslog messages.
@@ -58,10 +59,19 @@ func (m *machine) HasBestEffort() bool {
 	return m.bestEffort
 }
 
+// WithYear sets the year for the Stamp timestamp of the RFC 3164 syslog message.
 func (m *machine) WithYear(o YearOperator) {
 	m.yyyy = YearOperation{o}.Operate()
 }
 
+// WithTimezone sets the time zone for the Stamp timestamp of the RFC 3164 syslog message.
+func (m *machine) WithTimezone(loc *time.Location) {
+	m.loc = loc
+}
+
+// WithRFC3339 enables ability to ALSO match RFC3339 timestamps.
+//
+// Notice this does not disable the default and correct timestamps - ie., Stamp timestamps.
 func (m *machine) WithRFC3339() {
 	m.rfc3339 = true
 }
@@ -1153,6 +1163,9 @@ func (m *machine) Parse(input []byte) (syslog.Message, error) {
 			}
 		} else {
 			output.timestamp = t.AddDate(m.yyyy, 0, 0)
+			if m.loc != nil {
+				output.timestamp = output.timestamp.In(m.loc)
+			}
 			output.timestampSet = true
 		}
 

rfc3164/machine.go.rl

@@ -44,6 +44,9 @@ action set_timestamp {
 		fgoto fail;
 	} else {
 		output.timestamp = t.AddDate(m.yyyy, 0, 0)
+		if m.loc != nil {
+			output.timestamp = output.timestamp.In(m.loc)
+		}
 		output.timestampSet = true
 	}
 }
@@ -167,6 +170,7 @@ type machine struct {
 	bestEffort   bool
 	yyyy         int
 	rfc3339      bool
+	loc          *time.Location
 }
 
 // NewMachine creates a new FSM able to parse RFC3164 syslog messages.
@@ -196,10 +200,19 @@ func (m *machine) HasBestEffort() bool {
 	return m.bestEffort
 }
 
+// WithYear sets the year for the Stamp timestamp of the RFC 3164 syslog message.
 func (m *machine) WithYear(o YearOperator) {
 	m.yyyy = YearOperation{o}.Operate()
 }
 
+// WithTimezone sets the time zone for the Stamp timestamp of the RFC 3164 syslog message.
+func (m *machine) WithTimezone(loc *time.Location) {
+	m.loc = loc
+}
+
+// WithRFC3339 enables ability to ALSO match RFC3339 timestamps.
+//
+// Notice this does not disable the default and correct timestamps - ie., Stamp timestamps.
 func (m *machine) WithRFC3339() {
 	m.rfc3339 = true
 }

rfc3164/options.go

@@ -1,6 +1,8 @@
 package rfc3164
 
 import (
+	"time"
+
 	syslog "github.com/influxdata/go-syslog/v2"
 )
 
@@ -21,12 +23,12 @@ func WithYear(o YearOperator) syslog.MachineOption {
 }
 
 // WithTimezone sets the strategy to decide the timezone to apply to the Stamp timestamp of RFC 3164.
-// func WithTimezone(loc time.Location) syslog.MachineOption {
-// 	return func(m syslog.Machine) syslog.Machine {
-// 		m.(*machine).WithTimezone(loc)
-// 		return m
-// 	}
-// }
+func WithTimezone(loc *time.Location) syslog.MachineOption {
+	return func(m syslog.Machine) syslog.Machine {
+		m.(*machine).WithTimezone(loc)
+		return m
+	}
+}
 
 // todo > WithStrictHostname() option - see RFC3164 page 10
 // WithStrictHostname tells the parser to match the hostnames strictly as per RFC 3164 recommentations.