W3cubDocs

/Ansible

community.general.logentries module – Module for tracking logs using logentries.com

Note

This module is part of the community.general collection (version 10.7.3).

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.logentries.

Synopsis

  • Sends logs to LogEntries in realtime.

Parameters

Parameter

Comments

logtype

aliases: type

string

Type of the log.

name

string

Name of the log.

path

string / required

Path to a log file.

state

string

Following state of the log.

Choices:

  • "present" ← (default)
  • "absent"
  • "followed"
  • "unfollowed"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

  • Requires the LogEntries agent which can be installed following the instructions at logentries.com.

Examples

- name: Track nginx logs
  community.general.logentries:
    path: /var/log/nginx/access.log
    state: present
    name: nginx-access-log

- name: Stop tracking nginx logs
  community.general.logentries:
    path: /var/log/nginx/error.log
    state: absent

Authors

  • Ivan Vanderbyl (@ivanvanderbyl)

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