ASP.NET Web API中NLog.Targets.ElasticSearch日志无法写入问题

针对你在.NET Framework 4.6的ASP.NET Web API中配置NLog写入Elasticsearch的需求，结合你指定的版本（NLog 4.4.3、NLog.Targets.ElasticSearch 3.0.0、Elasticsearch/Nest/Elasticsearch.NET 5.6.x），我整理了一份完整的配置方案和注意事项：

环境版本确认 #

先确认你的项目已安装以下指定版本的NuGet包：

• .NET Framework 4.6
• NLog 4.4.3
• NLog.Targets.ElasticSearch 3.0.0
• Nest & Elasticsearch.NET 5.6.x

如果还没安装，可以通过Package Manager Console执行以下命令：

Install-Package NLog -Version 4.4.3
Install-Package NLog.Targets.ElasticSearch -Version 3.0.0
Install-Package Nest -Version 5.6.16
Install-Package Elasticsearch.Net -Version 5.6.16

完整NLog.config配置 #

替换你现有的配置为以下完整内容，注意根据你的实际环境修改关键参数：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="nlog" type="NLog.Config.ConfigSectionHandler, NLog"/>
  </configSections>

  <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        autoReload="true"
        throwExceptions="false"
        internalLogLevel="Off"
        internalLogFile="c:\temp\nlog-internal.log">

    <!-- 定义日志目标 -->
    <targets>
      <!-- ElasticSearch目标配置 -->
      <target xsi:type="ElasticSearch"
              name="elasticTarget"
              uri="http://your-es-host:9200/" <!-- 替换为你的ElasticSearch地址 -->
              index="webapi-logs-${date:format=yyyy.MM.dd}" <!-- 按日期拆分索引，便于管理 -->
              documentType="log-event" <!-- ES 5.6版本必须指定该字段 -->
              includeAllProperties="true"
              flushTimeout="5000"
              layout="${longdate}|${level:uppercase=true}|${logger}|${message} ${exception:format=ToString}">
        <!-- 自定义字段：添加业务需要的额外信息 -->
        <field name="machineName" layout="${machinename}" />
        <field name="appName" layout="YourWebAPIApplication" />
      </target>
    </targets>

    <!-- 日志路由规则 -->
    <rules>
      <!-- 将所有Info及以上级别日志发送到ElasticSearch -->
      <logger name="*" minlevel="Info" writeTo="elasticTarget" />
    </rules>
  </nlog>
</configuration>

关键配置说明与注意事项 #

• ElasticSearch地址替换：务必把uri属性的值改成你的ES集群实际地址，如果ES开启了身份验证，需要添加username和password属性，比如username="elastic" password="your-es-password"
• 索引命名规则：示例中用日期拆分索引，能避免单索引过大，后续查询和维护更方便，你可以根据业务需求调整格式
• documentType字段：由于你使用的是ES 5.6版本，这个字段是必填项；如果是ES 7+版本则不需要配置该字段
• 调试排查：如果配置后没有日志写入ES，可以把internalLogLevel改成Debug或Trace，查看internalLogFile路径下的日志文件，定位配置或连接问题
• 日志使用示例：在Web API控制器中使用NLog记录日志的方式如下：

using NLog;

public class ValuesController : ApiController
{
    private static readonly Logger _logger = LogManager.GetCurrentClassLogger();

    public IHttpActionResult Get()
    {
        _logger.Info("ValuesController.Get 方法被调用");
        try
        {
            // 业务逻辑代码
            return Ok("操作成功");
        }
        catch (Exception ex)
        {
            _logger.Error(ex, "ValuesController.Get 执行出错");
            return InternalServerError(ex);
        }
    }
}

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