Support for custom field(s) logging

[olljanat]

We should have support to enable custom field(s) to IIS logging.

I can probably create that feature but how you think that it should be implemented?

Example "X-Forwarded-For" header can be included to logging using this PowerShell command:
Add-WebConfigurationProperty -pspath 'MACHINE/WEBROOT/APPHOST' -filter "system.applicationHost/sites/siteDefaults/logFile/customFields" -name "." -value @{logFieldName='Original-IP';sourceName='X-Forwarded-For';sourceType='RequestHeader'}

It needs these four parameters:

• Site name/Site defaults selection
• Field name where value will be stored on log
• Source parameter name where value will be read
• Source type, valid inputs are "RequestHeader","ResponseHeader" and "ServerVariable"

Do you prefer that this should be included to existing "xIISLogging" and "xWebsite" modules (and if so how to do input validation correct way?) or would it be better idea create new "xIISCustomLogging", etc module?

[kittholland]

Thinking about how this would be implemented in this module, for consistency I feel like it would be another CIM class array under xWebsite (like bindings are today) for per-site logging rules, and a modification to xIisLogging for server-wide config.

[nzspambot]

@kittholland that would be the prefered method; add a new param say LogCustomFlags and at a glance your example looks good, only thing I can think off blindly is add vs set

[olljanat]

Let's agree first how configuration should looks like.

First example for xIisLogging:

xIisLogging Logging
{
    LogPath = 'C:\IISLogFiles'
    LogCustomFields = @(
        MSFT_xLogCustomFieldInformation
        {
            LogFieldName   = 'Original-IP'
            SourceName     = 'X-Forwarded-For'
            SourceType     = 'RequestHeader'
        };
        MSFT_xLogCustomFieldInformation
        {
            LogFieldName   = 'ClientEncoding'
            SourceName     = 'Accept-Encoding'
            SourceType     = 'RequestHeader'
        }
    )
}

and first example for xWebsite:

xWebsite NewWebsite
{
    Ensure             = 'Present'
    Name               = 'Default Web Site'
    LogCustomFields    = MSFT_xLogCustomFieldInformation
    {
        LogFieldName   = 'Original-IP'
        SourceName     = 'X-Forwarded-For'
        SourceType     = 'RequestHeader'
    }
}

Did I understand syntax correctly?
Are you happy with naming these settings, etc?

[nzspambot]

@kittholland 👍 looks like a great start

[kittholland]

@olljanat That makes sense to me.

I implemented this internally as a class based resource, doesn't translate straight over but might be helpful if someone else wants to try to implement. The logic is almost identical for website based vs. server level, just change the xpath filterstring. I could try to make some time for it in the future but won't be able to for awhile, I also havent worked with script based resources or implementing CIM classes before.

https://gist.github.com/kittholland/730666229ec9cb7be915768e7d5c9be8

[emrgcl]

Hoping to recycle this issue for Invoke-DscResource since the Invoke-dscresource accepts hashtable and the cim object format causes syntax issue in hashtable. Any workaround is also more than welcome!

Function Test-IISLogCustomfield {

[Cmdletbinding()]
Param(
$LogPath = '%SystemDrive%\inetpub\logs\LogFiles'
)
$Logging =        @{
            LogPath              = $LogPath
            LogCustomFields = MSFT_xLogCustomFieldInformation {
                LogFieldName   = 'Original-IP'
                SourceName     = 'X-Forwarded-For'
                SourceType     = 'RequestHeader'
            };
        }

(Invoke-DscResource -Name xIisLogging -Method Test -ModuleName @{ModuleName='xWebAdministration';RequiredVersion='3.2.0'} -Property $Logging).IndesiredState.ToBoolean($_)
}