项目转.netcore之后对于日志框架的选用在log4net、Nlog以及Serilog之间犹豫了很久,最终选择了Serilog,在此记录一下Serilog的初步配置使用
由于需要输出至ElasticSearch,需要安装ElasticSearch以及Kibana,参考:用Docker部署Elastic栈
Serilog
Serilog.AspNetCore
Serilog.Extensions.Logging
Serilog.Sinks.Console
Serilog.Sinks.Elasticsearch
{ "Logging": { "LogLevel": { "Default": "Information", "System": "Information", "Microsoft": "Information" } } }
using Microsoft.Extensions.Logging; using Serilog; using Serilog.Sinks.Elasticsearch;
public Startup() { Log.Logger = new LoggerConfiguration() .Enrich.FromLogContext() .WriteTo.Elasticsearch(new ElasticsearchSinkOptions(new Uri("http://localhost:9200/")) { AutoRegisterTemplate = true, }) .CreateLogger(); }
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } //添加Serilog loggerFactory.AddSerilog(); app.UseMvc(); }
至此基础配置已经完成可以调用了
调用代码:
[Route("api/[controller]")] [ApiController] public class ValuesController : ControllerBase { ILogger<ValuesController> _logger; public ValuesController(ILogger<ValuesController> logger) { _logger = logger; } // GET api/values [HttpGet] public ActionResult<IEnumerable<string>> Get() { _logger.LogInformation("321321"); return new string[] { "value1", "value2" }; }
项目运行后在Kibana中查看即可,Es中的index规则为:logstash-{yyyy.mm.dd} 例:logstash-2019.12.13
另外为了防止es链接可能出现断连等情况可以改写WriteTo.Elasticsearch为如下代码,在连接出现问题时,将日志写入本地文件
Log.Logger = new LoggerConfiguration()
.Enrich.FromLogContext()
.WriteTo.Elasticsearch(new ElasticsearchSinkOptions(new Uri("http://localhost:9200/"))
{
AutoRegisterTemplate = true
FailureCallback = e => Console.WriteLine("Unable to submit event " + e.MessageTemplate),
EmitEventFailure = EmitEventFailureHandling.WriteToSelfLog |
EmitEventFailureHandling.WriteToFailureSink |
EmitEventFailureHandling.RaiseCallback,
FailureSink = new FileSink("./failures.txt", new JsonFormatter(), null)
})
.Enrich.WithProperty("AppName","WebApp1")
.CreateLogger();
可以格式化一下控制台输出的日志格式,让阅读起来轻松一点
.WriteTo.Console(new ElasticsearchJsonFormatter())
最后就是将配置相关的代码迁移到配置文件中,创建部分代码进行封装,基础的搭建就完成了。
参考:
https://www.humankode.com/asp-net-core/logging-with-elasticsearch-kibana-asp-net-core-and-docker
https://www.cnblogs.com/Leo_wl/p/10943285.html
https://github.com/serilog/serilog-sinks-elasticsearch
.Net Core 使用 Serilog记录日志并输出至ElasticSearch
原文:https://www.cnblogs.com/Cance/p/12039727.html