Microsoft.Web.Administration无法保存站点自定义日志字段集合修改

问题根源 #

当站点未显式定义logFile/customFields元素时，Microsoft.Web.Administration API或appcmd会默认操作服务器级继承的配置集合，导致自定义字段被错误添加到第一个无显式配置的站点，而非目标站点。

可行解决方案 #

方案1：PowerShell显式创建站点专属的customFields元素 #

修改原有代码，先检查并创建目标站点的customFields元素，确保后续修改绑定到当前站点：

$serverManager = [Microsoft.Web.Administration.ServerManager]::New()
$targetSite = $serverManager.Sites | Where-Object { $_.Name -eq $name }

# 确保站点的logFile元素可操作
if (-not $targetSite.LogFile) {
    $targetSite.LogFile = $targetSite.CreateElement("logFile")
}

# 显式创建站点专属的customFields（若不存在）
$customFieldsElement = $targetSite.LogFile.GetChildElement("customFields")
if (-not $customFieldsElement) {
    $customFieldsElement = $targetSite.LogFile.CreateChildElement("customFields")
    $targetSite.LogFile.AppendChild($customFieldsElement)
}

$customFieldsCollection = $customFieldsElement.GetCollection()

# 设置日志周期
$targetSite.LogFile.Period = [Microsoft.Web.Administration.LoggingPeriod]::Hourly

# 添加自定义字段前先检查是否已存在（避免重复）
$existingField = $customFieldsCollection | Where-Object { 
    $_.GetAttributeValue("logFieldName") -eq "ContosoField"
}
if (-not $existingField) {
    $newField = $customFieldsCollection.CreateElement("add")
    $newField["logFieldName"] = "ContosoField"
    $newField["sourceName"] = "ContosoSource"
    $newField["sourceType"] = "ServerVariable"
    $customFieldsCollection.Add($newField)
}

$serverManager.CommitChanges()
# 强制释放资源，清除缓存
$serverManager.Dispose()

方案2：修正appcmd命令的精准定位 #

先为目标站点创建专属的customFields节点，再添加自定义字段，避免继承问题：

:: 第一步：确保目标站点有自己的customFields节点
C:\Windows\System32\inetsrv\appcmd.exe set config -section:system.applicationHost/sites /+"[name='${name}'].logFile.customFields" /commit:apphost

:: 第二步：添加自定义字段
C:\Windows\System32\inetsrv\appcmd.exe set config -section:system.applicationHost/sites /+"[name='${name}'].logFile.customFields.[logFieldName='ContosoField',sourceName='ContosoSource',sourceType='ServerVariable']" /commit:apphost

或者拆分操作，确保每个步骤精准定位：

# 先初始化空的自定义字段项
C:\Windows\System32\inetsrv\appcmd.exe set config -section:system.applicationHost/sites /"[name='${name}'].logFile.customFields.[logFieldName='ContosoField']":"" /commit:apphost

# 再设置字段属性
C:\Windows\System32\inetsrv\appcmd.exe set config -section:system.applicationHost/sites /"[name='${name}'].logFile.customFields.[logFieldName='ContosoField'].sourceName":"ContosoSource" /"[name='${name}'].logFile.customFields.[logFieldName='ContosoField'].sourceType":"ServerVariable" /commit:apphost

方案3：自动化测试的缓存规避 #

在每次测试周期结束后：

• 显式调用$serverManager.Dispose()释放资源
• 避免复用ServerManager实例，每次操作都重新创建新实例
• 若仍有缓存问题，可重启IIS管理服务（仅测试环境适用）：Restart-Service WMSVC

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