第2章 2.2 搭建应用日志中心:采用ElasticSearch, Kibana, .NET Core 2.1 和 Serilog

  • 参考
    https://github.com/Amine-Smahi/ElasticCore

我们想要搭建的应用日志中心,主要是为了收集应用程序所产生的日志,并通过这个平台来存储这些日志,最终以可视化的方式对日志进行查询和分析。业界流行着一款开源的日志中心,它的功能相当强大,产品化程度非常高,不管是用户界面还是参考文档,它都在不断的追求更好的品质,这款开源日志中心就是ELK。实际上,ELK是由三个开源产品组成,即Elasticsearch、Logstash、Kibana,这三个开源产品归属于一家叫Elastic的公司。

本节介绍的日志方案为了简化起见,没有考虑Logstash。

  • 什么是ElasticSearch?
    简而言之,ElasticSearch是一个基于Lucene的搜索服务器,非常适合索引日志和数据分析

  • 什么是Kibana?
    Kibana 是一个开源的分析和可视化平台,旨在与 Elasticsearch 合作。Kibana 提供搜索、查看和与存储在 Elasticsearch 索引中的数据进行交互的功能。开发者或运维人员可以轻松地执行高级数据分析,并在各种图表、表格和地图中可视化数据。

  • 什么是Serilog?
    Serilog是 asp.net core的一个日志插件,可以将日志信息输出到文档、sql数据库或Elasticsearch中。

搭建ELK

搭建ELK基础环境最简单的方式莫过于Docker容器,直接从hub.docker.com 上下载最新的镜像,然后通过Docker数据卷的方式,将日志存储路径挂接到Docker容器上。

docker pull sebp/elk
docker run -d -p 127.0.0.1:5601:5601 -p 127.0.0.1:9200:9200 -p 127.0.0.1:9300:9300 -v /home/daijinming/demo/logbase/elk:/var/lib/elasticsearch --name elk_log sebp/elk

5601 是 Kibana的端口号,可以通过 127.0.0.1:5601 在浏览器上访问
9200 是 ElasticSearch 的端口号,可以通过访问 127.0.0.1:9200测试服务开启状态
9300 是 ElasticSearch集群通信端口号
如果运行ELK镜像失败可以参考下:https://blog.csdn.net/jiankunking/article/details/65448030

应用调用

  • 添加引用
dotnet add package Serilog
dotnet add package Serilog.Extensions.Logging
dotnet add package Serilog.Sinks.ElasticSearch

Startup.cs 注册日志服务

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
//引用命名空间
using Serilog;
using Serilog.Events;
using Serilog.Sinks.Elasticsearch;

namespace chapter1_webapi
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
             // 创建 Serilog Elasticsearch logger
            Log.Logger = new LoggerConfiguration()
               .Enrich.FromLogContext()
               .MinimumLevel.Debug()
               .WriteTo.Elasticsearch(new ElasticsearchSinkOptions(new Uri("http://localhost:9200"))
               {
                   MinimumLogEventLevel = LogEventLevel.Verbose,
                   AutoRegisterTemplate = true
               })
            .CreateLogger();

            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {   //设置
            services.AddLogging(loggingBuilder => loggingBuilder.AddSerilog(dispose: true));
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            
            new LoggerFactory().AddConsole(Configuration.GetSection("Logging"));
            new LoggerFactory().AddDebug();

            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseHsts();
            }
            app.UseMvc();
        }
    }
}

在API控制器中记录日志异常

using System;
using System.Collections.Generic;
using System.Data.SqlClient;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Dapper;
using Microsoft.AspNetCore.Cors;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Microsoft.Extensions.Logging;

namespace chapter1_webapi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        ILogger _logger;
        public ValuesController(ILogger logger)
        {
            _logger = logger;
        }
        // GET api/values
        [HttpGet]
        public ContentResult Get(
            [FromServices]IConfiguration config)
        {
            using (SqlConnection connection = new SqlConnection(
                config.GetConnectionString("Dapper_SQLServer")))
            {   
                object data = "";

                try
                {
                        data = connection.Query(
                        "SELECT id " +
                              ",name " +
                              ",sex " +
                        "FROM dbo.userdata " +
                        "ORDER BY id "
                        );

                }
                catch (Exception ex)
                {
                    _logger.LogError(ex, "读取数据异常.");
                }
                return Content(JsonHelper.ToJson(data), "application/json");
            }
        }

    }
}

登陆Kibana(http://localhost:5601),在Management里面,新建一个Index Patterns,然后就可以看到刚刚记录的日志信息了。

当然刚开始接触Kibana,可能会有点摸不着头脑,慢慢来吧。

你可能感兴趣的:(第2章 2.2 搭建应用日志中心:采用ElasticSearch, Kibana, .NET Core 2.1 和 Serilog)