octoleo/syncthing
1
0
Fork 0
mirror of https://github.com/octoleo/syncthing.git synced 2024-12-22 10:58:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

lib/logger: Reduce API surface (#9404)

Browse Source 
There is no need to expose the IsTraced() thing; it's just used in
initialisation, and thereafter ShouldDebug() is the corresponding
correct call.
This commit is contained in:
Jakob Borg 2024-02-09 11:17:44 +01:00 committed by GitHub
parent 9f6d732587
commit 416b9e8924
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/api/debug.go
View File

@ -10,18 +10,8 @@ import (
"github.com/syncthing/syncthing/lib/logger" "github.com/syncthing/syncthing/lib/logger"
) )
var ( var l = logger.DefaultLogger.NewFacility("api", "REST API")
l = logger.DefaultLogger.NewFacility("api", "REST API")
)
func shouldDebugHTTP() bool { func shouldDebugHTTP() bool {
return l.ShouldDebug("api") return l.ShouldDebug("api")
} }
func init() {
// The debug facility was originally named "http", changed in:
// https://github.com/syncthing/syncthing/pull/5548
if l.IsTraced("http") {
l.SetDebug("api", true)
}
}

9
lib/logger/logger.go
View File

@ -54,7 +54,6 @@ type Logger interface {
Warnf(format string, vals ...interface{}) Warnf(format string, vals ...interface{})
ShouldDebug(facility string) bool ShouldDebug(facility string) bool
SetDebug(facility string, enabled bool) SetDebug(facility string, enabled bool)
IsTraced(facility string) bool
Facilities() map[string]string Facilities() map[string]string
FacilityDebugging() []string FacilityDebugging() []string
NewFacility(facility, description string) Logger NewFacility(facility, description string) Logger
@ -132,6 +131,7 @@ func (l *logger) callHandlers(level LogLevel, s string) {
func (l *logger) Debugln(vals ...interface{}) { func (l *logger) Debugln(vals ...interface{}) {
l.debugln(3, vals...) l.debugln(3, vals...)
} }
func (l *logger) debugln(level int, vals ...interface{}) { func (l *logger) debugln(level int, vals ...interface{}) {
s := fmt.Sprintln(vals...) s := fmt.Sprintln(vals...)
l.mut.Lock() l.mut.Lock()
@ -144,6 +144,7 @@ func (l *logger) debugln(level int, vals ...interface{}) {
func (l *logger) Debugf(format string, vals ...interface{}) { func (l *logger) Debugf(format string, vals ...interface{}) {
l.debugf(3, format, vals...) l.debugf(3, format, vals...)
} }
func (l *logger) debugf(level int, format string, vals ...interface{}) { func (l *logger) debugf(level int, format string, vals ...interface{}) {
s := fmt.Sprintf(format, vals...) s := fmt.Sprintf(format, vals...)
l.mut.Lock() l.mut.Lock()
@ -229,8 +230,8 @@ func (l *logger) SetDebug(facility string, enabled bool) {
} }
} }
// IsTraced returns whether the facility name is contained in STTRACE. // isTraced returns whether the facility name is contained in STTRACE.
func (l *logger) IsTraced(facility string) bool { func (l *logger) isTraced(facility string) bool {
if len(l.traces) > 0 { if len(l.traces) > 0 {
if l.traces[0] == "all" { if l.traces[0] == "all" {
return true return true
@ -269,7 +270,7 @@ func (l *logger) Facilities() map[string]string {
// NewFacility returns a new logger bound to the named facility. // NewFacility returns a new logger bound to the named facility.
func (l *logger) NewFacility(facility, description string) Logger { func (l *logger) NewFacility(facility, description string) Logger {
l.SetDebug(facility, l.IsTraced(facility)) l.SetDebug(facility, l.isTraced(facility))
l.mut.Lock() l.mut.Lock()
l.facilities[facility] = description l.facilities[facility] = description