一.概述

  ASP.NET Core 支持适用于各种内置和第三方日志记录, 供程序的日志记录 API,本文介绍了如何将日志记录 API 与内置提供程序一起使用。对于第三方日志记录提供程序使用,文章最后有链接。

  1.1 添加内置日志提供程序

    日志记录提供程序能够用于显示日志信息或存储日志,比如控制台提供程序在控制台上显示日志,Azure Application Insights 提供程序会将这些日志存储在 Azure Application Insights 中。 可通过添加多个提供程序将日志发送到多个目标。

    要添加提供程序,请在 Program.cs 中调用提供程序的 Add{provider name} 扩展方法:

        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((hostingContext, config) =>
{
config.SetBasePath(Directory.GetCurrentDirectory());
config.AddJsonFile("starship.json", false, true);
})
.ConfigureLogging((hostingContext, logging) =>
{
//日志的 默认记录提供程序
//添加appsettings.json中关于日志的Logging节点配置
logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
//日志控制台记录提供程序
logging.AddConsole();
//日志Debug记录提供程序
logging.AddDebug();
//日志EventSource 记录提供程序
logging.AddEventSourceLogger();
})
.UseStartup<Startup>();

    默认项目模板调用 CreateDefaultBuilder 扩展方法,该操作将添加以上日志记录提供程序(控制台,Debug,EventSource):

    WebHost.CreateDefaultBuilder(args)

    如果要自行选择提供程序来替换默认提供程序。 可以调用 ClearProviders,然后再添加所需的提供程序。

        public static IWebHost BuildWebHost(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.UseStartup<Startup>()
.ConfigureLogging(logging =>
{
logging.ClearProviders();
//只有日志控制台记录提供程序
logging.AddConsole();
})
.Build();

    

  1.2  创建日志

    从 DI 中获取 ILogger<TCategoryName> 对象。以下 Razor 页面示例会创建日志“级别”为 Warning,“T类别”为 Page2Model,的日志:

    public class Page2Model : PageModel
{
private readonly ILogger _logger; public Page2Model(ILogger<Page2Model> logger)
{
_logger = logger;
} public void OnGet()
{
_logger.LogWarning("Load the Page2");
}
}

    如下所示(vs- -调试--窗口):

  1.3 启动Startup时创建日志

    要将日志写入 Startup 类,构造函数签名需包含 ILogger 参数:

        public class Startup
    {
     private readonly ILogger _logger;      public Startup(IConfiguration configuration, ILogger<Startup> logger)
     {
     Configuration = configuration;
     _logger = logger;
     }
    }

    

  1.4  在Program中创建日志

    public static void Main(string[] args)
{
   var host = BuildWebHost(args);
  var logger = host.Services.GetRequiredService<ILogger<Program>>();
  logger.LogInformation("Seeded the database.");    host.Run();
}

  1.5   日志配置Configuration

     日志记录提供程序配置由一个或多个配置提供程序提供,它们可以是:

      (1)文件格式(INI、JSON 和 XML)。

       (2)命令行参数。

      (3)环境变量。

     (4)内存中的 .NET 对象。

    (5)未加密的机密管理器存储。

      (6)加密的用户存储,如 Azure Key Vault。

    (7)(已安装或已创建的)自定义提供程序。

    例如,日志记录配置通常由应用设置文件的 Logging 节点部分提供。 以下示例应用了典型 appsettings.Development.json 文件的内容:

    {
    "Logging": {
     "LogLevel": {
      "Default": "Debug",
     "System": "Information",
    "Microsoft": "Information"
},
   "Console":
   {
  "IncludeScopes": true
   }
  }
  }

    上面的配置文件不需要使用显示加config.AddJsonFile,这个在环境章节已讲过,当程序的环境(ASPNETCORE_ENVIRONMENT)是Development时,该文件中的Logging节点配置生效。

    Logging 下的 LogLevel 属性指定了用于记录所选类别的最低级别,在本例中,System 和 Microsoft类别在 Information 级别记录,其他均在 Debug 级别记录。

    Logging 下的其他属性均指定了日志记录提供程序。 本示例针对控制台提供程序。 如果提供程序支持日志作用域,则 IncludeScopes 将指示是否启用这些域.

  

  1.6 日志级别

    每个日志都指定了一个 LogLevel 值。 日志级别指示严重性或重要程度。如果LogLevel是Warning级别,那么跟踪Trace  ,Debug ,Information 级别将不会记录。

    ASP.NET Core 定义了以下日志级别(按严重性从低到高排列): 

   (1) 跟踪Trace = 0

    (2) 调试Debug = 1

   (3) 信息 Information = 2

  (4) 警告 Warning = 3

   (5) 错误 Error = 4

  (6) 严重 Critical = 5

  1.7 内置日志记录提供程序

    (1) 控制台

     logging.AddConsole(); dotnet run 查看控制台日志记录输出。

    (2) 调试

    logging.AddDebug(); 在 Linux 中,此提供程序将日志写入 /var/log/message。

    (3) EventSource

     logging.AddEventSourceLogger(); 在 Windows 中,它使用 PerfView 实用工具收集和查看日志,但尚无支持 Linux 或 macOS 的事件集合和显示工具。

    (4) EventLog

    logging.AddEventLog();向 Windows 事件日志发送日志输出。

    (5) TraceSource

     logging.AddTraceSource(sourceSwitchName);应用必须在 .NET Framework(而非 .NET Core)上运行。

  1.8 第三方日志记录提供程序

    适用于 ASP.NET Core 的第三方日志记录框架,链接地址官方文档中有:

      elmah.io(GitHub 存储库)

     Gelf(GitHub 存储库)

     JSNLog(GitHub 存储库)

     KissLog.net(GitHub 存储库)

    Loggr(GitHub 存储库)

     NLog(GitHub 存储库)

     Sentry(GitHub 存储库)

     Serilog(GitHub 存储库)

      Stackdriver(Github 存储库)

    例如使用NLog

      NLog是一个灵活的免费日志记录平台,适用于各种.NET平台,包括.NET标准。NLog可以轻松写入多个 目标。(数据库,文件,控制台)并即时更改日志记录配置。

  总结:

    这篇主要讲了asp.net core内置的日志提供程序,  内置的日志自带功能还是有限,比如不能写入到.txt文件或数据库中。在项目使用中还是要考虑使用第三方日志提供程序。本篇对于内置的日志提供程序还有:日志消息模板、日志作用域、Azure 中的日志记录、日志事件 ID等未介绍,具体再参考官方文档。

  参考文献

  官方资料:asp.net core 日志

asp.net core 系列 13 日志的更多相关文章

  1. ASP.NET Core系列:日志

    1. NLog 添加安装包: Install-Package NLog.Web.AspNetCore <?xml version="1.0" encoding="u ...

  2. asp.net core 系列 16 Web主机 IWebHostBuilder

    一.概述 在asp.net core中,Host主机负责应用程序启动和生存期管理.host主机包括Web 主机(IWebHostBuilder)和通用主机(IHostBuilder).Web 主机是适 ...

  3. 【目录】asp.net core系列篇

    随笔分类 - asp.net core系列篇 asp.net core系列 68 Filter管道过滤器 摘要: 一.概述 本篇详细了解一下asp.net core filters,filter叫&q ...

  4. Asp.net Core 系列之--4.事务、日志及错误处理

    ChuanGoing 2019-11-17 这篇原本时想把事务处理.日志处理.错误处理.授权于鉴权一并介绍完的,授权和鉴权我想结合自定义权限来介绍,全部放到这里篇幅可能太长,因此权限部分将会在下篇来介 ...

  5. asp.net core 系列 17 通用主机 IHostBuilder

    一.概述 ASP.NET Core 通用主机 (HostBuilder),该主机对于托管不处理 HTTP 请求的应用非常有用.通用主机的目标是将 HTTP 管道从 Web 主机 API 中分离出来,从 ...

  6. 技术的正宗与野路子 c#, AOP动态代理实现动态权限控制(一) 探索基于.NET下实现一句话木马之asmx篇 asp.net core 系列 9 环境(Development、Staging 、Production)

    黄衫女子的武功似乎与周芷若乃是一路,飘忽灵动,变幻无方,但举手抬足之间却是正而不邪,如说周芷若形似鬼魅,那黄衫女子便是态拟神仙. 这段描写出自<倚天屠龙记>第三十八回. “九阴神抓”本是& ...

  7. WPF中的常用布局 栈的实现 一个关于素数的神奇性质 C# defualt关键字默认值用法 接口通俗理解 C# Json序列化和反序列化 ASP.NET CORE系列【五】webapi整理以及RESTful风格化

    WPF中的常用布局   一 写在开头1.1 写在开头微软是一家伟大的公司.评价一门技术的好坏得看具体的需求,没有哪门技术是面面俱到地好,应该抛弃对微软和微软的技术的偏见. 1.2 本文内容本文主要内容 ...

  8. ASP.NET Core系列(二):创建第一个.Net Core 项目

    前面讲过 .NET Core简介及开发环境安装,本章会讲一讲ASP.NET Core 2.0的项目结构,查看完整的ASP.NET Core系列文章:https://www.cnblogs.com/zh ...

  9. Asp.net Core 系列之--3.领域、仓储、服务简单实现

    ChuanGoing 2019-11-11  距离上篇近两个月时间,一方面时因为其他事情耽搁,另一方面也是之前准备不足,关于领域驱动有几个地方没有想通透,也就没有继续码字.目前网络包括园子里大多领域驱 ...

随机推荐

  1. hive的概述和数据类型

    一.Hive概述 1.Hive简介 Hive数据仓库软件有助于使用SQL读取.编写和管理驻留在分布式存储中的大型数据集.提供了命令行工具和JDBC驱动程序以将用户连接到Hive. Hive可以将SQL ...

  2. 网络攻击技术:SQL Injection(sql注入)

    网络攻击技术开篇——SQL Injection   1.1.1 摘要 日前,国内最大的程序员社区CSDN网站的用户数据库被黑客公开发布,600万用户的登录名及密码被公开泄露,随后又有多家网站的用户密码 ...

  3. mongo删除指定字段,可多个字段同时删除

    参考代码: db.getCollection('Person').update({"email":{$exists:true}},{$unset:{"email" ...

  4. vimtutor——vim官方教程

    =============================================================================== =      欢     迎     阅 ...

  5. 大数据 - Java基础:读取键盘输入的方法

    Java中获取键盘输入值的三种方法 程序编写中,从键盘获取数据是一件非常普通又平常的事 C:scanf() C++:cin() C#:Read().ReadKey().ReadLine() Java没 ...

  6. 我在B站投稿啦、、、

    我在B站投稿啦....欢迎评论交流... https://www.bilibili.com/video/av31539882/  怎样激活Win10系统修改windows系统账户的名称-mp4 外链: ...

  7. mysql 水平分表

    新建10张表,user_0,user_1,...user_9,方法不可串用,采用hash或取余法,获取要操作的表名,取值用对应存值的方法 1.hash取余法 public function part_ ...

  8. cadence布线约束规则设置

    DRC检查规则在布线过程中是必不可少的,包括时序规则,走线规则,间距规则,信号完整性规则和物理规则等,在绘制电路板时,设计相关规则满足设计需求,是非常关键的! https://wenku.baidu. ...

  9. ubuntu 修改系统时间无效

    用root用户修改服务器时间无效:使用hwclock -w也不行 解决方法: 需要取消自动从互联网同步时间才可以的 timedatectl set-ntp 0 上面的命令可以关闭自动同步,然后你再设置 ...

  10. High Availability手册(3): 配置

    各种配置在命令行状态下,多用crm进行 Global Cluster Options 这个类型是全局配置,主要包含下面两个: no-quorum-policy quorum的意思是最低法定人数,pac ...