New PodeElasticsearchLoggingMethod - mdaneri/Pode GitHub Wiki

external help file: Pode-help.xml Module Name: Pode online version: PodeType: LoggingMethod schema: 2.0.0

New-PodeElasticsearchLoggingMethod

SYNOPSIS

Configures logging to Elasticsearch.

SYNTAX

DataFormat

New-PodeElasticsearchLoggingMethod -BaseUrl <String> -IndexName <String> [-FailureAction <String>]
 [-SkipCertificateCheck] [-AsUTC] [-DefaultTag <String>] [-DataFormat <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

ISO8601

New-PodeElasticsearchLoggingMethod -BaseUrl <String> -IndexName <String> [-FailureAction <String>]
 [-SkipCertificateCheck] [-AsUTC] [-DefaultTag <String>] [-ISO8601] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

The `New-PodeElasticsearchLoggingMethod` function configures logging for Elasticsearch, allowing log entries to be sent as documents to a specified Elasticsearch index.

EXAMPLES

EXAMPLE 1

New-PodeElasticsearchLoggingMethod -BaseUrl 'http://localhost:9200' -IndexName 'application-logs'

Sets up Elasticsearch logging with the specified base URL and index name.

PARAMETERS

-AsUTC

If present, converts timestamps to UTC.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-BaseUrl

The base URL for the Elasticsearch API, typically `http://<ELASTICSEARCH_SERVER_IP>:9200`.

Type: String
Parameter Sets: (All)
Aliases:

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

-DataFormat

The custom date format for log entries. Mutually exclusive with ISO8601.

Type: String
Parameter Sets: DataFormat
Aliases:

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

-DefaultTag

Sets a default tag for log entries. Defaults to `-`.

Type: String
Parameter Sets: (All)
Aliases:

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

-FailureAction

Specifies the action to take if the logging request fails. Valid values are `Ignore`, `Report`, and `Halt`. The default is `Ignore`.

Type: String
Parameter Sets: (All)
Aliases:

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

-IndexName

The name of the Elasticsearch index where log entries will be stored.

Type: String
Parameter Sets: (All)
Aliases:

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

-ISO8601

If set, uses the ISO 8601 date format for log entries. Mutually exclusive with DataFormat.

Type: SwitchParameter
Parameter Sets: ISO8601
Aliases:

Required: False
Position: Named
Default value: False
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

-SkipCertificateCheck

If present, skips SSL certificate validation when sending logs.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

System.Collections.Hashtable

NOTES

This function sends log entries to Elasticsearch by creating documents in the specified index.

RELATED LINKS

sss

⚠️ **GitHub.com Fallback** ⚠️