checkpath

Defines the health-check endpoint that omhttp polls to decide when to resume after suspension.

This parameter applies to omhttp: HTTP Output Module.

Name:

checkpath

Scope:

input

Type:

word

Default:

input=none

Required?:

no

Introduced:

Not specified

Description

The health check path you want to use. Do not include the leading slash character. If the full path looks like localhost:5000/my/path, checkpath should be my/path.

When this parameter is set, omhttp utilizes this path to determine if it is safe to resume (from suspend mode) and communicates this status back to rsyslog core.

This parameter defaults to none, which implies that health checks are not needed, and it is always safe to resume from suspend mode.

Important - Note that it is highly recommended to set a valid health check path, as this allows omhttp to better determine whether it is safe to retry.

See the rsyslog action queue documentation for more info regarding general rsyslog suspend and resume behavior.

Input usage

module(load="omhttp")

action(
    type="omhttp"
    checkPath="health"
)

See also

See also omhttp: HTTP Output Module.

Support: rsyslog Assistant | GitHub Discussions | GitHub Issues: rsyslog source project

Contributing: Source & docs: rsyslog source project

© 2008–2025 Rainer Gerhards and others. Licensed under the Apache License 2.0.