Requests

Pode has inbuilt Request logging logic, that will parse and return a valid log item for whatever method of logging you supply.

Enabling

To enable and use the Request logging you use the Enable-PodeRequestLogging function, supplying a logging method from New-PodeLoggingMethod.

The Request type logic will format a string using Combined Log Format. This string is then supplied to the logging method's scriptblock. If you're using a Custom logging method and want the raw hashtable instead, you can supply -Raw to Enable-PodeRequestLogging.

Examples

Log to Terminal

The following example simply enables Request logging, and will output all items to the terminal:

New-PodeLoggingMethod -Terminal | Enable-PodeRequestLogging

Using Raw Item

The following example uses a Custom logging method, and sets Request logging to return and supply the raw hashtable to the Custom method's scriptblock. The Custom method simply logs the Host an StatusCode to the terminal (but could be to something like an S3 bucket):

$method = New-PodeLoggingMethod -Custom -ScriptBlock {
    param($item)
    "$($item.Host) - $($item.Response.StatusCode)" | Out-Default
}

$method | Enable-PodeRequestLogging -Raw

Username

If you're not using any Authentication then the "user" field in the log will always be "-". However, if you're using Authentication, and it passes, then the Username of the user accessing the Route will attempt to be retrieved from $WebEvent.Auth.User. The property within the authenticated user object by default is Username, but you can customise this using -UsernameProperty.

For example, if the username was actually user "ID":

Enable-PodeRequestLogging -UsernameProperty 'ID'

Or if the username was inside another "Meta" property, and then within a "Username" property inside the Meta object:

Enable-PodeRequestLogging -UsernameProperty 'Meta.Username'

Raw Request

The raw Request hashtable that will be supplied to any Custom logging methods will look as follows:

@{
    Host = '10.10.0.3'
    RfcUserIdentity = '-'
    User = '-'
    Date = '14/Jun/2018:20:23:52 +01:00'
    Request = @{
        Method = 'GET'
        Resource = '/api/users'
        Protocol = "HTTP/1.1"
        Referrer = '-'
        Agent = '<user-agent>'
    }
    Response = @{
        StatusCode = '200'
        StautsDescription = 'OK'
        Size = '9001'
    }
}