saltstack-formulas / filebeat-formula Goto Github PK

View Code? Open in Web Editor NEW

This project forked from cybacolt/filebeat-formula

5.0 34.0 37.0 46 KB

a formula to install and configure filebeat, a new alternative for logstash forwarder.

Home Page: http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html

License: Other

SaltStack 36.47% HTML 49.51% Ruby 11.88% Python 2.13%

filebeat-formula's Introduction

filebeat formula

Install and configure filebeat.

See the full Salt Formulas installation and usage instructions.

Available states

filebeat.install
filebeat.config
filebeat.service

filebeat.install

Installs the filebeat package.

filebeat.config

configures filebeat, and installs rc levels for startup on reboot.

Usage

See pillar.example for example configuration.

Please be aware not all config items will work with all versions of Filebeat:

close_older >= 1.1.0
multiline, include_lines, exclude_lines >= 1.2.0

Overriding defaults

This formula puts some system specific configuration in map.jinja. the may be overridden in your pillar data like so:

filebeat:
  lookup:
    config_source: salt://mycustom/filebeat/filebeat.jinja

filebeat.service

Starts the filebeat service.

Due to filebeat requiring tty to start, this state uses a SSH loopback to achieve this. (use_vt / sudoers !requiretty did not resolve this on 2015.8.x...)

Testing

Testing is done with Test Kitchen for machine setup and testinfra for integration tests.

Requirements

Python
Ruby
Docker

pip install -r requirements.txt gem install bundler bundle install bundle exec kitchen test

filebeat-formula's People

Contributors

Stargazers

Watchers

filebeat-formula's Issues

filebeat is restarted on every highstate run

Since #5 , the filebeat.service is a cmd.run without unless which means it's run on every highstate run. As I'm running highstate every 5 minutes, filebeat restarts every 5 minutes.

I changed cmd.run to cmd.wait locally in my repo but that unfortunately means the service is only started on config file changes (because of watch_in) but not if it is not running e.g. because of a crash. I'm not sure what a good way to solve this would look like.

Add 'filebeat' subdirectory to repo root

In order for this formula to work with GitFS or Salt's file_roots the state files need to live under a filebeat subdirectory. More explanation at the link below:

https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#repository-structure

Jinja variable 'str object' has no attribute 'paths'

Hello!

With no pillar data, the formula currently fails with this error. Here is the failed state:

       ----------
                 ID: filebeat.config
           Function: file.managed
               Name: /etc/filebeat/filebeat.yml
             Result: False
            Comment: Unable to manage file: Jinja variable 'str object' has no attribute 'paths'
            Started: 22:09:01.721626
           Duration: 18.875 ms
            Changes:

I found this while applying a test suite for this formula. Test suite and fix coming soon!

update needed

might need to update this formula with the most recent repositories location or at least mentionning for what Filebeat version this formula is

Modern implementation of this formula

I made a more modern implementation of this formula at https://github.com/johnkeates/filebeat-formula it might be worth rebasing this one on top of that.