.net 自定义日志类

本文涉及的产品
可观测可视化 Grafana 版,10个用户账号 1个月
应用实时监控服务-可观测链路OpenTelemetry版,每月50GB免费额度
容器镜像服务 ACR,镜像仓库100个 不限时长
简介: 在.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实例,并使用它来记录一条日志信息。

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

相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
目录
相关文章
|
7月前
|
消息中间件 运维 监控
智能运维,由你定义:SAE自定义日志与监控解决方案
通过引入 Sidecar 容器的技术,SAE 为用户提供了更强大的自定义日志与监控解决方案,帮助用户轻松实现日志采集、监控指标收集等功能。未来,SAE 将会支持 istio 多租场景,帮助用户更高效地部署和管理服务网格。
525 52
|
8月前
|
消息中间件 运维 监控
智能运维,由你定义:SAE自定义日志与监控解决方案
SAE(Serverless应用引擎)是阿里云推出的全托管PaaS平台,致力于简化微服务应用开发与管理。为满足用户对可观测性和运维能力的更高需求,SAE引入Sidecar容器技术,实现日志采集、监控指标收集等功能扩展,且无需修改主应用代码。通过共享资源模式和独立资源模式,SAE平衡了资源灵活性与隔离性。同时,提供全链路运维能力,确保应用稳定性。未来,SAE将持续优化,支持更多场景,助力用户高效用云。
|
11月前
|
JSON 数据格式
.net HTTP请求类封装
`HttpRequestHelper` 是一个用于简化 HTTP 请求的辅助类,支持发送 GET 和 POST 请求。它使用 `HttpClient` 发起请求,并通过 `Newtonsoft.Json` 处理 JSON 数据。示例展示了如何使用该类发送请求并处理响应。注意事项包括:简单的错误处理、需安装 `Newtonsoft.Json` 依赖,以及建议重用 `HttpClient` 实例以优化性能。
284 2
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
261 1
.NET 4.0下实现.NET4.5的Task类相似功能组件
【10月更文挑战第29天】在.NET 4.0 环境下,可以使用 `BackgroundWorker` 类来实现类似于 .NET 4.5 中 `Task` 类的功能。`BackgroundWorker` 允许在后台执行耗时操作,同时不会阻塞用户界面线程,并支持进度报告和取消操作。尽管它有一些局限性,如复杂的事件处理模型和不灵活的任务管理方式,但在某些情况下仍能有效替代 `Task` 类。
179 0
|
Windows
.NET 隐藏/自定义windows系统光标
【10月更文挑战第20天】在.NET中,可以使用`Cursor`类来控制光标。要隐藏光标,可将光标设置为`Cursors.None`。此外,还可以通过从文件或资源加载自定义光标来更改光标的样式。例如,在表单加载时设置`this.Cursor = Cursors.None`隐藏光标,或使用`Cursor.FromFile`方法加载自定义光标文件,也可以将光标文件添加到项目资源中并通过资源管理器加载。这些方法适用于整个表单或特定控件。
214 0
|
XML 安全 Java
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
3468 31
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
|
6月前
|
监控 容灾 算法
阿里云 SLS 多云日志接入最佳实践:链路、成本与高可用性优化
本文探讨了如何高效、经济且可靠地将海外应用与基础设施日志统一采集至阿里云日志服务(SLS),解决全球化业务扩展中的关键挑战。重点介绍了高性能日志采集Agent(iLogtail/LoongCollector)在海外场景的应用,推荐使用LoongCollector以获得更优的稳定性和网络容错能力。同时分析了多种网络接入方案,包括公网直连、全球加速优化、阿里云内网及专线/CEN/VPN接入等,并提供了成本优化策略和多目标发送配置指导,帮助企业构建稳定、低成本、高可用的全球日志系统。
763 54
|
11月前
|
监控 安全 Apache
什么是Apache日志?为什么Apache日志分析很重要?
Apache是全球广泛使用的Web服务器软件,支持超过30%的活跃网站。它通过接收和处理HTTP请求,与后端服务器通信,返回响应并记录日志,确保网页请求的快速准确处理。Apache日志分为访问日志和错误日志,对提升用户体验、保障安全及优化性能至关重要。EventLog Analyzer等工具可有效管理和分析这些日志,增强Web服务的安全性和可靠性。
327 9