使用LogMaster4Net实现应用程序日志的集中管理

日志在软件系统中的重要性我在此也不赘述了，几乎所有程序员每天都会更日志打交道。 那么你是否曾今为这样的一些事情而困扰过：

- 远程登录到不同的服务器，找到应用程序目然后查看应用日志；
- 来回切换于不同服务器并使用tail来实时监控日志输出信息;
- 解决在各个服务器上各个应用日积月累生成的大量日志文件造成的磁盘空间不足的问题；

如果在你的系统中存在着很多个不同的进程并且运行在多个服务器上，上面的问题将会显得尤为突出。很不幸是，笔者所在的公司的系统中，有数十个windows服务，控制台程序，计划任务同时工作在多个服务器上。 因此，笔者不胜其扰，终于开始寻找日志集中管理的解决方案。 幸运的是，一款开源的日志服务器软件 LogMaster4Net 刚好满足需求，而且正好支持笔者公司系统采用的日志组件log4net。 经过一段时间的使用，LogMaster4Net已在笔者公司稳定运行了超过半年时间。 笔者公司的日志从此规整，监控系统运行情况也比以前方便很多，查询系统运行问题也更迅速。

下面介绍一下LogMaster4Net的使用方法：

下载安装

下载地址: https://github.com/kerryjiang/LogMaster4Net/releases/tag/0.1

配置端口: 打开根目录配置文件(SuperSocket.SocketService.exe.config)设置端口号(默认为2020)

<server name="LogMasterServer"
        ...
        port="[port]"
        ...
</server>

安装Windows服务: 命令行运行如下指令，安装成功后，如发现服务未启动请在服务列表里找到服务LogMaster4NetService并启动

SuperSocket.SocketService.exe -i

将应用程序的log4net配置文件复制到LogMaster4Net目录

LogMaster4Net可直接使用应用的日志配置文件。应用日志如有文件生成，请注意文件保存路径。 应用配置文件应存放于LogMaster4Net的Config文件夹, 相对路径如下:

\Config\log4net.[LogAppName].Config

[LogAppName] 为应用在LogMaster4Net中的唯一名称，将会在后面设置中使用。

如果 [LogAppName] 为 "QueryApp", 那么此应用的日志配置文件名为：

\Config\log4net.QueryApp.Config

此应用的日志配置内容可为:  

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
    <appender name="infoAppender" type="log4net.Appender.RollingFileAppender">
        <filter type="log4net.Filter.LevelRangeFilter">
            <levelMin value="INFO" />
        </filter>
        <file value="AppLogs\SampleApp\info.log" />
        <encoding value="utf-8"/>
        <preserveLogFileNameExtension value="true" />
        <appendToFile value="true" />
        <rollingStyle value="Date" />
        <datePattern value="yyyyMMdd" />
        <layout type="log4net.Layout.PatternLayout">
            <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
        </layout>
    </appender>
    <root>
        <level value="ALL" />
        <appender-ref ref="infoAppender" />
    </root>
</log4net>

应用程序日志转发设置

使用log4net的UdpAppender转发日志:  

<appender name="udpAppender" type="log4net.Appender.UdpAppender">
  <remoteAddress value="[ServerAddress]" />
  <remotePort value="[port]" />
  <layout type="log4net.Layout.XmlLayout">
      <locationInfo value="true" />
  </layout>
</appender>

• [ServerAddress]: LogMaster4Net服务安装运行的地址
• [Port]: LogMaster4Net服务监听的端口号;

设置日志全局变量"LogAppName":

log4net.GlobalContext.Properties["LogAppName"] = "QueryApp";

此处LogAppName即为上步所述应用在LogMaster4Net中的唯一名称"QueryApp"。

完成上述步骤之后，编译运行应用程序，日志便会转发到LogMaster4Net上并按照应用的日志的配置进行处理。

LogMaster4Net的优势与缺点

优势如下:

• 简单: 直接使用现有日志组件的特性，无需额外开发;
• 透明: 仍使用原应用的配置进行处理，如同在应用本地处理日志一样;
• 灵活: 灵活的配置策略: 基于SuperSocket的配置允许LogMaster4Net监听多个IP和端口，甚至能允许你运行多个LogMaster4Net服务器实例；
• 跨平台: 二进制级别的兼容Unix/Linux (通过Mono); (http://docs.supersocket.net/v1-6/zh-CN/Run-SuperSocket-in-Linux-Unix)

缺点也不少:

• 虽然在架构上支持各种日志组件，但其开发者暂时只支持了log4net;
• 缺乏相应的日志辅助工具，如dashboard, archive; 如需更多高级功能，需要配合其它工具使用；

展望

当今软件江湖，云计算(PaaS)，应用容器(Docker), 微服务等技术(概念)越来越应用广泛。为了追求更好的可靠性，稳定性，易维护性，将来会有更多的系统是以多进程，多实例的方式运行。如此一来，作为软件系统中的基础部件，日志的集中管理将会是一个公共话题。 相关的最佳实践，开源项目也将不断涌现。

传说中的Splunk很好很强大，但是不便宜。 不是所有公司(中国公司)愿意在日志上投入那么多钱。 LogMaster4Net作为其中一个开源软件只是完成了一小步，但对于一些要求不高，技术实力有限的中小IT企业也已经足够。不过还好，LogMaster4Net推出的时间很短，是一个十分年轻的开源项目，如果大家对它有啥建议，不妨直接联系其作者。相信LogMaster4Net在未来的几年里会有不错的发展。