community.general.loganalytics – Posts task results to Azure Log Analytics

Note

This plugin is part of the community.general collection (version 3.8.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.

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

New in version 2.4.0: of community.general

Synopsis

  • This callback plugin will post task results in JSON formatted to an Azure Log Analytics workspace.
  • Credits to authors of splunk callback plugin.

Requirements

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

  • Whitelisting this callback plugin.
  • An Azure log analytics work space has been established.

Parameters

Parameter Choices/Defaults Configuration Comments
shared_key
string / required
ini entries:

[callback_loganalytics]
shared_key = None

env:WORKSPACE_SHARED_KEY
Shared key to connect to Azure log analytics workspace.
workspace_id
string / required
ini entries:

[callback_loganalytics]
workspace_id = None

env:WORKSPACE_ID
Workspace ID of the Azure log analytics workspace.

Examples

examples: |
  Whitelist the plugin in ansible.cfg:
    [defaults]
    callback_whitelist = community.general.loganalytics
  Set the environment variable:
    export WORKSPACE_ID=01234567-0123-0123-0123-01234567890a
    export WORKSPACE_SHARED_KEY=dZD0kCbKl3ehZG6LHFMuhtE0yHiFCmetzFMc2u+roXIUQuatqU924SsAAAAPemhjbGlAemhjbGktTUJQAQIDBA==
  Or configure the plugin in ansible.cfg in the callback_loganalytics block:
    [callback_loganalytics]
    workspace_id = 01234567-0123-0123-0123-01234567890a
    shared_key = dZD0kCbKl3ehZG6LHFMuhtE0yHiFCmetzFMc2u+roXIUQuatqU924SsAAAAPemhjbGlAemhjbGktTUJQAQIDBA==

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/loganalytics_callback.html