如何在SOAP API内部使用NLog记录日志？内部日志无法生成

一、先解决NLog内部日志无法生成的问题 #

你的基础配置理论上应该生成内部日志，但没出现通常是以下几个原因，按顺序排查：

• 确保nlog.config复制到输出目录
  右键项目中的nlog.config文件→属性→设置“复制到输出目录”为始终复制或如果较新则复制。如果配置文件没出现在应用程序的运行目录（比如bin/Debug/netX.X或IIS网站根目录），NLog无法加载配置，自然不会生成内部日志。

• 检查日志路径权限与位置
  你用的相对路径nlog-internal.log会生成在应用程序的工作目录，默认可能不是你预期的位置。建议先改用绝对路径测试，比如：

  internalLogFile="C:\Temp\nlog-internal.log"
  

  确保C:\Temp目录存在，且应用程序运行身份（如IIS应用池身份IIS APPPOOL\你的应用池名称）对该目录有读写权限。

• 手动初始化NLog
  在SOAP API的启动代码中（比如Global.asax的Application_Start方法）添加初始化逻辑：

  protected void Application_Start(object sender, EventArgs e)
  {
      var configPath = Server.MapPath("~/nlog.config");
      LogManager.Configuration = new NLog.Config.XmlLoggingConfiguration(configPath);
  }
  

  这能强制NLog加载指定路径的配置文件，避免自动加载失败。

二、配置SOAP API内部业务日志 #

解决内部日志问题后，完善nlog.config以记录API内部运行日志：

完整的nlog.config示例 #

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      autoReload="true"
      internalLogFile="C:\Temp\nlog-internal.log"
      internalLogLevel="Trace">

  <!-- 定义日志输出目标：这里用文件记录，可按需修改为数据库、控制台等 -->
  <targets>
    <target name="apiFileLog" xsi:type="File"
            fileName="C:\Temp\soap-api.log"
            layout="${longdate} | ${level:uppercase=true} | ${logger} | ${message} ${exception:format=ToString,StackTrace}" />
  </targets>

  <!-- 日志路由规则：所有日志都输出到apiFileLog目标 -->
  <rules>
    <logger name="*" minlevel="Trace" writeTo="apiFileLog" />
  </rules>
</nlog>

在SOAP服务类中使用NLog记录日志 #

在你的WebService类中创建Logger实例，然后在方法中埋点记录：

using NLog;
using System.Web.Services;

public class MySoapService : WebService
{
    // 获取当前类的Logger实例
    private static readonly Logger _logger = LogManager.GetCurrentClassLogger();

    [WebMethod]
    public string ProcessRequest(string requestData)
    {
        // 记录请求进入
        _logger.Trace("ProcessRequest方法启动，请求参数：{0}", requestData);
        
        try
        {
            // 业务逻辑执行
            var result = $"处理完成：{requestData}";
            _logger.Info("ProcessRequest方法执行成功，返回结果：{0}", result);
            return result;
        }
        catch (Exception ex)
        {
            // 记录异常信息
            _logger.Error(ex, "ProcessRequest方法执行失败");
            throw;
        }
    }
}

三、常见排查技巧 #

• 查看NLog内部日志nlog-internal.log，里面会详细记录配置加载、目标初始化的错误信息（比如权限不足、文件路径不存在等）。
• 确保应用程序池身份对日志目录有读写权限，尤其是IIS部署的场景，默认身份权限可能不足。

内容的提问来源于stack exchange，提问作者SDanks