community.general.syslog_json callback – sends JSON events to syslog

Note

This callback plugin is part of the community.general collection (version 8.6.8).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general. You need further requirements to be able to use this callback plugin, see Requirements for details.

To use it in a playbook, specify: community.general.syslog_json.

Callback plugin

This plugin is a notification callback. It sends information for a playbook run to other applications, services, or systems. See Callback plugins for more information on callback plugins.

Synopsis

  • This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format.

Requirements

The below requirements are needed on the local controller node that executes this callback.

  • whitelist in configuration

Parameters

Parameter

Comments

facility

string

Syslog facility to log as.

Default: "user"

Configuration:

  • INI entry:

    [callback_syslog_json]
syslog_facility = user

  • Environment variable: SYSLOG_FACILITY

port

string

Port on which the syslog server is listening.

Default: 514

Configuration:

  • INI entry:

    [callback_syslog_json]
syslog_port = 514

  • Environment variable: SYSLOG_PORT

server

string

Syslog server that will receive the event.

Default: "localhost"

Configuration:

  • INI entry:

    [callback_syslog_json]
syslog_server = localhost

  • Environment variable: SYSLOG_SERVER

setup

boolean

added in community.general 4.5.0

Log setup tasks.

Choices:

  • false

  • true ← (default)

Configuration:

Authors

  • Unknown

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.