community.general.sumologic – Sends task result events to Sumologic

Note

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

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.

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

Synopsis

  • This callback plugin will send task results as JSON formatted events to a Sumologic HTTP collector source

Requirements

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

  • Whitelisting this callback plugin

  • Create a HTTP collector source in Sumologic and specify a custom timestamp format of yyyy-MM-dd HH:mm:ss ZZZZ and a custom timestamp locator of "timestamp": "(.*”)

Parameters

Parameter Choices/Defaults Configuration Comments
url
string
ini entries:

[callback_sumologic]
url = None

env:SUMOLOGIC_URL
URL to the Sumologic HTTP collector source

Examples

examples: >
  To enable, add this to your ansible.cfg file in the defaults block
    [defaults]
    callback_whitelist = community.general.sumologic

  Set the environment variable
    export SUMOLOGIC_URL=https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/R8moSv1d8EW9LAUFZJ6dbxCFxwLH6kfCdcBfddlfxCbLuL-BN5twcTpMk__pYy_cDmp==

  Set the ansible.cfg variable in the callback_sumologic block
    [callback_sumologic]
    url = https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/R8moSv1d8EW9LAUFZJ6dbxCFxwLH6kfCdcBfddlfxCbLuL-BN5twcTpMk__pYy_cDmp==

Authors

  • Ryan Currah (@ryancurrah)