C#项目中NLog存储日志至Azure File Share的问题咨询

一、为什么NLog.Extensions.AzureStorage没有Azure File Share Target？ #

• Azure File Share的访问逻辑贴近传统本地文件系统，NLog原生的File Target已经能通过SMB映射或直接SDK调用覆盖其场景，单独开发专属Target的收益较低。
• 该扩展包优先适配Azure生态中与传统文件操作差异较大的服务（比如Event Hub、Cosmos Table这类特殊存储/消息服务），File Share不属于高优先级适配范畴。
• 复用现有File Target能降低维护成本，用户通过简单配置就能实现日志存储，无需额外的专属Target支持。

二、成功实现NLog日志写入Azure File Share的案例 #

方案1：映射Azure File Share到本地盘符，用原生File Target #

这是最简单的实现方式，利用系统SMB映射功能，把Azure File Share挂载成本地盘符，直接用NLog的File Target写入：

1. 将Azure File Share映射到本地盘符（比如Z:），可通过Azure Portal获取连接字符串后，用系统命令或图形界面完成挂载。
2. 配置NLog.config：

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <targets>
    <!-- 直接指向映射的盘符路径 -->
    <target name="azureFile" xsi:type="File" 
            fileName="Z:\logs\app-${shortdate}.log"
            layout="${longdate} ${level} ${message} ${exception:format=tostring}" />
  </targets>
  <rules>
    <logger name="*" minlevel="Info" writeTo="azureFile" />
  </rules>
</nlog>

方案2：自定义NLog Target，直接调用Azure File Share SDK #

如果不想依赖盘符映射，可自定义Target直接对接Azure.Storage.Files.Shares SDK：

1. 安装必要NuGet包：

Install-Package Azure.Storage.Files.Shares
Install-Package NLog

2. 实现自定义Target类：

using NLog;
using NLog.Targets;
using Azure.Storage.Files.Shares;
using System.Text;

namespace YourProjectNamespace
{
    [Target("AzureFileShare")]
    public class AzureFileShareTarget : TargetWithLayout
    {
        // 可通过NLog配置注入的参数
        public string ConnectionString { get; set; }
        public string ShareName { get; set; }
        public string DirectoryName { get; set; } = "logs";
        public string FileNameTemplate { get; set; } = "app-${shortdate}.log";

        private ShareClient _shareClient;
        private ShareDirectoryClient _directoryClient;

        // 初始化Azure资源连接
        protected override void InitializeTarget()
        {
            base.InitializeTarget();
            _shareClient = new ShareClient(ConnectionString, ShareName);
            _shareClient.CreateIfNotExists();
            _directoryClient = _shareClient.GetDirectoryClient(DirectoryName);
            _directoryClient.CreateIfNotExists();
        }

        // 写入日志逻辑
        protected override void Write(LogEventInfo logEvent)
        {
            var logContent = Layout.Render(logEvent);
            var fileName = RenderLogEvent(FileNameTemplate, logEvent);
            var fileClient = _directoryClient.GetFileClient(fileName);

            // 文件不存在则创建
            if (!fileClient.Exists())
            {
                fileClient.Create(0);
            }

            // 追加日志内容
            var contentBytes = Encoding.UTF8.GetBytes(logContent + Environment.NewLine);
            fileClient.Append(contentBytes, 0);
        }
    }
}

3. 注册自定义Target并配置NLog：
   在项目启动代码（比如Program.cs）中注册Target：

NLog.LogManager.Setup().SetupExtensions(s =>
    s.RegisterTarget<AzureFileShareTarget>("AzureFileShare"));

然后配置NLog.config：

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <extensions>
    <!-- 注册自定义Target所在的程序集 -->
    <add assembly="YourProjectAssemblyName" />
  </extensions>
  <targets>
    <target name="azureFileShare" xsi:type="AzureFileShare"
            connectionString="你的Azure File Share连接字符串"
            shareName="你的文件共享名称"
            directoryName="logs"
            fileNameTemplate="app-${shortdate}.log"
            layout="${longdate} ${level} ${message} ${exception:format=tostring}" />
  </targets>
  <rules>
    <logger name="*" minlevel="Info" writeTo="azureFileShare" />
  </rules>
</nlog>

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