点击或拖拽改变大小

LogNetBase 类

日志存储类的基类,提供一些基础的服务
继承层次
SystemObject
  HslCommunication.LogNetLogNetBase
    HslCommunication.LogNetLogNetSingle
    HslCommunication.LogNetLogPathBase

命名空间:  HslCommunication.LogNet
程序集:  HslCommunication (在 HslCommunication.dll 中) 版本:12.1.2.0 (12.1.2.0)
语法
public abstract class LogNetBase : IDisposable

LogNetBase 类型公开以下成员。

构造函数
  名称说明
公共方法LogNetBase
实例化一个日志对象
Instantiate a log object
Top
属性
  名称说明
公共属性ConsoleOutput
获取或设置当前的日志信息在存储的时候是否在控制台进行输出,默认不输出。
Gets or sets whether the current log information is output on the console when it is stored. It is not output by default.
公共属性HourDeviation
获取或设置当前日志时间的小时偏差信息,用来解决某些情况下时区设置异常导致记录时间一直不正确的问题,默认为 0,也就是不处理。可以为正数,也可以为负数。
Obtain or set the hourly deviation information of the current log time to solve the problem that the recording time has been incorrect due to abnormal time zone setting in some cases, and the default is 0, that is, it is not processed. Can be positive or negative.
公共属性LogNetStatistics
获取或设置当前的日志记录统计信息,如果你需要统计最近30天的日志,就需要对其实例化,详细参照LogStatistics
Get or set the current log record statistics. If you need to count the logs of the last 30 days, you need to instantiate it. For details, please refer to LogStatistics
公共属性LogSaveMode
日志存储模式,1:单文件,2:按大小存储,3:按时间存储
Log storage mode, 1: single file, 2: storage by size, 3: storage by time
公共属性LogStxAsciiCode
获取或设置在记录文件日志的时候,是否记录不可见字符STX(也即是ASCII字符集的0x02)。默认为 True, 也即是记录这个字符,在日志分析的时候,可以更加方便的分析。
Gets or sets whether to record the invisible character STX (that is, 0x02 of the ASCII character set) when recording the file log. The default is True, that is, this character is recorded, which can be analyzed more conveniently during log analysis.
公共属性LogThreadID
获取或设置是否记录线程ID的数据信息,默认为 True,表示记录,否则,需要设置为 False
Get or set whether to record the data information of the thread ID, the default is True, which means record, otherwise, it needs to be set to False
Top
方法
  名称说明
公共方法Dispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
受保护的方法Dispose(Boolean)
释放资源
公共方法Equals
Determines whether the specified object is equal to the current object.
(继承自 Object。)
公共方法FiltrateKeyword
过滤掉指定的关键字的日志,该信息不存储,但仍然触发BeforeSaveToFile事件
Filter out the logs of the specified keywords, the information is not stored, but the BeforeSaveToFile event is still triggered
受保护的方法Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(继承自 Object。)
受保护的方法GetFileSaveName
公共方法GetHashCode
Serves as the default hash function.
(继承自 Object。)
公共方法GetType
Gets the Type of the current instance.
(继承自 Object。)
受保护的方法HslMessageFormat
根据需要存储的日志消息,获取实际存储的字符串,重写本方法就可以自定义输出内容
According to the log message that needs to be stored, get the actual stored string, and the rewrite method can customize the output content
受保护的方法MemberwiseClone
Creates a shallow copy of the current Object.
(继承自 Object。)
受保护的方法OnWriteCompleted
当写入文件完成的时候触发,这时候已经释放了文件的句柄了。
Triggered when writing to the file is complete, and the file handle has been released.
公共方法RecordMessage
通过指定消息等级,关键字,日志信息进行消息记录
Record messages by specifying message level, keywords, and log information
公共方法RemoveFiltrate
移除过滤的关键字存储
Remove filtered keyword storage
公共方法SetMessageDegree
设置日志的存储等级,高于该等级的才会被存储
Set the storage level of the logs. Only the logs above this level will be stored.
公共方法ToString
Returns a string that represents the current object.
(重写 ObjectToString.)
公共方法WriteAnyString
写入任意字符串
Write arbitrary string
公共方法WriteDebug(String)
写入一条调试日志
Write a debug log
公共方法WriteDebug(String, String)
写入一条带关键字的调试日志
Write a debug log with keywords
公共方法WriteDescrition
写入一条解释性的信息,不属于消息等级控制的范畴
Write an explanatory message that is not part of message level control
公共方法WriteError(String)
写入一条错误日志
Write an error log
公共方法WriteError(String, String)
写入一条带关键字的错误日志
Write an error log with keywords
公共方法WriteException(String, Exception)
写入一条带关键字的异常信息
Write an exception log with keywords
公共方法WriteException(String, String, Exception)
写入一条带关键字和描述信息的异常信息
Write an exception log with keywords and text
公共方法WriteFatal(String)
写入一条致命日志
Write an fatal log
公共方法WriteFatal(String, String)
写入一条带关键字的致命日志
Write an fatal log with keywords
公共方法WriteInfo(String)
写入一条普通日志
Write an infomation log
公共方法WriteInfo(String, String)
写入一条带关键字的普通日志
Write an information log with keywords
公共方法WriteNewLine
写入一行换行符
Write a newline
公共方法WriteWarn(String)
写入一条警告日志
Write an warn log
公共方法WriteWarn(String, String)
写入一条带关键字的警告日志
Write an warn log with keywords
Top
事件
  名称说明
公共事件BeforeSaveToFile
存储之前引发的事件,允许额外的操作,比如打印控制台,存储数据库等等
Store previously raised events, allowing additional operations, such as print console, store database, etc.
Top
字段
  名称说明
受保护的字段m_fileSaveLock
文件存储的锁
Top
扩展方法
  名称说明
公共扩展器方法ToJsonString
获取当前对象的JSON格式表示的字符串。
Gets the string represented by the JSON format of the current object.
(由 HslExtension 定义。)
Top
备注
基于此类可以实现任意的规则的日志存储规则,欢迎大家补充实现,本组件实现了3个日志类
  1. 单文件日志类 LogNetSingle
  2. 根据文件大小的类 LogNetFileSize
  3. 根据时间进行存储的类 LogNetDateTime
参见