community.general.logentries callback – Sends events to Logentries
Note
This callback plugin is part of the community.general collection (version 9.5.1).
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.logentries
.
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 callback plugin will generate JSON objects and send them to Logentries via TCP for auditing/debugging purposes.
Before 2.4, if you wanted to use an ini configuration, the file must be placed in the same directory as this plugin and named
logentries.ini
.In 2.4 and above you can just put it in the main Ansible configuration file.
Requirements
The below requirements are needed on the local controller node that executes this callback.
whitelisting in configuration
certifi (Python library)
flatdict (Python library), if you want to use the
flatten
option
Parameters
Parameter |
Comments |
---|---|
URI to the Logentries API. Default: Configuration:
|
|
Flatten complex data structures into a single dictionary with complex keys. Choices:
Configuration:
|
|
HTTP port to use when connecting to the API. Default: Configuration:
|
|
Port to use when connecting to the API when TLS is enabled. Default: Configuration:
|
|
The logentries Configuration:
|
|
Toggle to decide whether to use TLS to encrypt the communications with the API server. Choices:
Configuration:
|
Examples
examples: >
To enable, add this to your ansible.cfg file in the defaults block
[defaults]
callback_whitelist = community.general.logentries
Either set the environment variables
export LOGENTRIES_API=data.logentries.com
export LOGENTRIES_PORT=10000
export LOGENTRIES_ANSIBLE_TOKEN=dd21fc88-f00a-43ff-b977-e3a4233c53af
Or in the main Ansible config file
[callback_logentries]
api = data.logentries.com
port = 10000
tls_port = 20000
use_tls = true
token = dd21fc88-f00a-43ff-b977-e3a4233c53af
flatten = false