文件日志记录器（filelogger）安装与配置完全指南

文件日志记录器（filelogger）安装与配置完全指南

filelogger A lightweight yet feature-rich file logger implementation for the Microsoft.Extensions.Logging framework. 项目地址: https://gitcode.com/gh_mirrors/fi/filelogger

项目基础介绍及主要编程语言

文件日志记录器（filelogger）是由adams85开发的一个轻量级但功能丰富的日志文件实现项目，专为Microsoft Extensions Logging框架设计。本项目基于.NET Standard 2.0及以上版本，兼容.NET Core 2及其以后的平台，包括.NET 5+。采用C#作为主要编程语言，旨在提供灵活的日志管理解决方案，无需依赖第三方库，并且在后台处理日志信息以避免I/O阻塞。

关键技术和框架

• 微软扩展日志框架：提供基本的日志接口和基础设施。
• NET Standard：确保跨多个.NET实现的互操作性。
• IFileProvider抽象：用于支持自定义文件存储解决方案。
• JSON结构化日志：从3.3.0版本起，支持类似于内置控制台日志器的JSON格式日志。
• 动态配置和日志级别控制：允许细粒度的过滤和日志路径定制。
• 可扩展性设计：方便定制和集成其他特性或服务。

安装和配置步骤

准备工作

1. 环境要求: 确保你的开发环境已经安装了.NET SDK 2.0或更高版本。
2. Visual Studio或代码编辑器: 推荐使用Visual Studio或Visual Studio Code，后者可通过安装.NET插件来获得良好的开发体验。

安装步骤

通过NuGet包管理安装

1. 打开你的.NET项目。

2. 使用命令行工具（如PowerShell或终端），定位到项目的根目录。

   • 对于普通文本日志，运行：

     dotnet add package Karambolo.Extensions.Logging.File
     

   • 若需要JSON结构化日志，替换为：

     dotnet add package Karambolo.Extensions.Logging.File.Json
     

3. 对于非ASP.NET Core应用，确保添加必要的依赖（例如，对于.NET 7项目）：

   dotnet add package Microsoft.Extensions.FileProviders.Physical -v 7.0.*
   dotnet add package Microsoft.Extensions.Logging.Configuration -v 7.0.*
   dotnet add package Microsoft.Extensions.Options.ConfigurationExtensions -v 7.0.*
   dotnet add package System.Threading.Channels -v 7.0.*
   

配置步骤

ASP.NET Core应用配置

1. 在appsettings.json中加入日志配置段落，示例：

   "Logging": {
       "LogLevel": {
           "Default": "Information",
           "Microsoft": "Warning",
           "Microsoft.Hosting.Lifetime": "Information"
       },
       "File": {
           "RootPath": "{ContentRoot}",
           "FileNamePattern": "filelogger-{Date}.log"
       }
   }
   

2. 修改启动代码以添加文件日志提供者（使用JSON日志为例）：

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddLogging(loggingBuilder =>
       {
           loggingBuilder.AddJsonFile(options =>
           {
               options.RootPath = Environment.ContentRootPath;
           });
       });
   }
   

控制台应用配置

1. 类似地，在控制台应用中设置配置和服务注册：

   var config = new ConfigurationBuilder()
       .AddJsonFile("appsettings.json", true, reloadOnChange: true)
       .Build();
   
   services = new ServiceCollection();
   services.AddLogging(logBuilder =>
   {
       logBuilder.AddConfiguration(config.GetSection("Logging"));
       logBuilder.AddFile(options =>
       {
           options.RootPath = AppDomain.CurrentDomain.BaseDirectory;
       });
   });
   

完成以上步骤后，应用即可开始使用该文件日志记录器进行日志记录。记得根据实际需求调整配置选项，以达到最佳的日志管理和分析效果。

filelogger A lightweight yet feature-rich file logger implementation for the Microsoft.Extensions.Logging framework. 项目地址: https://gitcode.com/gh_mirrors/fi/filelogger