Skip to content

Take control over your live stream video by running it yourself. Streaming + chat out of the box.

fix(logging): make admin logs actionable

Gabe Kangas21a174fffe48
diff --git a/services/activitypub/outbox/ticker.go b/services/activitypub/outbox/ticker.go
index abc18ad16d..c0e34875e8 100644
--- a/services/activitypub/outbox/ticker.go
+++ b/services/activitypub/outbox/ticker.go
@@ -41,7 +41,7 @@ func (s *Service) StartStreamPingTicker() {
}
}()
- log.Infoln("Started stream ping ticker (5 minute interval)")
+ log.Debugln("Started stream ping ticker (5 minute interval)")
}
// StopStreamPingTicker stops the stream ping ticker if it is running.
@@ -54,6 +54,6 @@ func (s *Service) StopStreamPingTicker() {
close(s.pingTickerDone)
s.pingTicker = nil
s.pingTickerDone = nil
- log.Infoln("Stopped stream ping ticker")
+ log.Debugln("Stopped stream ping ticker")
}
}
diff --git a/services/activitypub/outbox/ticker_test.go b/services/activitypub/outbox/ticker_test.go
index d3c6314851..edeca5b40e 100644
--- a/services/activitypub/outbox/ticker_test.go
+++ b/services/activitypub/outbox/ticker_test.go
@@ -1,11 +1,22 @@
package outbox
import (
+ "strings"
"testing"
"time"
+
+ log "github.com/sirupsen/logrus"
+ logtest "github.com/sirupsen/logrus/hooks/test"
)
func TestStartStopPingTicker(t *testing.T) {
+ originalLevel := log.GetLevel()
+ log.SetLevel(log.DebugLevel)
+ defer log.SetLevel(originalLevel)
+
+ hook := logtest.NewGlobal()
+ defer hook.Reset()
+
s := &Service{}
// Test that ticker starts
@@ -33,6 +44,19 @@ func TestStartStopPingTicker(t *testing.T) {
// Test that stop on already stopped ticker doesn't panic
s.StopStreamPingTicker()
+
+ var tickerLogs int
+ for _, entry := range hook.AllEntries() {
+ if strings.Contains(strings.ToLower(entry.Message), "stream ping ticker") {
+ tickerLogs++
+ if entry.Level != log.DebugLevel {
+ t.Errorf("ticker log %q level = %s, want debug", entry.Message, entry.Level)
+ }
+ }
+ }
+ if tickerLogs != 3 {
+ t.Errorf("ticker log count = %d, want 3", tickerLogs)
+ }
}
func TestPingTickerThreadSafety(t *testing.T) {
diff --git a/services/activitypub/workerpool/outbound.go b/services/activitypub/workerpool/outbound.go
index 7e78723a3b..58c80d6c4f 100644
--- a/services/activitypub/workerpool/outbound.go
+++ b/services/activitypub/workerpool/outbound.go
@@ -163,7 +163,7 @@ func (s *Service) recordDomainFailure(domain string) {
backoffDuration := circuitBreakerBackoffDurations[backoffIndex]
failure.backoffUntil = time.Now().Add(backoffDuration)
- log.Warnf("Domain %s failed %d times, backing off for %v", domain, failure.count, backoffDuration)
+ log.Debugf("Domain %s failed %d times, backing off for %v", domain, failure.count, backoffDuration)
}
func (s *Service) resetDomainFailure(domain string) {
diff --git a/services/activitypub/workerpool/outbound_test.go b/services/activitypub/workerpool/outbound_test.go
index 4a8d0a698c..b23d75cf10 100644
--- a/services/activitypub/workerpool/outbound_test.go
+++ b/services/activitypub/workerpool/outbound_test.go
@@ -1,8 +1,12 @@
package workerpool
import (
+ "strings"
"testing"
"time"
+
+ log "github.com/sirupsen/logrus"
+ logtest "github.com/sirupsen/logrus/hooks/test"
)
func newTestService() *Service {
@@ -10,6 +14,13 @@ func newTestService() *Service {
}
func TestCircuitBreaker(t *testing.T) {
+ originalLevel := log.GetLevel()
+ log.SetLevel(log.DebugLevel)
+ defer log.SetLevel(originalLevel)
+
+ hook := logtest.NewGlobal()
+ defer hook.Reset()
+
s := newTestService()
testDomain := "failing.example.com"
@@ -34,6 +45,18 @@ func TestCircuitBreaker(t *testing.T) {
if s.ShouldSkipDomain(testDomain) {
t.Error("Domain should not be skipped after reset")
}
+ var backoffLogs int
+ for _, entry := range hook.AllEntries() {
+ if strings.Contains(entry.Message, "backing off") {
+ backoffLogs++
+ if entry.Level != log.DebugLevel {
+ t.Errorf("backoff log %q level = %s, want debug", entry.Message, entry.Level)
+ }
+ }
+ }
+ if backoffLogs != 3 {
+ t.Errorf("backoff log count = %d, want 3", backoffLogs)
+ }
}
func TestHTTPTimeouts(t *testing.T) {
diff --git a/webserver/handlers/admin/federatedservers.go b/webserver/handlers/admin/federatedservers.go
index 4c33925baa..737a45957d 100644
--- a/webserver/handlers/admin/federatedservers.go
+++ b/webserver/handlers/admin/federatedservers.go
@@ -182,7 +182,7 @@ func (a *Admin) AddFederatedServer(w http.ResponseWriter, r *http.Request) {
return
}
- log.Infof("Sent follow request to federated server: %s", serverURL.String())
+ log.Debugf("Sent follow request to federated server: %s", serverURL.String())
webutils.WriteSimpleResponse(w, true, "Follow request sent successfully. The server will appear in your list once they accept the follow.")
}
diff --git a/webserver/router/middleware/auth.go b/webserver/router/middleware/auth.go
index 87d0648103..ba5e26e670 100644
--- a/webserver/router/middleware/auth.go
+++ b/webserver/router/middleware/auth.go
@@ -86,6 +86,16 @@ func accessDenied(w http.ResponseWriter) {
w.Write([]byte("unauthorized")) //nolint
}
+func logInvalidAccessToken(r *http.Request, scope string) {
+ log.Warnf(
+ "Invalid access token from %s for %s %s (required scope: %s)",
+ utils.GetIPAddressFromRequest(r),
+ r.Method,
+ r.URL.Path,
+ scope,
+ )
+}
+
// RequireExternalAPIAccessToken will validate a 3rd party access token.
func (m *Middleware) RequireExternalAPIAccessToken(scope string, handler ExternalAccessTokenHandlerFunc) http.HandlerFunc {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@@ -104,13 +114,14 @@ func (m *Middleware) RequireExternalAPIAccessToken(scope string, handler Externa
}
if token == "" {
- log.Warnln("invalid access token")
+ logInvalidAccessToken(r, scope)
accessDenied(w)
return
}
integration, err := m.userRepository.GetExternalAPIUserForAccessTokenAndScope(token, scope)
if integration == nil || err != nil {
+ logInvalidAccessToken(r, scope)
accessDenied(w)
return
}
diff --git a/webserver/router/middleware/auth_test.go b/webserver/router/middleware/auth_test.go
new file mode 100644
index 0000000000..1cd6204a29
--- /dev/null
+++ b/webserver/router/middleware/auth_test.go
@@ -0,0 +1,33 @@
+package middleware
+
+import (
+ "net/http/httptest"
+ "strings"
+ "testing"
+
+ logtest "github.com/sirupsen/logrus/hooks/test"
+)
+
+func TestInvalidAccessTokenLogIncludesRequestContext(t *testing.T) {
+ hook := logtest.NewGlobal()
+ defer hook.Reset()
+
+ req := httptest.NewRequest("POST", "http://owncast.test/api/integrations/chat?ignored=true", nil)
+ req.RemoteAddr = "203.0.113.10:1234"
+ req.Header.Set("Authorization", "Bearer secret-token")
+
+ logInvalidAccessToken(req, "CAN_SEND_MESSAGES")
+
+ entry := hook.LastEntry()
+ if entry == nil {
+ t.Fatal("expected an invalid access token log entry")
+ }
+ for _, value := range []string{"203.0.113.10", "POST", "/api/integrations/chat", "CAN_SEND_MESSAGES"} {
+ if !strings.Contains(entry.Message, value) {
+ t.Errorf("log entry %q does not include %q", entry.Message, value)
+ }
+ }
+ if strings.Contains(entry.Message, "secret-token") || strings.Contains(entry.Message, "ignored=true") {
+ t.Errorf("log entry includes sensitive request data: %q", entry.Message)
+ }
+}