.Net Framework使用Serilog和ES搭建分布式日志系统

1.安装ES

官网下载windows版本的安装包,我这里下载的是:elasticsearch-7.16.2

image.png

下载后解压,到bin目录点击elasticsearch.bat直接运行

image.png

显示如下信息表示成功

image.png

浏览器访问:http://localhost:9200/,能打开就说明已经安装完成

image.png

\color{red}{注意:由于ES是java开发的,所以安装之前需要安装java的JDK}

2.安装ES-Head

打开es-head的github地址:https://github.com/mobz/elasticsearch-head

image.png

点击下载源码,我这里使用的是:elasticsearch-head-5.0.0
在命令行工具里面cd到es-head的所在目录,输入以下命令,安装依赖

npm install

image.png

会有一些警告信息,可以忽略,安装后会做当前目录生成node_modules文件夹

修改配置连接ES

打开根目录的文件:elasticsearch-head-5.0.0/Gruntfile.js,增加配置:
hostname:"*"

image.png

修改ES连接地址,打开文件:elasticsearch-head-5.0.0/_site/app.js,找到如下位置修改为自己的ES地址

image.png

修改ES的配置文件:elasticsearch-7.16.2/config/elasticsearch.yml,在文件末尾添加如下内容

#跨域访问,给es-head使用
http.cors.enabled: true  
http.cors.allow-origin: "*"  

命令行输入命令:npm run start ,出现如下信息表示成功,浏览器访问:http://localhost:9100

image.png

\color{red}{安装es-head之前需要安装node,去官网下载最新版本就可以,我这里的版本:}

image.png

3.配置ES,搭建ES集群

搭建集群需要最少3台服务器,在每台es服务器的配置文件新增如下内容:
每个节点对应一个服务器,我的设置如下:
192.168.1.101 es-node-1
192.168.1.102 es-node-2
192.168.1.103 es-node-3
只需要修改每台服务器的节点名称(node.name),保证不重复就可以

#集群配置
#集群名称,多个节点需要一样
cluster.name: es-cluster-logs
#节点名称,每个节点名称必须不一样
node.name: es-node-1
#该节点是否有资格选举为master
node.master: true
#存储索引数据
node.data: true
#数据存储路径
path.data: /data/elasticsearch/data
#日志存储路径
path.logs: /data/elasticsearch/logs
#锁住物理内存
bootstrap.memory_lock: true
bootstrap.system_call_filter: false
#外部访问es端口
http.port: 9200
#内部节点通信端口
transport.tcp.port: 9300
network.host: 0.0.0.0
#表示集群最少的master数
discovery.zen.minimum_master_nodes: 2
#自动发现拼其他节点超时时间
discovery.zen.ping_timeout: 3s
#设置集群的节点IP列表
discovery.seed_hosts: ["192.168.1.111","192.168.1.38","192.168.1.212"]
cluster.initial_master_nodes: ["es-node-1", "es-node-2", "es-node-3"]

4.Serilog对接ES

在NuGet中安装Serilog和Serilog.Sinks.Elasticsearch,我这里使用的是最新版本

image.png

Serilog.Sinks.Elasticsearch需要的依赖会跟着一起安装

image.png

调用Serilog有两种配置方式:

1.使用Serilog.Settings.AppSettings,官方方式

在NuGet安装Serilog.Settings.AppSettings包,关键代码调用:
ReadFrom.AppSettings(filePath: "Configs/AppSettings.config");
可以在Web.Config中appSettings节点直接配置,也可以像我这样引用外部自定义的config文件,文件内容如下:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <!--输出日志到文件-->
        <add key="serilog:using" value="Serilog.Sinks.File"/>
        <add key="serilog:write-to:File.path" value="C:\Logs\myapp-{Date}.txt" />
        <add key="serilog:write-to:File.retainedFileCountLimit" value="10" />
        <!--输出日志到ES-->
        <add key="serilog:using" value="Serilog.Sinks.Elasticsearch"/>
        <add key="serilog:write-to:Elasticsearch.nodeUris" value="http://localhost:9200"/>
        <add key="serilog:write-to:Elasticsearch.indexFormat" value="test-{0:yyyy.MM}"/>
        <add key="serilog:write-to:Elasticsearch.templateName" value="serilog-events-template"/>
    </appSettings>
</configuration>

我这里只列举了必要的信息,如果有需要其他设置,可以访问https://github.com/serilog/serilog-settings-appsettings查看

2.使用Serilog.Settings.Xml,个人封装的

在NuGet安装Serilog.Settings.Xml包,关键代码调用:
ReadFrom.Xml("Configs/Serilog-Xml.config");
Serilog-Xml.config文件内容如下(内容其实类似,只不过转换了写法,看着更加直观):

<?xml version="1.0" encoding="utf-8"?>
<serilog>
    <using>
        <add name="Serilog.Sinks.File" />
        <add name="Serilog.Sinks.Elasticsearch" />
    </using>
    <enrich>
        <enricher name="FromLogContext" />
        <enricher name="WithMachineName" />
        <enricher name="WithThreadId" />
        <enricher name="WithProcessId" />
        <enricher name="WithEnvironmentUserName" />
    </enrich>
    <properties>
        <property name="Application" value="Common.Test" />
    </properties>
        <!--最小记录日志级别-->
    <minimumLevel default="Information">
        <override name="Microsoft" level="Warning" />
        <override name="System" level="Warning" />
    </minimumLevel>
    <writeTo>
                <!--输出到文件-->
        <sink name="File">
                <!--输出目录-->
            <arg name="path" value="D:\log\serilog-test.txt" />
                <!--输出格式-->
            <arg name="outputTemplate" value="{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] [{SourceContext}] {Message:lj}{NewLine}{Exception}" />
                       <!--最小日志级别-->
            <arg name="restrictedToMinimumLevel" value="Information" />
                       <!--按天生成-->
            <arg name="rollingInterval" value="Day" />
            <arg name="rollOnFileSizeLimit" value="true" />
                       <!--文件大小:40M-->
            <arg name="fileSizeLimitBytes" value="41943040" />
                       <!--文件数量:200个-->
            <arg name="retainedFileCountLimit" value="200" />
        </sink>
                <!--输出到ES-->
        <sink name="Elasticsearch">
                        <!--ES地址-->
            <arg name="nodeUris" value="http://localhost:9200" />
                        <!--索引名称-->
            <arg name="indexFormat" value="test-{0:yyyy.MM}" />
            <arg name="templateName" value="serilog-events-template" />
            <arg name="autoRegisterTemplate" value="true" />
        </sink>
    </writeTo>
</serilog>

源码网址:https://github.com/serilog-contrib/serilog-settings-xml

日志的帮助类

    public class LogHelper
    {
        private static Logger _log;
        static LogHelper()
        {
            var loggerConfig = new LoggerConfiguration()
                //记录相关上下文信息
                .Enrich.FromLogContext()
                .ReadFrom.AppSettings(filePath: "Configs/AppSettings.config");
            _log = loggerConfig.CreateLogger();
        }
        public static void Info(Type t, string logInfo)
        {
            _log.ForContext(t).Information(logInfo);
        }
        public static void Error(Type t, Exception e, string logInfo)
        {
            _log.ForContext(t).Error(e, logInfo);
        }
    }

调用代码

//输出正常日志信息
LogHelper.Info(typeof(Controller), "打印日志");
//输出错误日志信息
LogHelper.Error(typeof(Controller), ex, "发生错误");

5.ES-Head查看效果

打开链接:http://localhost:9100

image.png

查看日志详情

image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容