interface.output

Selects whether mmexternal expects a JSON response from the external plugin.

This parameter applies to mmexternal: Support module for external message modification plugins.

Name:

interface.output

Scope:

input

Type:

string

Default:

json

Required?:

no

Introduced:

8.2606.0

Description

This parameter controls what the external program must write to standard output after each received message. It can be set to one of the following values:

  • "json" (default): The external program must write one JSON object, followed by a line feed. The object is merged into the rsyslog message.

  • "none": The external program is not expected to write a response. mmexternal sends the message and continues immediately.

Use "none" only for helpers that do not need to modify the rsyslog message, for example side-effect-only enrichment or notification programs. If such a helper writes substantial data to standard output, the helper may eventually block because rsyslog does not read responses in this mode.

Input usage

module(load="mmexternal")

action(
    type="mmexternal"
    binary="/path/to/helper"
    interface.output="none"
)

See also

See also mmexternal: Support module for external message modification plugins.

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

Contributing: Source & docs: rsyslog source project

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