[chore] use our own logging implementation (#716)

* first commit Signed-off-by: kim <grufwub@gmail.com> * replace logging with our own log library Signed-off-by: kim <grufwub@gmail.com> * fix imports Signed-off-by: kim <grufwub@gmail.com> * fix log imports Signed-off-by: kim <grufwub@gmail.com> * add license text Signed-off-by: kim <grufwub@gmail.com> * fix package import cycle between config and log package Signed-off-by: kim <grufwub@gmail.com> * fix empty kv.Fields{} being passed to WithFields() Signed-off-by: kim <grufwub@gmail.com> * fix uses of log.WithFields() with whitespace issues and empty slices Signed-off-by: kim <grufwub@gmail.com> * *linter related grumbling* Signed-off-by: kim <grufwub@gmail.com> * gofmt the codebase! also fix more log.WithFields() formatting issues Signed-off-by: kim <grufwub@gmail.com> * update testrig code to match new changes Signed-off-by: kim <grufwub@gmail.com> * fix error wrapping in non fmt.Errorf function Signed-off-by: kim <grufwub@gmail.com> * add benchmarking of log.Caller() vs non-cached Signed-off-by: kim <grufwub@gmail.com> * fix syslog tests, add standard build tags to test runner to ensure consistency Signed-off-by: kim <grufwub@gmail.com> * make syslog tests more robust Signed-off-by: kim <grufwub@gmail.com> * fix caller depth arithmatic (is that how you spell it?) Signed-off-by: kim <grufwub@gmail.com> * update to use unkeyed fields in kv.Field{} instances Signed-off-by: kim <grufwub@gmail.com> * update go-kv library Signed-off-by: kim <grufwub@gmail.com> * update libraries list Signed-off-by: kim <grufwub@gmail.com> * fuck you linter get nerfed Signed-off-by: kim <grufwub@gmail.com> Co-authored-by: tobi <31960611+tsmethurst@users.noreply.github.com>
2025-06-05 21:59:39 +02:00 · 2022-07-19 09:47:55 +01:00
parent 59be7466f3
commit 098dbe6ff4
141 changed files with 3046 additions and 997 deletions
--- a/internal/log/caller.go
+++ b/internal/log/caller.go
@@ -0,0 +1,89 @@
+/*
+   GoToSocial
+   Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org
+
+   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 log
+
+import (
+	"runtime"
+	"strings"
+	"sync"
+)
+
+var (
+	// fnCache is a cache of PCs to their calculated function names.
+	fnCache = map[uintptr]string{}
+
+	// strCache is a cache of strings to the originally allocated version
+	// of that string contents. so we don't have hundreds of the same instances
+	// of string floating around in memory.
+	strCache = map[string]string{}
+
+	// cacheMu protects fnCache and strCache.
+	cacheMu sync.Mutex
+)
+
+// Caller fetches the calling function name, skipping 'depth'. Results are cached per PC.
+func Caller(depth int) string {
+	var rpc [1]uintptr
+
+	// Fetch pcs of callers
+	n := runtime.Callers(depth, rpc[:])
+
+	if n > 0 {
+		// Look for value in cache
+		cacheMu.Lock()
+		fn, ok := fnCache[rpc[0]]
+		cacheMu.Unlock()
+
+		if ok {
+			return fn
+		}
+
+		// Fetch frame info for caller pc
+		frame, _ := runtime.CallersFrames(rpc[:]).Next()
+
+		if frame.PC != 0 {
+			name := frame.Function
+
+			// Drop all but the package name and function name, no mod path
+			if idx := strings.LastIndex(name, "/"); idx >= 0 {
+				name = name[idx+1:]
+			}
+
+			// Drop any generic type parameter markers
+			if idx := strings.Index(name, "[...]"); idx >= 0 {
+				name = name[:idx] + name[idx+5:]
+			}
+
+			// Cache this func name
+			cacheMu.Lock()
+			fn, ok := strCache[name]
+			if !ok {
+				// Cache ptr to this allocated str
+				strCache[name] = name
+				fn = name
+			}
+			fnCache[rpc[0]] = fn
+			cacheMu.Unlock()
+
+			return fn
+		}
+	}
+
+	return "???"
+}