Skip to main content

Write-Log

SYNOPSIS​

Emits a log record

SYNTAX​

Write-Log [-Message] <String> [[-Arguments] <Array>] [[-Body] <Object>] [[-ExceptionInfo] <ErrorRecord>]
 [[-Tags] <String[]>] [-ProgressAction <ActionPreference>] [-Level <String>] [<CommonParameters>]

DESCRIPTION​

This function write a log record to configured targets with the matching level

EXAMPLES​

EXAMPLE 1​

Write-Log 'Hello, World!'

EXAMPLE 2​

Write-Log -Level ERROR -Message 'Hello, World!'

EXAMPLE 3​

Write-Log -Level ERROR -Message 'Hello, {0}!' -Arguments 'World'

EXAMPLE 4​

Write-Log -Level ERROR -Message 'Hello, {0}!' -Arguments 'World' -Body @{Server='srv01.contoso.com'}

EXAMPLE 5​

Write-Log -Level INFO -Message 'Database operation completed' -Tags @('Database', 'Performance')

PARAMETERS​

-Message​

The text message to write.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Arguments​

An array of objects used to format <Message>

Type: Array
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body​

An object that can contain additional log metadata (used in target like ElasticSearch)

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExceptionInfo​

Provide an optional ErrorRecord

Type: ErrorRecord
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tags​

An array of tags to associate with the log message for target routing. Defaults to 'Default' if not specified.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: @('Default')
Accept pipeline input: False
Accept wildcard characters: False

-Level​

{{ Fill Level Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

https://logging.readthedocs.io/en/latest/functions/Write-Log.md

https://logging.readthedocs.io/en/latest/functions/Add-LoggingLevel.md

https://github.com/EsOsO/Logging/blob/master/Logging/public/Write-Log.ps1

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github