使用chrome控制臺作為.Net的日志查看器
很多時候,我們需要查看日志的實時輸出,這個時候往往只能選擇控制臺。我這里的日志框架是serilog,它有一個好處是控制臺輸出時可以高亮的形式顯示其參數結構信息,如下圖所示
但也存在許多不方便的地方:
清屏不方便
回看歷史不方便
日志過濾不方便
消息不便復制出來保持
復雜的消息不便查看
因此我也一直在找一個更理想的日志查看器,找了許多現成的日志查看器,都不甚理想。要是自己寫一個的話,結構化日志的輸出也是比較麻煩的,工作量太大。
最后將目標選定在了Chrome控制臺上,找了一下chrome 控制臺的語法,發(fā)現其可以高亮顯示結構化數據。
并且還能展開,查看十分方便
另外,chrome控制臺還自帶許多特性:
支持清屏
支持顯示時間(不需要日志信息中攜帶)
支持類似日志自動分組
在輸出樣式上也是異常強大
支持不同日志級別的樣式
支持日志分組
支持對象結構化輸出
支持自定義樣式
支持輸出為表格
簡直是日志輸出利器,因此就打算使用Chrome console作為實時日志查看器了。
架構
既然打算將chrome console作為日志輸出,就得考慮實現方式了,一個簡單的架構如下:
程序輸出日志時,將日志序列化為json格式,通過websocket發(fā)送到日志服務器(web服務器)
查看日志時,通過瀏覽器打開日志服務器提供日志的查看頁面。
客戶端打開頁面時,通過js腳本訂閱日志服務器的日志,并解析日志,調用想用的指令輸出到控制臺
由于有了日志服務器,日志的輸出成了訂閱式的了,也可以非常方便的做日志過濾輸出了。
序列化日志
要實現這個日志框架,第一步就是要將日志信息序列化成json格式,以Serilog為例,由于Serilog框架本身就提供了日志的結構化信息,實現起來是非常方便的。參照serilog文檔自定義一個Sink即可,如下是一個簡單的實現
public class JsonSink : ILogEventSink { private readonly IFormatProvider _formatProvider; public JsonSink(IFormatProvider formatProvider) { _formatProvider = formatProvider; } public void Emit(LogEvent logEvent) { var tokens = logEvent.MessageTemplate.Tokens.Select(getFormat); var template = string.Join("", tokens); var paras = logEvent.Properties.Values.Select(getPara).ToArray(); var level = logEvent.Level.ToString(); var log = new { level, template, paras, }; var text = JsonConvert.SerializeObject(log, Formatting.Indented); File.WriteAllText(@"r:\log.json", text); string getFormat(object token) { if (token is PropertyToken p) return "%o"; else return token.ToString(); } object getPara(LogEventPropertyValue v) { return JsonConvert.DeserializeObject(v.ToString()); } } }
這里需要實現的是Emit函數,可以通過LogEvent對象獲取到結構化的信息,這里需要將它序列化成一個json對象,從而能被chrome js腳本解析。
一般來說,對于一個結構化的日志,主要需要包括如下幾個參數: 告警級別、時間、消息模板、參數。這里簡化起見,就沒有加入時間了。另外,為了方便chrome console輸出,將其模板轉換了一下,轉成了chrome console可以直接支持的消息模板。
需要注意的是,由于chrome console的輸出模板和seriallog的消息模板不完全一致,我這里的算法還比較簡陋,喪失了參數的名稱信息,因此對輸入還是有些限制的,那就是:
參數只能使用一次
參數的順序必須和模板的順序一致
由于大部分的日志是遵循這個限制的,以后再優(yōu)化算法。對于如下日志記錄。
var position = new { Latitude = 25, Longitude = 134 }; var elapsedMs = 34; Log.Information("Processed {@Position} in {Elapsed} ms.", position, elapsedMs);
輸出的json如下(這里我是將其保存到文件了,實際實現應該是發(fā)送到日志服務器):
{ "level": "Information", "template": "Processed %o in %o ms.", "paras": [ { "Latitude": 25, "Longitude": 134 }, 34 ] }
Chrome中輸出
由于篇幅所限,這里不考慮數據如何發(fā)布和訂閱的,僅僅介紹下chrome console中輸出相關功能。
在chrome中輸出需要靠js來實現,一個簡單的實現如下:
var log = { "level": "Information", "template": "Processed %o in %o ms.", "paras": [{ "Latitude": 25, "Longitude": 134 }, 34] }; var fn = console.log; var logPara = [log.template].concat(log.paras); fn.apply(this, logPara);
這里日志信息中攜帶了級別、消息模板、參數三部分信息,需要和控制臺api相對應。主要的難點在于由于參數是動態(tài)的,需要js函數動態(tài)參數的調用。代碼比較簡單,除掉上面的日志消息,就三行代碼,就不多介紹了。
到此這篇關于使用chrome控制臺查看.Net日志的文章就介紹到這了。希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關文章
利用ASP.NET MVC和Bootstrap快速搭建個人博客之文章打賞功能(六)
這篇文章主要介紹了利用ASP.NET MVC和Bootstrap快速搭建個人博客之文章打賞功能(六) 的相關資料,非常不錯,具有參考借鑒價值,需要的朋友可以參考下2016-07-07Visual Studio 2017下ASP.NET CORE的TagHelper智能提示解決辦法
這篇文章主要為大家詳細介紹了Visual Studio 2017下ASP.NET CORE TagHelper智能提示的解決辦法,具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-03-03