Improve UI logging

stashapp · Apr 27, 2023 · 57a4978 · 57a4978
1 parent 55d3dee
commit 57a4978
Show file tree

Hide file tree

Showing 12 changed files with 306 additions and 114 deletions.
diff --git a/graphql/documents/queries/misc.graphql b/graphql/documents/queries/misc.graphql
@@ -53,8 +53,8 @@ query Stats {
   }
 }
 
-query Logs {
-  logs {
+query Logs($minLevel: LogLevel) {
+  logs(minLevel: $minLevel) {
     ...LogEntryData
   }
 }

diff --git a/graphql/documents/subscriptions.graphql b/graphql/documents/subscriptions.graphql
@@ -11,12 +11,12 @@ subscription JobsSubscribe {
   }
 }
 
-subscription LoggingSubscribe {
-  loggingSubscribe {
+subscription LoggingSubscribe($minLevel: LogLevel) {
+  loggingSubscribe(minLevel: $minLevel) {
     ...LogEntryData
   }
 }
 
 subscription ScanCompleteSubscribe {
   scanCompleteSubscribe
-}
+}
diff --git a/graphql/schema/schema.graphql b/graphql/schema/schema.graphql
@@ -63,7 +63,11 @@ type Query {
   """Organize scene markers by tag for a given scene ID"""
   sceneMarkerTags(scene_id: ID!): [SceneMarkerTag!]!
 
-  logs: [LogEntry!]!
+  """"Retrieve server log messages"""
+  logs(
+    """Specifies minimum LogLevel of messages to return. Returns all messages if omitted."""
+    minLevel: LogLevel
+  ): [LogEntry!]!
 
   # Scrapers
 
@@ -344,7 +348,11 @@ type Subscription {
   """Update from the metadata manager"""
   jobsSubscribe: JobStatusUpdate!
 
-  loggingSubscribe: [LogEntry!]!
+  """"Subscription to receive server log messages"""
+  loggingSubscribe(
+    """Specifies minimum LogLevel of messages to return. Returns all messages if omitted."""
+    minLevel: LogLevel
+  ): [LogEntry!]!
 
   scanCompleteSubscribe: Boolean!
 }

diff --git a/graphql/schema/types/logging.graphql b/graphql/schema/types/logging.graphql
@@ -2,10 +2,10 @@
 scalar Time
 
 enum LogLevel {
+    Progress
     Trace
     Debug
     Info
-    Progress
     Warning
     Error
 }
@@ -14,4 +14,4 @@ type LogEntry {
   time: Time!
   level: LogLevel!
   message: String!
-}
+}
diff --git a/internal/api/resolver_query_logs.go b/internal/api/resolver_query_logs.go
@@ -4,11 +4,17 @@ import (
 	"context"
 
 	"github.com/stashapp/stash/internal/manager"
+	"github.com/stashapp/stash/pkg/models"
 )
 
-func (r *queryResolver) Logs(ctx context.Context) ([]*LogEntry, error) {
+func (r *queryResolver) Logs(ctx context.Context, minLevel *models.LogLevel) ([]*LogEntry, error) {
 	logger := manager.GetInstance().Logger
-	logCache := logger.GetLogCache()
+	level := ""
+	if minLevel != nil {
+		level = minLevel.String()
+	}
+	logCache := logger.GetLogCache(level)
+
 	ret := make([]*LogEntry, len(logCache))
 
 	for i, entry := range logCache {

diff --git a/internal/api/resolver_subscription_logging.go b/internal/api/resolver_subscription_logging.go
@@ -5,42 +5,47 @@ import (
 
 	"github.com/stashapp/stash/internal/log"
 	"github.com/stashapp/stash/internal/manager"
+	"github.com/stashapp/stash/pkg/models"
 )
 
-func getLogLevel(logType string) LogLevel {
+func getLogLevel(logType string) models.LogLevel {
 	switch logType {
 	case "progress":
-		return LogLevelProgress
+		return models.LogLevelProgress
 	case "trace":
-		return LogLevelTrace
+		return models.LogLevelTrace
 	case "debug":
-		return LogLevelDebug
+		return models.LogLevelDebug
 	case "info":
-		return LogLevelInfo
+		return models.LogLevelInfo
 	case "warn":
-		return LogLevelWarning
+		return models.LogLevelWarning
 	case "error":
-		return LogLevelError
+		return models.LogLevelError
 	default:
-		return LogLevelDebug
+		return models.LogLevelDebug
 	}
 }
 
-func logEntriesFromLogItems(logItems []log.LogItem) []*LogEntry {
-	ret := make([]*LogEntry, len(logItems))
+func logEntriesFromLogItems(logItems []log.LogItem, minLevel *models.LogLevel) []*LogEntry {
+	ret := make([]*LogEntry, 0, len(logItems))
 
-	for i, entry := range logItems {
-		ret[i] = &LogEntry{
+	for _, entry := range logItems {
+		level := getLogLevel(entry.Type)
+		if minLevel != nil && level < *minLevel {
+			continue
+		}
+		ret = append(ret, &LogEntry{
 			Time:    entry.Time,
-			Level:   getLogLevel(entry.Type),
+			Level:   level,
 			Message: entry.Message,
-		}
+		})
 	}
 
 	return ret
 }
 
-func (r *subscriptionResolver) LoggingSubscribe(ctx context.Context) (<-chan []*LogEntry, error) {
+func (r *subscriptionResolver) LoggingSubscribe(ctx context.Context, minLevel *models.LogLevel) (<-chan []*LogEntry, error) {
 	ret := make(chan []*LogEntry, 100)
 	stop := make(chan int, 1)
 	logger := manager.GetInstance().Logger
@@ -50,7 +55,7 @@ func (r *subscriptionResolver) LoggingSubscribe(ctx context.Context) (<-chan []*
 		for {
 			select {
 			case logEntries := <-logSub:
-				ret <- logEntriesFromLogItems(logEntries)
+				ret <- logEntriesFromLogItems(logEntries, minLevel)
 			case <-ctx.Done():
 				stop <- 0
 				close(ret)