.net 自定义日志类

本文涉及的产品
可观测监控 Prometheus 版,每月50GB免费额度
应用实时监控服务-用户体验监控,每月100OCU免费额度
性能测试 PTS,5000VUM额度
简介: 在.NET中,创建自定义日志类有助于更好地管理日志信息。示例展示了如何创建、配置和使用日志记录功能,包括写入日志文件、设置日志级别、格式化消息等。注意事项涵盖时间戳、日志级别、JSON序列化、线程安全、日志格式、文件处理及示例使用。请根据需求调整代码。

在.NET中,创建一个自定义日志类可以帮助你更好地管理和记录应用程序中的日志信息。以下是一个简单的自定义日志类的示例,它展示了如何创建、配置和使用日志记录功能。

自定义日志类示例

创建日志类

首先,你需要创建一个新的类来封装日志记录的逻辑。这个类可以包含写入日志文件、设置日志级别、格式化日志消息等功能。

using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Text.Json;
using System.Threading;

public class CustomLogger
{
    private readonly string _logFilePath;
    private readonly object _lock = new object();

    public CustomLogger(string logFilePath)
    {
        _logFilePath = logFilePath;
        EnsureLogDirectoryExists();
    }

    private void EnsureLogDirectoryExists()
    {
        var logDirectory = Path.GetDirectoryName(_logFilePath);
        if (!Directory.Exists(logDirectory))
        {
            Directory.CreateDirectory(logDirectory);
        }
    }

    public void Log(LogLevel level, string ipAddress, string requestId, string apiPath, object parameters)
    {
        var timestamp = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ", CultureInfo.InvariantCulture);
        var logMessage = CreateLogMessage(level, timestamp, ipAddress, requestId, apiPath, parameters);

        lock (_lock)
        {
            File.AppendAllText(_logFilePath, logMessage + Environment.NewLine, System.Text.Encoding.UTF8);
        }
    }

    private string CreateLogMessage(LogLevel level, string timestamp, string ipAddress, string requestId, string apiPath, object parameters)
    {
        var levelString = level.ToString().ToUpper();
        var jsonParams = JsonSerializer.Serialize(parameters, new JsonSerializerOptions { WriteIndented = true });

        return $"[{timestamp}] {levelString} {ipAddress} {requestId} {apiPath} {jsonParams}";
    }

    public enum LogLevel
    {
        Info,
        Warning,
        Error,
        Debug,
        Fatal
    }
}

// 示例使用
public class Program
{
    public static void Main(string[] args)
    {
        var logger = new CustomLogger("application.log");

        var parameters = new
        {
            ignore = new List<string>(),
            signname = "移民家园",
            mobile = "8613501171970",
            template_code = "SMS_155371505",
            params = new { code = "351532" },
            ext = new List<string>()
        };

        logger.Log(CustomLogger.LogLevel.Info, "47.98.168.128", "6771723fe5f2e", "/api/sms/send", parameters);
    }
}

注意事项:

  1. 时间戳:我使用了DateTime.UtcNow来获取UTC时间,并将其格式化为ISO 8601格式。如果您需要本地时间,请使用DateTime.Now,但请注意时区差异。
  2. 日志级别:我定义了一个LogLevel枚举来表示日志的级别。
  3. JSON序列化:我使用了System.Text.Json.JsonSerializer来将参数对象序列化为JSON字符串。
  4. 线程安全:我使用了一个lock对象来确保写入日志文件时的线程安全性。
  5. 日志格式:日志条目的格式与您提供的示例相匹配,包括时间戳、日志级别、IP地址、请求ID、API路径和参数(以JSON格式)。
  6. 日志文件:日志条目将被追加到指定的日志文件中。如果文件不存在,它将被创建。
  7. 示例使用:在Main方法中,我创建了一个CustomLogger实例,并使用它来记录一条日志信息。

请根据您的具体需求调整这个示例。例如,您可能希望将日志输出到控制台而不是文件,或者添加更多的日志上下文信息。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
3月前
|
开发框架 .NET C#
C#|.net core 基础 - 删除字符串最后一个字符的七大类N种实现方式
【10月更文挑战第9天】在 C#/.NET Core 中,有多种方法可以删除字符串的最后一个字符,包括使用 `Substring` 方法、`Remove` 方法、`ToCharArray` 与 `Array.Copy`、`StringBuilder`、正则表达式、循环遍历字符数组以及使用 LINQ 的 `SkipLast` 方法。
|
8天前
|
JSON 数据格式
.net HTTP请求类封装
`HttpRequestHelper` 是一个用于简化 HTTP 请求的辅助类,支持发送 GET 和 POST 请求。它使用 `HttpClient` 发起请求,并通过 `Newtonsoft.Json` 处理 JSON 数据。示例展示了如何使用该类发送请求并处理响应。注意事项包括:简单的错误处理、需安装 `Newtonsoft.Json` 依赖,以及建议重用 `HttpClient` 实例以优化性能。
50 2
|
2月前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
56 1
|
3月前
.NET 4.0下实现.NET4.5的Task类相似功能组件
【10月更文挑战第29天】在.NET 4.0 环境下,可以使用 `BackgroundWorker` 类来实现类似于 .NET 4.5 中 `Task` 类的功能。`BackgroundWorker` 允许在后台执行耗时操作,同时不会阻塞用户界面线程,并支持进度报告和取消操作。尽管它有一些局限性,如复杂的事件处理模型和不灵活的任务管理方式,但在某些情况下仍能有效替代 `Task` 类。
|
3月前
|
Windows
.NET 隐藏/自定义windows系统光标
【10月更文挑战第20天】在.NET中,可以使用`Cursor`类来控制光标。要隐藏光标,可将光标设置为`Cursors.None`。此外,还可以通过从文件或资源加载自定义光标来更改光标的样式。例如,在表单加载时设置`this.Cursor = Cursors.None`隐藏光标,或使用`Cursor.FromFile`方法加载自定义光标文件,也可以将光标文件添加到项目资源中并通过资源管理器加载。这些方法适用于整个表单或特定控件。
|
3月前
|
API
使用`System.Net.WebClient`类发送HTTP请求来调用阿里云短信API
使用`System.Net.WebClient`类发送HTTP请求来调用阿里云短信API
45 0
|
2月前
|
XML 安全 Java
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
400 30
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
|
21天前
|
监控 安全 Apache
什么是Apache日志?为什么Apache日志分析很重要?
Apache是全球广泛使用的Web服务器软件,支持超过30%的活跃网站。它通过接收和处理HTTP请求,与后端服务器通信,返回响应并记录日志,确保网页请求的快速准确处理。Apache日志分为访问日志和错误日志,对提升用户体验、保障安全及优化性能至关重要。EventLog Analyzer等工具可有效管理和分析这些日志,增强Web服务的安全性和可靠性。
|
3月前
|
XML JSON Java
Logback 与 log4j2 性能对比:谁才是日志框架的性能王者?
【10月更文挑战第5天】在Java开发中,日志框架是不可或缺的工具,它们帮助我们记录系统运行时的信息、警告和错误,对于开发人员来说至关重要。在众多日志框架中,Logback和log4j2以其卓越的性能和丰富的功能脱颖而出,成为开发者们的首选。本文将深入探讨Logback与log4j2在性能方面的对比,通过详细的分析和实例,帮助大家理解两者之间的性能差异,以便在实际项目中做出更明智的选择。
351 3
|
30天前
|
存储 监控 安全
什么是事件日志管理系统?事件日志管理系统有哪些用处?
事件日志管理系统是IT安全的重要工具,用于集中收集、分析和解释来自组织IT基础设施各组件的事件日志,如防火墙、路由器、交换机等,帮助提升网络安全、实现主动威胁检测和促进合规性。系统支持多种日志类型,包括Windows事件日志、Syslog日志和应用程序日志,通过实时监测、告警及可视化分析,为企业提供强大的安全保障。然而,实施过程中也面临数据量大、日志管理和分析复杂等挑战。EventLog Analyzer作为一款高效工具,不仅提供实时监测与告警、可视化分析和报告功能,还支持多种合规性报告,帮助企业克服挑战,提升网络安全水平。