functions/sinks/Add-SinkSyslogUdp.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
function Add-SinkSyslogUdp {
    <#
    .SYNOPSIS
        Writes log events to syslog server
    .DESCRIPTION
        Writes log events to syslog server
    .PARAMETER LoggerConfig
        Instance of LoggerConfiguration
    .PARAMETER Hostname
        Hostname of the syslog server
    .PARAMETER Port
        Port the syslog server is listening on
    .PARAMETER AppName
        The name of the application. Defaults to the current process name
    .PARAMETER Format
        The syslog message format to be used
    .PARAMETER Facility
        The category of the application
    .PARAMETER OutputTemplate
        A message template describing the format used to write to the sink.
    .PARAMETER RestrictedToMinimumLevel
        The minimum level for events passed through the sink. Ignored when LevelSwitch is specified.
    .INPUTS
        Instance of LoggerConfiguration
    .OUTPUTS
        LoggerConfiguration object allowing method chaining
    .EXAMPLE
        PS> Add-SinkSyslogUdp -Hostname 'syslogServer1'
    #>


    [Cmdletbinding()]
    param(
        [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Serilog.LoggerConfiguration]$LoggerConfig,

        [Parameter(Mandatory = $true)]
        [string]$Hostname,

        [Parameter(Mandatory = $false)]
        [int]$Port = 514,

        [Parameter(Mandatory = $false)]
        [string]$AppName = $null,

        [Parameter(Mandatory = $false)]
        [Serilog.Sinks.Syslog.SyslogFormat]$Format = [Serilog.Sinks.Syslog.SyslogFormat]::RFC3164,

        [Parameter(Mandatory = $false)]
        [Serilog.Sinks.Syslog.Facility]$Facility = [Serilog.Sinks.Syslog.Facility]::Local0,

        [Parameter(Mandatory = $false)]
        [string]$OutputTemplate = '{Message}{NewLine}{Exception}{ErrorRecord}',

        [Parameter(Mandatory = $false)]
        [Serilog.Events.LogEventLevel]$RestrictedToMinimumLevel = [Serilog.Events.LogEventLevel]::Verbose
    )

    process {    
        $LoggerConfig = [Serilog.SyslogLoggerConfigurationExtensions]::UdpSyslog($LoggerConfig.WriteTo,
            $Hostname,
            $Port,
            $AppName,
            $Format,
            $Facility,
            $OutputTemplate,
            $RestrictedToMinimumLevel
        )

        $LoggerConfig
    }
}