summaryrefslogtreecommitdiff
path: root/internal/log/format
diff options
context:
space:
mode:
Diffstat (limited to 'internal/log/format')
-rw-r--r--internal/log/format/format.go90
-rw-r--r--internal/log/format/format_test.go60
-rw-r--r--internal/log/format/json.go241
-rw-r--r--internal/log/format/logfmt.go67
4 files changed, 458 insertions, 0 deletions
diff --git a/internal/log/format/format.go b/internal/log/format/format.go
new file mode 100644
index 000000000..b7c650906
--- /dev/null
+++ b/internal/log/format/format.go
@@ -0,0 +1,90 @@
+// GoToSocial
+// Copyright (C) GoToSocial Authors admin@gotosocial.org
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+package format
+
+import (
+ "sync/atomic"
+ "time"
+
+ "code.superseriousbusiness.org/gotosocial/internal/log/level"
+ "codeberg.org/gruf/go-byteutil"
+ "codeberg.org/gruf/go-kv/v2"
+)
+
+var (
+ // ensure func signature conformance.
+ _ FormatFunc = (*Logfmt)(nil).Format
+ _ FormatFunc = (*JSON)(nil).Format
+)
+
+// FormatFunc defines a function capable of formatting a log entry (args = 1+) to a given buffer (args = 0).
+type FormatFunc func(buf *byteutil.Buffer, stamp time.Time, pc uintptr, lvl level.LEVEL, kvs []kv.Field, msg string) //nolint:revive
+
+type Base struct {
+ // TimeFormat defines time.Format() layout to
+ // use when appending a timestamp to log entry.
+ TimeFormat string
+
+ // stampCache caches recently formatted stamps.
+ //
+ // see the following benchmark:
+ // goos: linux
+ // goarch: amd64
+ // pkg: code.superseriousbusiness.org/gotosocial/internal/log/format
+ // cpu: AMD Ryzen 7 7840U w/ Radeon 780M Graphics
+ // BenchmarkStampCache
+ // BenchmarkStampCache-16 272199975 4.447 ns/op 0 B/op 0 allocs/op
+ // BenchmarkNoStampCache
+ // BenchmarkNoStampCache-16 76041058 15.94 ns/op 0 B/op 0 allocs/op
+ stampCache atomic.Pointer[struct {
+ stamp time.Time
+ format string
+ }]
+}
+
+// AppendFormatStamp will append given timestamp according to TimeFormat,
+// caching recently formatted stamp strings to reduce number of Format() calls.
+func (b *Base) AppendFormatStamp(buf *byteutil.Buffer, stamp time.Time) {
+ const precision = time.Millisecond
+
+ // Load cached stamp value.
+ last := b.stampCache.Load()
+
+ // Round stamp to min precision.
+ stamp = stamp.Round(precision)
+
+ // If a cached entry exists use this string.
+ if last != nil && stamp.Equal(last.stamp) {
+ buf.B = append(buf.B, last.format...)
+ return
+ }
+
+ // Else format new and store ASAP,
+ // i.e. ignoring any CAS result.
+ format := stamp.Format(b.TimeFormat)
+ b.stampCache.CompareAndSwap(last, &struct {
+ stamp time.Time
+ format string
+ }{
+ stamp: stamp,
+ format: format,
+ })
+
+ // Finally, append new timestamp.
+ buf.B = append(buf.B, format...)
+}
diff --git a/internal/log/format/format_test.go b/internal/log/format/format_test.go
new file mode 100644
index 000000000..a8d229eb7
--- /dev/null
+++ b/internal/log/format/format_test.go
@@ -0,0 +1,60 @@
+// GoToSocial
+// Copyright (C) GoToSocial Authors admin@gotosocial.org
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+package format_test
+
+import (
+ "testing"
+ "time"
+
+ "code.superseriousbusiness.org/gotosocial/internal/log/format"
+ "codeberg.org/gruf/go-byteutil"
+)
+
+func BenchmarkStampCache(b *testing.B) {
+ var base format.Base
+ base.TimeFormat = `02/01/2006 15:04:05.000`
+
+ b.RunParallel(func(pb *testing.PB) {
+ var buf byteutil.Buffer
+ buf.B = make([]byte, 0, 1024)
+
+ for pb.Next() {
+ base.AppendFormatStamp(&buf, time.Now())
+ buf.B = buf.B[:0]
+ }
+
+ buf.B = buf.B[:0]
+ })
+}
+
+func BenchmarkNoStampCache(b *testing.B) {
+ var base format.Base
+ base.TimeFormat = `02/01/2006 15:04:05.000`
+
+ b.RunParallel(func(pb *testing.PB) {
+ var buf byteutil.Buffer
+ buf.B = make([]byte, 0, 1024)
+
+ for pb.Next() {
+ buf.B = time.Now().AppendFormat(buf.B, base.TimeFormat)
+ buf.B = buf.B[:0]
+ }
+
+ buf.B = buf.B[:0]
+ })
+}
diff --git a/internal/log/format/json.go b/internal/log/format/json.go
new file mode 100644
index 000000000..49964b5fe
--- /dev/null
+++ b/internal/log/format/json.go
@@ -0,0 +1,241 @@
+// GoToSocial
+// Copyright (C) GoToSocial Authors admin@gotosocial.org
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+package format
+
+import (
+ "encoding/json"
+ "time"
+ "unicode/utf8"
+
+ "code.superseriousbusiness.org/gotosocial/internal/log/level"
+ "codeberg.org/gruf/go-byteutil"
+ "codeberg.org/gruf/go-caller"
+ "codeberg.org/gruf/go-kv/v2"
+)
+
+type JSON struct{ Base }
+
+func (fmt *JSON) Format(buf *byteutil.Buffer, stamp time.Time, pc uintptr, lvl level.LEVEL, kvs []kv.Field, msg string) {
+ // Prepend opening JSON brace.
+ buf.B = append(buf.B, `{`...)
+
+ if fmt.TimeFormat != "" {
+ // Append JSON formatted timestamp string.
+ buf.B = append(buf.B, `"timestamp":"`...)
+ fmt.AppendFormatStamp(buf, stamp)
+ buf.B = append(buf.B, `", `...)
+ }
+
+ // Append JSON formatted caller func.
+ buf.B = append(buf.B, `"func":"`...)
+ buf.B = append(buf.B, caller.Get(pc)...)
+ buf.B = append(buf.B, `", `...)
+
+ if lvl != level.UNSET {
+ // Append JSON formatted level string.
+ buf.B = append(buf.B, `"level":"`...)
+ buf.B = append(buf.B, lvl.String()...)
+ buf.B = append(buf.B, `", `...)
+ }
+
+ // Append JSON formatted fields.
+ for _, field := range kvs {
+ appendStringJSON(buf, field.K)
+ buf.B = append(buf.B, `:`...)
+ b, _ := json.Marshal(field.V)
+ buf.B = append(buf.B, b...)
+ buf.B = append(buf.B, `, `...)
+ }
+
+ if msg != "" {
+ // Append JSON formatted msg string.
+ buf.B = append(buf.B, `"msg":`...)
+ appendStringJSON(buf, msg)
+ } else if string(buf.B[len(buf.B)-2:]) == ", " {
+ // Drop the trailing ", ".
+ buf.B = buf.B[:len(buf.B)-2]
+ }
+
+ // Append closing JSON brace.
+ buf.B = append(buf.B, `}`...)
+}
+
+// appendStringJSON is modified from the encoding/json.appendString()
+// function, copied in here such that we can use it for key appending.
+func appendStringJSON(buf *byteutil.Buffer, src string) {
+ const hex = "0123456789abcdef"
+ buf.B = append(buf.B, '"')
+ start := 0
+ for i := 0; i < len(src); {
+ if b := src[i]; b < utf8.RuneSelf {
+ if jsonSafeSet[b] {
+ i++
+ continue
+ }
+ buf.B = append(buf.B, src[start:i]...)
+ switch b {
+ case '\\', '"':
+ buf.B = append(buf.B, '\\', b)
+ case '\b':
+ buf.B = append(buf.B, '\\', 'b')
+ case '\f':
+ buf.B = append(buf.B, '\\', 'f')
+ case '\n':
+ buf.B = append(buf.B, '\\', 'n')
+ case '\r':
+ buf.B = append(buf.B, '\\', 'r')
+ case '\t':
+ buf.B = append(buf.B, '\\', 't')
+ default:
+ // This encodes bytes < 0x20 except for \b, \f, \n, \r and \t.
+ buf.B = append(buf.B, '\\', 'u', '0', '0', hex[b>>4], hex[b&0xF])
+ }
+ i++
+ start = i
+ continue
+ }
+ n := len(src) - i
+ if n > utf8.UTFMax {
+ n = utf8.UTFMax
+ }
+ c, size := utf8.DecodeRuneInString(src[i : i+n])
+ if c == utf8.RuneError && size == 1 {
+ buf.B = append(buf.B, src[start:i]...)
+ buf.B = append(buf.B, `\ufffd`...)
+ i += size
+ start = i
+ continue
+ }
+ // U+2028 is LINE SEPARATOR.
+ // U+2029 is PARAGRAPH SEPARATOR.
+ // They are both technically valid characters in JSON strings,
+ // but don't work in JSONP, which has to be evaluated as JavaScript,
+ // and can lead to security holes there. It is valid JSON to
+ // escape them, so we do so unconditionally.
+ // See https://en.wikipedia.org/wiki/JSON#Safety.
+ if c == '\u2028' || c == '\u2029' {
+ buf.B = append(buf.B, src[start:i]...)
+ buf.B = append(buf.B, '\\', 'u', '2', '0', '2', hex[c&0xF])
+ i += size
+ start = i
+ continue
+ }
+ i += size
+ }
+ buf.B = append(buf.B, src[start:]...)
+ buf.B = append(buf.B, '"')
+}
+
+var jsonSafeSet = [utf8.RuneSelf]bool{
+ ' ': true,
+ '!': true,
+ '"': false,
+ '#': true,
+ '$': true,
+ '%': true,
+ '&': true,
+ '\'': true,
+ '(': true,
+ ')': true,
+ '*': true,
+ '+': true,
+ ',': true,
+ '-': true,
+ '.': true,
+ '/': true,
+ '0': true,
+ '1': true,
+ '2': true,
+ '3': true,
+ '4': true,
+ '5': true,
+ '6': true,
+ '7': true,
+ '8': true,
+ '9': true,
+ ':': true,
+ ';': true,
+ '<': true,
+ '=': true,
+ '>': true,
+ '?': true,
+ '@': true,
+ 'A': true,
+ 'B': true,
+ 'C': true,
+ 'D': true,
+ 'E': true,
+ 'F': true,
+ 'G': true,
+ 'H': true,
+ 'I': true,
+ 'J': true,
+ 'K': true,
+ 'L': true,
+ 'M': true,
+ 'N': true,
+ 'O': true,
+ 'P': true,
+ 'Q': true,
+ 'R': true,
+ 'S': true,
+ 'T': true,
+ 'U': true,
+ 'V': true,
+ 'W': true,
+ 'X': true,
+ 'Y': true,
+ 'Z': true,
+ '[': true,
+ '\\': false,
+ ']': true,
+ '^': true,
+ '_': true,
+ '`': true,
+ 'a': true,
+ 'b': true,
+ 'c': true,
+ 'd': true,
+ 'e': true,
+ 'f': true,
+ 'g': true,
+ 'h': true,
+ 'i': true,
+ 'j': true,
+ 'k': true,
+ 'l': true,
+ 'm': true,
+ 'n': true,
+ 'o': true,
+ 'p': true,
+ 'q': true,
+ 'r': true,
+ 's': true,
+ 't': true,
+ 'u': true,
+ 'v': true,
+ 'w': true,
+ 'x': true,
+ 'y': true,
+ 'z': true,
+ '{': true,
+ '|': true,
+ '}': true,
+ '~': true,
+ '\u007f': true,
+}
diff --git a/internal/log/format/logfmt.go b/internal/log/format/logfmt.go
new file mode 100644
index 000000000..a774be8c9
--- /dev/null
+++ b/internal/log/format/logfmt.go
@@ -0,0 +1,67 @@
+// GoToSocial
+// Copyright (C) GoToSocial Authors admin@gotosocial.org
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+package format
+
+import (
+ "time"
+
+ "code.superseriousbusiness.org/gotosocial/internal/log/level"
+ "codeberg.org/gruf/go-byteutil"
+ "codeberg.org/gruf/go-caller"
+ "codeberg.org/gruf/go-kv/v2"
+ "codeberg.org/gruf/go-kv/v2/format"
+)
+
+var args = format.DefaultArgs()
+
+type Logfmt struct{ Base }
+
+func (fmt *Logfmt) Format(buf *byteutil.Buffer, stamp time.Time, pc uintptr, lvl level.LEVEL, kvs []kv.Field, msg string) {
+ if fmt.TimeFormat != "" {
+ // Append formatted timestamp string.
+ buf.B = append(buf.B, `timestamp="`...)
+ fmt.AppendFormatStamp(buf, stamp)
+ buf.B = append(buf.B, `" `...)
+ }
+
+ // Append formatted calling func.
+ buf.B = append(buf.B, `func=`...)
+ buf.B = append(buf.B, caller.Get(pc)...)
+ buf.B = append(buf.B, ' ')
+
+ if lvl != level.UNSET {
+ // Append formatted level string.
+ buf.B = append(buf.B, `level=`...)
+ buf.B = append(buf.B, lvl.String()...)
+ buf.B = append(buf.B, ' ')
+ }
+
+ // Append formatted fields.
+ for _, field := range kvs {
+ kv.AppendQuoteString(buf, field.K)
+ buf.B = append(buf.B, '=')
+ buf.B = format.Global.Append(buf.B, field.V, args)
+ buf.B = append(buf.B, ' ')
+ }
+
+ if msg != "" {
+ // Append formatted msg string.
+ buf.B = append(buf.B, `msg=`...)
+ kv.AppendQuoteString(buf, msg)
+ }
+}
generated by cgit v1.2.3 (git 2.46.0) at 2025-12-09 17:35:58 +0000