fix: 优化日志扩展属性

Author: jianxuanbing

framework/src/Bing.Logging.Sinks.Exceptionless/Serilog/Sinks/Exceptionless/ExceptionlessSink.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Bing;
+using Bing.Logging.ExtraSupports;
 using Bing.Logging.Sinks.Exceptionless.Internals;
 using Exceptionless;
 using Exceptionless.Dependency;
@@ -130,10 +132,20 @@ public void Emit(LogEvent logEvent)
                                 builder.SetUserDescription(emailAddress, description);
                             break;
                         case "Tags" when  property.Value is SequenceValue tags:
-                            var tagList = tags.FlattenProperties() as List<object>;
-                            if(tagList is null)
-                                continue;
-                            builder.AddTags(tagList.Select(x=>x.ToString()).ToArray());
+                            {
+                                var tagList = tags.FlattenProperties() as List<object>;
+                                if (tagList is null)
+                                    continue;
+                                builder.AddTags(tagList.Select(x => x.ToString()).ToArray());
+                            }
+                            break;
+                        case ContextDataTypes.Tags when property.Value is SequenceValue tags:
+                            {
+                                var tagList = tags.FlattenProperties() as List<object>;
+                                if (tagList is null)
+                                    continue;
+                                builder.AddTags(tagList.Select(x => x.ToString()).ToArray());
+                            }
                             break;
                         default:
                             builder.SetProperty(property.Key, property.Value.FlattenProperties());

framework/src/Bing.Logging/Bing/Logging/Core/LogEventContext.cs

@@ -0,0 +1,129 @@
+using System.Collections.Generic;
+using System.Linq;
+using Bing.Logging.ExtraSupports;
+
+namespace Bing.Logging.Core
+{
+    /// <summary>
+    /// 日志事件上下文
+    /// </summary>
+    public class LogEventContext
+    {
+        #region Tags(标签列表)
+
+        /// <summary>
+        /// 标签列表
+        /// </summary>
+        private readonly List<string> _tags = new List<string>();
+
+        /// <summary>
+        /// 标签列表
+        /// </summary>
+        internal IReadOnlyList<string> Tags => _tags;
+
+        /// <summary>
+        /// 设置标签列表
+        /// </summary>
+        /// <param name="tags">标签列表</param>
+        public LogEventContext SetTags(params string[] tags)
+        {
+            if (tags == null)
+                return this;
+            foreach (var tag in tags)
+            {
+                if (string.IsNullOrWhiteSpace(tag))
+                    continue;
+                if (_tags.Contains(tag))
+                    continue;
+                _tags.Add(tag);
+            }
+            return this;
+        }
+
+        #endregion
+
+        #region Parameters(参数列表)
+
+        /// <summary>
+        /// 参数列表
+        /// </summary>
+        private readonly List<object> _parameters = new List<object>();
+
+        /// <summary>
+        /// 设置参数
+        /// </summary>
+        /// <param name="parameter">参数</param>
+        public LogEventContext SetParameter(object parameter)
+        {
+            if (parameter == null)
+                return this;
+            _parameters.Add(parameter);
+            return this;
+        }
+
+        /// <summary>
+        /// 设置参数列表
+        /// </summary>
+        /// <param name="parameters">参数列表</param>
+        public LogEventContext SetParameters(params object[] parameters)
+        {
+            foreach (var parameter in parameters)
+                SetParameter(parameter);
+            return this;
+        }
+
+        /// <summary>
+        /// 参数列表
+        /// </summary>
+        internal IReadOnlyList<object> Parameters => _parameters;
+
+        #endregion
+
+        #region ExtraProperties(扩展属性)
+
+        /// <summary>
+        /// 扩展属性
+        /// </summary>
+        private readonly ContextData _extraProperties = new ContextData();
+
+        /// <summary>
+        /// 设置扩展属性
+        /// </summary>
+        /// <param name="name">名称</param>
+        /// <param name="value">值</param>
+        public LogEventContext SetExtraProperty(string name, object value)
+        {
+            if (string.IsNullOrWhiteSpace(name))
+                return this;
+            _extraProperties.AddOrUpdateItem($"{ContextDataTypes.ExtraProperty}_{name}", value, false);
+            return this;
+        }
+
+        /// <summary>
+        /// 扩展属性
+        /// </summary>
+        public ContextData ExtraProperties => _extraProperties;
+
+        #endregion
+
+        #region ExposeScopeState(公开作用域状态)
+
+        /// <summary>
+        /// 公开作用域状态
+        /// </summary>
+        public IDictionary<string, object> ExposeScopeState()
+        {
+            var dict = new Dictionary<string, object>();
+            if (Tags.Any()) 
+                dict[ContextDataTypes.Tags] = Tags;
+            if (ExtraProperties.Any())
+            {
+                foreach (var kvp in ExtraProperties) 
+                    dict.Add(kvp.Key, kvp.Value.Value);
+            }
+            return dict;
+        }
+
+        #endregion
+    }
+}

framework/src/Bing.Logging/Bing/Logging/Core/LogEventDescriptor.cs

@@ -0,0 +1,21 @@
+namespace Bing.Logging.Core
+{
+    /// <summary>
+    /// 日志事件描述符
+    /// </summary>
+    public class LogEventDescriptor
+    {
+        /// <summary>
+        /// 初始化一个<see cref="LogEventDescriptor"/>类型的实例
+        /// </summary>
+        public LogEventDescriptor()
+        {
+            Context = new LogEventContext();
+        }
+
+        /// <summary>
+        /// 日志事件上下文
+        /// </summary>
+        public LogEventContext Context { get; }
+    }
+}

framework/src/Bing.Logging/Bing/Logging/ExtraSupports/ContextData.cs

@@ -0,0 +1,121 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Bing.Logging.ExtraSupports
+{
+    /// <summary>
+    /// 日志事件上下文数据
+    /// </summary>
+    public class ContextData : Dictionary<string, ContextDataItem>
+    {
+        /// <summary>
+        /// 初始化一个<see cref="ContextData"/>类型的实例
+        /// </summary>
+        public ContextData() : base(StringComparer.OrdinalIgnoreCase) { }
+
+        /// <summary>
+        /// 初始化一个<see cref="ContextData"/>类型的实例
+        /// </summary>
+        /// <param name="ctx">字典</param>
+        public ContextData(IDictionary<string, ContextDataItem> ctx) : base(ctx, StringComparer.OrdinalIgnoreCase) { }
+
+        /// <summary>
+        /// 添加项
+        /// </summary>
+        /// <param name="name">名称</param>
+        /// <param name="value">值</param>
+        /// <param name="output">是否输出</param>
+        /// <exception cref="ArgumentNullException"></exception>
+        public void AddItem(string name, object value, bool output = true)
+        {
+            if (ContainsKey(name))
+                throw new ArgumentException($"Key '{name}' has been added.", nameof(name));
+            if (value is ContextDataItem item)
+                Add(item.Name, item);
+            else
+                Add(name, new ContextDataItem(name, value.GetType(), value, output));
+        }
+
+        /// <summary>
+        /// 添加或更新项
+        /// </summary>
+        /// <param name="name">名称</param>
+        /// <param name="value">值</param>
+        /// <param name="output">是否输出</param>
+        public void AddOrUpdateItem(string name, object value, bool output = true)
+        {
+            if (value is ContextDataItem item)
+                AddOrUpdateInternal(item.Name, item);
+            else
+                AddOrUpdateInternal(name, new ContextDataItem(name, value.GetType(), value, output));
+        }
+
+        /// <summary>
+        /// 添加或更新
+        /// </summary>
+        /// <param name="name">名称</param>
+        /// <param name="item">项</param>
+        private void AddOrUpdateInternal(string name, ContextDataItem item)
+        {
+            if (ContainsKey(name))
+                this[name] = item;
+            else
+                Add(name, item);
+        }
+
+        /// <summary>
+        /// 当前上游上下文数据的指针
+        /// </summary>
+        private ContextData CurrentUpstreamContextPointer { get; set; }
+
+        /// <summary>
+        /// 导入上游的上下文数据
+        /// </summary>
+        /// <param name="contextData">日志事件上下文数据</param>
+        internal void ImportUpstreamContextData(ContextData contextData)
+        {
+            if (contextData == null)
+                return;
+            CurrentUpstreamContextPointer = contextData;
+            foreach (var data in contextData)
+            {
+                if (ContainsKey(data.Key))
+                    continue;
+                Add(data.Key, data.Value);
+            }
+        }
+
+        /// <summary>
+        /// 导出上游的上下文数据
+        /// </summary>
+        internal ContextData ExportUpstreamContextData() => CurrentUpstreamContextPointer;
+
+        /// <summary>
+        /// 输出字符串
+        /// </summary>
+        public override string ToString()
+        {
+            if (Count == 0)
+                return string.Empty;
+            var sb = new StringBuilder();
+            var fen = "";
+            sb.Append("[");
+            foreach (var item in this)
+            {
+                if (!item.Value.Output)
+                    continue;
+                sb.Append(fen);
+                fen = ",";
+                sb.Append($"{{\"{item.Key}\":\"{item.Value}\"}}");
+            }
+            sb.Append("]");
+            return sb.ToString();
+        }
+
+        /// <summary>
+        /// 克隆
+        /// </summary>
+        public ContextData Copy() => new(this);
+    }
+}

framework/src/Bing.Logging/Bing/Logging/ExtraSupports/ContextDataItem.cs

@@ -0,0 +1,58 @@
+using System;
+using System.Text;
+
+namespace Bing.Logging.ExtraSupports
+{
+    /// <summary>
+    /// 日志事件上下文数据项
+    /// </summary>
+    public class ContextDataItem
+    {
+        /// <summary>
+        /// 初始化一个<see cref="ContextDataItem"/>类型的实例
+        /// </summary>
+        /// <param name="name">名称</param>
+        /// <param name="type">类型</param>
+        /// <param name="value">值</param>
+        /// <param name="output">是否输出</param>
+        public ContextDataItem(string name, Type type, object value, bool output = true)
+        {
+            ItemType = type;
+            Value = value;
+            Name = name;
+            Output = output;
+        }
+
+        /// <summary>
+        /// 名称
+        /// </summary>
+        public string Name { get; }
+
+        /// <summary>
+        /// 类型
+        /// </summary>
+        public Type ItemType { get; }
+
+        /// <summary>
+        /// 值
+        /// </summary>
+        public object Value { get; }
+
+        /// <summary>
+        /// 是否输出
+        /// </summary>
+        public bool Output { get; }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            var sb = new StringBuilder();
+            sb.Append("{");
+            sb.Append($"\"Name\":\"{Name}\",");
+            sb.Append($"\"Type\":\"{ItemType}\",");
+            sb.Append($"\"Value\":\"{Value}\"");
+            sb.Append("}");
+            return sb.ToString();
+        }
+    }
+}

framework/src/Bing.Logging/Bing/Logging/ExtraSupports/ContextDataTypes.cs

@@ -0,0 +1,18 @@
+namespace Bing.Logging.ExtraSupports
+{
+    /// <summary>
+    /// 日志事件上下文数据类型
+    /// </summary>
+    public class ContextDataTypes
+    {
+        /// <summary>
+        /// 扩展属性
+        /// </summary>
+        public const string ExtraProperty = "__BING_EXTRA_PROPERTY";
+
+        /// <summary>
+        /// 扩展属性
+        /// </summary>
+        public const string Tags = "__BING_TAGS";
+    }
+}