# errorFile

Specifies a file that receives bulk-mode failures along with the ClickHouse error response.

This parameter applies to omclickhouse: ClickHouse Output Module.

Name:

  errorFile

Scope:

  input

Type:

  word

Default:

  none

Required?:

  no

Introduced:

  not specified

## Description

If specified, records failed in bulk mode are written to this file, including their error cause. Rsyslog itself does not process the file any more, but the idea behind that mechanism is that the user can create a script to periodically inspect the error file and react appropriately. As the complete request is included, it is possible to simply resubmit messages from that script.

Note

When rsyslog has problems connecting to ClickHouse, a general error is assumed. However, if we receive negative responses during batch processing, we assume an error in the data itself (like a mandatory field is not filled in, a format error or something along those lines). Such errors cannot be solved by simply resubmitting the record. As such, they are written to the error file so that the user (script) can examine them and act appropriately. Note that e.g. after search index reconfiguration (e.g. dropping the mandatory attribute) a resubmit may be successful.

## Input usage

    module(load="omclickhouse")
    action(type="omclickhouse" errorFile="clickhouse-error.log")

## See also

See also omclickhouse: ClickHouse 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.