Debug stream set up and logging

Author: MystikalPooka

Assets/Plugins/UniRx/Scripts/UnityEngineBridge/Diagnostics/ObservableDebugExtensions.cs

@@ -16,7 +16,6 @@ public static IObservable<T> Debug<T>(this IObservable<T> source, string label =
                 .Dematerialize()
                 .DoOnCancel(() => UnityEngine.Debug.Log(l + "OnCancel"))
                 .DoOnSubscribe(() => UnityEngine.Debug.Log(l + "OnSubscribe"));
-
 #else
             return source;
 #endif
@@ -33,7 +32,6 @@ public static IObservable<T> Debug<T>(this IObservable<T> source, UniRx.Diagnost
                 .Dematerialize()
                 .DoOnCancel(() => logger.Debug("OnCancel"))
                 .DoOnSubscribe(() => logger.Debug("OnSubscribe"));
-
 #else
             return source;
 #endif

Assets/Scripts/AI/Behavior Logger.meta

@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using UniRx;
+
+namespace Assets.Scripts.AI.Behavior_Logger
+{
+    public static class BehaviorDebugExtensions
+    {
+        public static IObservable<T> Debug<T>(this IObservable<T> source, BehaviorLogger logger)
+        {
+#if DEBUG
+            return source.Materialize()
+                .Do(x => logger.Debug(x.ToString()))
+                .Dematerialize()
+                .DoOnCancel(() => logger.Debug("OnCancel"))
+                .DoOnSubscribe(() => logger.Debug("OnSubscribe"));
+#else
+            return source;
+#endif
+        }
+
+    }
+}

Assets/Scripts/AI/Behavior Logger/BehaviorDebugExtensions.cs

@@ -0,0 +1,60 @@
+using Assets.Scripts.AI;
+using System;
+using System.Collections.Generic;
+using System.Text;
+using UnityEngine;
+
+namespace Assets.Scripts.AI.Behavior_Logger
+{
+    public struct BehaviorLogEntry
+    {
+        // requires
+        public string LoggerName { get; private set; }
+        public LogType LogType { get; private set; }
+        public string Message { get; private set; }
+        public DateTime Timestamp { get; private set; }
+
+        // options
+        /// <summary>
+        /// [Optional] Used to keep track of frames for debugging.
+        /// </summary>
+        public int TickNumber { get; private set; }
+
+        public BehaviorState NewState { get; private set; }
+
+        /// <summary>[Optional]</summary>
+        public BehaviorTreeElement Context { get; private set; }
+        /// <summary>[Optional]</summary>
+        public Exception Exception { get; private set; }
+        /// <summary>[Optional]</summary>
+        public string StackTrace { get; private set; }
+        /// <summary>[Optional]</summary>
+        public object State { get; private set; }
+
+        public BehaviorLogEntry(string loggerName, LogType logType, DateTime timestamp, string message, BehaviorState newState = BehaviorState.Null, int ticknum = -1,
+            BehaviorTreeElement context = null, Exception exception = null, string stackTrace = null, object state = null)
+            : this()
+        {
+            this.LoggerName = loggerName;
+            this.LogType = logType;
+            this.Timestamp = timestamp;
+            this.Message = message;
+            this.NewState = newState;
+            this.TickNumber = ticknum;
+            this.Context = context;
+            this.Exception = exception;
+            this.StackTrace = stackTrace;
+            this.State = state;
+        }
+
+        public override string ToString()
+        {
+            var plusEx = (Exception != null) ? (Environment.NewLine + Exception.ToString()) : "";
+            return "[" + Timestamp.ToString() + "]"
+                + "[" + LoggerName + "]"
+                + "[" + LogType.ToString() + "]"
+                + Message
+                + plusEx;
+        }
+    }
+}

Assets/Scripts/AI/Behavior Logger/BehaviorDebugExtensions.cs.meta

@@ -0,0 +1,140 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using UniRx.Diagnostics;
+using UnityEngine;
+
+namespace Assets.Scripts.AI.Behavior_Logger
+{
+    public partial class BehaviorLogger
+    {
+        static bool isInitialized = false;
+        static bool isDebugBuild = false;
+
+        public string Name { get; private set; }
+        protected readonly Action<BehaviorLogEntry> logPublisher;
+
+        public BehaviorLogger(string loggerName)
+        {
+            this.Name = loggerName;
+            this.logPublisher = ObservableBehaviorLogger.RegisterLogger(this);
+        }
+
+        /// <summary>Output LogType.Log but only enabled if isDebugBuild</summary>
+        public virtual void Debug(object message, BehaviorTreeElement context = null)
+        {
+            if (!isInitialized)
+            {
+                isInitialized = true;
+                isDebugBuild = UnityEngine.Debug.isDebugBuild;
+            }
+
+            if (isDebugBuild)
+            {
+                logPublisher(new BehaviorLogEntry(
+                    message: (message != null) ? message.ToString() : "",
+                    logType: LogType.Log,
+                    timestamp: DateTime.Now,
+                    loggerName: Name,
+                    context: context));
+            }
+        }
+
+        /// <summary>Output LogType.Log but only enables isDebugBuild</summary>
+        public virtual void DebugFormat(string format, params object[] args)
+        {
+            if (!isInitialized)
+            {
+                isInitialized = true;
+                isDebugBuild = UnityEngine.Debug.isDebugBuild;
+            }
+
+            if (isDebugBuild)
+            {
+                logPublisher(new BehaviorLogEntry(
+                    message: (format != null) ? string.Format(format, args) : "",
+                    logType: LogType.Log,
+                    timestamp: DateTime.Now,
+                    loggerName: Name,
+                    context: null));
+            }
+        }
+
+        public virtual void Log(object message, BehaviorTreeElement context = null)
+        {
+            logPublisher(new BehaviorLogEntry(
+                message: (message != null) ? message.ToString() : "",
+                logType: LogType.Log,
+                timestamp: DateTime.Now,
+                loggerName: Name,
+                context: context));
+        }
+
+        public virtual void LogFormat(string format, params object[] args)
+        {
+            logPublisher(new BehaviorLogEntry(
+                message: (format != null) ? string.Format(format, args) : "",
+                logType: LogType.Log,
+                timestamp: DateTime.Now,
+                loggerName: Name,
+                context: null));
+        }
+
+        public virtual void Warning(object message, BehaviorTreeElement context = null)
+        {
+            logPublisher(new BehaviorLogEntry(
+                message: (message != null) ? message.ToString() : "",
+                logType: LogType.Warning,
+                timestamp: DateTime.Now,
+                loggerName: Name,
+                context: context));
+        }
+
+        public virtual void WarningFormat(string format, params object[] args)
+        {
+            logPublisher(new BehaviorLogEntry(
+                message: (format != null) ? string.Format(format, args) : "",
+                logType: LogType.Warning,
+                timestamp: DateTime.Now,
+                loggerName: Name,
+                context: null));
+        }
+
+        public virtual void Error(object message, BehaviorTreeElement context = null)
+        {
+            logPublisher(new BehaviorLogEntry(
+                message: (message != null) ? message.ToString() : "",
+                logType: LogType.Error,
+                timestamp: DateTime.Now,
+                loggerName: Name,
+                context: context));
+        }
+
+        public virtual void ErrorFormat(string format, params object[] args)
+        {
+            logPublisher(new BehaviorLogEntry(
+                message: (format != null) ? string.Format(format, args) : "",
+                logType: LogType.Error,
+                timestamp: DateTime.Now,
+                loggerName: Name,
+                context: null));
+        }
+
+        public virtual void Exception(Exception exception, BehaviorTreeElement context = null)
+        {
+            logPublisher(new BehaviorLogEntry(
+                message: (exception != null) ? exception.ToString() : "",
+                exception: exception,
+                logType: LogType.Exception,
+                timestamp: DateTime.Now,
+                loggerName: Name,
+                context: context));
+        }
+
+        /// <summary>Publish raw LogEntry.</summary>
+        public virtual void Raw(BehaviorLogEntry logEntry)
+        {
+            logPublisher(logEntry);
+        }
+    }
+}

Assets/Scripts/AI/Behavior Logger/BehaviorLogEntry.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using UniRx;
+using UnityEngine;
+
+namespace Assets.Scripts.AI.Behavior_Logger
+{
+    public class ObservableBehaviorLogger : IObservable<BehaviorLogEntry>
+    {
+        static readonly Subject<BehaviorLogEntry> logPublisher = new Subject<BehaviorLogEntry>();
+
+        public static readonly ObservableBehaviorLogger Listener = new ObservableBehaviorLogger();
+
+        private ObservableBehaviorLogger()
+        { }
+
+        public static Action<BehaviorLogEntry> RegisterLogger(BehaviorLogger logger)
+        {
+            if (logger.Name == null) throw new ArgumentNullException("logger.Name is null");
+
+            return logPublisher.OnNext;
+        }
+
+        public IDisposable Subscribe(IObserver<BehaviorLogEntry> observer)
+        {
+            return logPublisher.Subscribe(observer);
+        }
+    }
+}