NLog自定义Target之MQTT

NLog是.Net中最流行的日志记录开源项目(之一)，它灵活、免费、开源
官方支持文件、网络(Tcp、Udp)、数据库、控制台等输出
社区支持Elastic、Seq等日志平台输出

实时日志需求

在工业物联网等特定场景下需要实时获取日志信息
工业物联网领域常用的是mqtt协议
那我们就使用NLog 自定义一个Target，将日志输出到MqttServer
Web通过Mqtt(websocket)实时获取日志，而不是传统的通过WebApi轮询日志

NLog自定义Target

官方文档介绍了如何自定义Target，可以获取到一串日志消息，无法获取结构化消息
需要时用使用自定义Field来完成这部分工作

/// <summary>

/// Additional field details

/// </summary>

[NLogConfigurationItem]

public class Field

{

    /// <summary>

    /// Name of additional field

    /// </summary>

    [RequiredParameter]

    public string Name { get; set; }

    /// <summary>

    /// Value with NLog <see cref="NLog.Layouts.Layout"/> rendering support

    /// </summary>

    [RequiredParameter]

    public Layout Layout { get; set; }

    /// <summary>

    /// Custom type conversion from default string to other type

    /// </summary>

    /// <remarks>

    /// <see cref="System.Object"/> can be used if the <see cref="Layout"/> renders JSON

    /// </remarks>

    public Type LayoutType { get; set; } = typeof(string);

    /// <inheritdoc />

    public override string ToString()

    {

        return $"Name: {Name}, LayoutType: {LayoutType}, Layout: {Layout}";

    }

}

重写Write方法

protected override void Write(LogEventInfo logEvent)

{

    //default fields

    Dictionary<string, object> logDictionary = new()

    {

        { "timestamp", logEvent.TimeStamp },

        { "level", logEvent.Level.Name },

        { "message", RenderLogEvent(Layout, logEvent) }

    };

    //customer fields

    //这里都处理为字符串了，有优化空间

    foreach (var field in Fields)

    {

        var renderedField = RenderLogEvent(field.Layout, logEvent);

        if (string.IsNullOrWhiteSpace(renderedField))

            continue;

        logDictionary[field.Name] = renderedField;

    }

    SendTheMessage2MqttBroker(JsonConvert.SerializeObject(logDictionary));

}

使用

下面将使用Nlog.Target.MQTT,演示通过web实时查看应用程序的日志。

创建WebApi项目
引用NLog.Target.MQTT

配置文件

<extensions>

    <add assembly="NLog.Web.AspNetCore"/>

    <!--<add assembly="NLog.Targets.MQTT"/>-->

    <add assembly="NLog.Targets.MQTT"/>

</extensions>

<!-- the targets to write to -->

<targets>

    <!-- MQTT Target  -->

    <target xsi:type="MQTT" name="mqtt" host="localhost" port="1883" username="UserName"  password="Password" topic="log"

            layout="${longdate}|${event-properties:item=EventId_Id:whenEmpty=0}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}|${callsite}" >

        <field name="machine" layout="${machinename}" />

        <field name="processid" layout="${processid}" />

        <field name="threadname" layout="${threadname}" />

        <field name="logger" layout="${logger}" />

        <field name="callsite" layout="${callsite-linenumber}" />

        <field name="url" layout="${aspnet-request-url}" />

        <field name="action" layout="${aspnet-mvc-action}" />

        <field name="level" layout="${level:uppercase=true}" />

        <field name="message" layout="${message}" />

        <field name="exception" layout="${exception:format=toString}" />

    </target>

</targets>

<!-- rules to map from logger name to target -->

<rules>

    <logger name="*" minlevel="Trace" writeTo="mqtt" />

</rules>

配置MQTTServer和NLog

// ...

// NLog: Setup NLog for Dependency injection

builder.Logging.ClearProviders();

builder.Logging.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);

builder.Host.UseNLog();

//AddHostedMqttServer

builder.Services.AddHostedMqttServer(mqttServer =>

    {

        mqttServer.WithoutDefaultEndpoint();

    })

    .AddMqttConnectionHandler()

    .AddConnections();

//Config Port

builder.WebHost.UseKestrel(option =>

{

    option.ListenAnyIP(1883, l => l.UseMqtt());

    option.ListenAnyIP(80);

});

var app = builder.Build();

// ...

//UseStaticFiles html js etc.

app.UseStaticFiles();

app.UseRouting();

//Websocket Mqtt

app.UseEndpoints(endpoints =>

{

    //MqttServerWebSocket

    endpoints.MapConnectionHandler<MqttConnectionHandler>("/mqtt", options =>

    {

        options.WebSockets.SubProtocolSelector = MqttSubProtocolSelector.SelectSubProtocol;

    });

});

// ...

Web连接MqttServer

// ...

<script src="./jquery.min.js"></script>

<script src="./mqtt.min.js"></script>

<script src="./vue.js"></script>

// ...

var client = mqtt.connect('ws://' + window.location.host + '/mqtt', options);

client.on('connect',

    function() {

        client.subscribe('log',

            function(err) {

                if (!err) {

                    console.log("subed!");

                } else {

                    alert("subed error!");

                }

            });

    });

client.on('message',

    function(topic, message) {

        if (topic === 'log') {

            if (app.logs.length > 50)

                app.logs.length = 0;

            app.logs.unshift($.parseJSON(message.toString()));

        }

    });

// ...

输出日志

// ...

_logger.LogDebug("LogDebug!");

_logger.LogError(new Exception("Exception Message!"), "LogError!");

//new thread output log after 500ms

Thread thread = new Thread(ThreadProc);

thread.Name = "My Thread";

thread.Start();

// ...

实时查看日志

访问index.html
通过Mqtt客户端订阅日志

源码

在这里NLog.Targets.MQTT:https://github.com/iioter/NLog.Targets.MQTT

交流

公众号:工业物联网网关	QQ群:712105424

NLog自定义Target之MQTT的更多相关文章

NLog 自定义Target
http://nlog-project.org/2015/06/30/extending-nlog-is-easy.html 新建一个类库,命名规则为NLog.*.dll 定义一个类输出日志到Rabb ...
转：NLog 自定义日志内容，写日志到数据库；修改Nlog.config不起作用的原因
转:http://www.cnblogs.com/tider1999/p/4308440.html NLog的安装请百度,我安装的是3.2.NLog可以向文件,数据库,邮件等写日志,想了解请百度,这里 ...
NLog自定义字段写入数据库表，示例
//自定义字段写入NLog日志 private void saveNLog(InvokeLogModel model) { LogEventInfo ei = new LogEventInfo(); ...
为NLog自定义LayoutRenderer
长话短说前文<解剖HttpClientFactory,自由扩展HttpMessageHandler>主要想讲如何扩展HttpMessageHandler, 示例为在每个Http请求中的 ...
NetCore2.2使用Nlog自定义日志写入路径配置方式
在一些特定场景的业务需求下,日志需要写入到不同的路径下提供日志分析.第一种:默认Nlog可以通过日志级别来区分路径,——优点是不需要额外配置,开箱即用——缺点是不够灵活,如果超过级别数量,则不满足需求 ...
NLog 自定义字段写入 oracle
1.通过Nuget安装NLog 下载,简单入门请参照我刚才转的几篇文章,下面我直接贴代码 2.建表语句 create table TBL_LOG ( id ) not null, appname ...
[转]NLog 自定义字段写入 oracle
本文转自:http://www.cnblogs.com/skyapplezhao/p/5690695.html 1.通过Nuget安装NLog 下载,简单入门请参照我刚才转的几篇文章,下面我直接贴 ...
关于NLog的target和Layout
这个没啥好说的,都是用别人的东西,看文档就行了,写的很详细. https://github.com/NLog/NLog/wiki/Configuration-file https://github.c ...
NLog 安装使用
1:安装 Install-Package NLog.Config 或通过Nuget 2:Log levels Trace 非常详细的信息,一般在开发时使用. Debug 比Trace稍微少一点一般不 ...
转：C# 使用NLog记录日志
原文:http://www.cnblogs.com/felixnet/p/5498759.html NLog是一个记录日志组件,和log4net一样被广泛使用,它可以将日志保存到文本文件.CSV.控制 ...

随机推荐

如何搭建DNS服务
继NTP时间服务器后,继续搭建DNS服务,鉴于昨晚撰写时间超过预期,这次改变策略,先把自己需要用到的部分写出来(主要是基于RAC的搭建,只涉及正向和反向DNS解析),后面再添加必要的说明和阐述. 试验 ...
java操作AJAX
1,get方式的AJAX function sendAjaxReq() { //1,创建ajax引擎 XMLHttpRequest对象 var req = new XMLHttpRequest() | ...
*ecshop安装模板
1. 安装模板例: 新建abc.com文件复制default下的style.css 修改两个http://www.ecshop.com/ 为 http://www.hua.com/ 复制defau ...
bzoj1930
一开始我觉得这不是一个弱弱的费用流吗? 每个豆豆拆点,入点出点随便连连由于肯定是DAG图,边权为正的最大费用肯定能增广出来于是我们只要跑总流量为2的最大费用最大流不就行了吗但是这样会TLE,因 ...
Insert into a Cyclic Sorted List
Given a node from a cyclic linked list which has been sorted, write a function to insert a value int ...
CENTOS6.6上搭建单实例ORACLE12C
本文来自我的github pages博客http://galengao.github.io/ 即www.gaohuirong.cn 摘要: 自己在centos6.6上搭建的单实例oracle12c 由 ...
servlet-jsp-EL 表达式
jsp--EL表达式 jsp表达式<%= %>用于向页面中输出一个对象.jsp2.0时在页面中不允许出现jsp表达式和脚本片段,于是使用EL表达式来代替jsp表达式,标签代替脚本片段基本 ...
UVa 12174 Shuffle（滑动窗口）
https://vjudge.net/problem/UVA-12174 题意: 你在听音乐播放器,它采用随机播放形式.随机播放的原理时先随机产生一个1~n的排列,然后就按这个排列顺序播放歌曲.播放完 ...
linux查看日志文件内容命令（面试被常问到的问题）
tail -f test.log 你会看到屏幕不断有内容被打印出来. 这时候中断第一个进程Ctrl-C, linux 如何显示一个文件的某几行(中间几行) 从第3000行开始,显示1000行.即显示3 ...
string函数库的原型
#ifndef __HAVE_ARCH_STRCPY /** * strcpy - Copy a %NUL terminated string * @dest: Where to copy the s ...