ansible-role-logstash/README.md
2019-09-10 08:57:26 +02:00

104 lines
2.4 KiB
Markdown

# Ansible role: Logstash
[![Version](https://img.shields.io/badge/latest_version-1.0.0_dev-green.svg)](https://git.yaegashi.fr/nishiki/ansible-role-logstash/releases)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://git.yaegashi.fr/nishiki/ansible-role-logstash/src/branch/master/LICENSE)
Install and configure logstash
## Requirements
* Ansible >= 2.7
* Debian Stretch and Buster
## Role variables
* `logstash_major_version` set major version to install- (default: `7`)
* `logstash_plugins` - array with the plugins to install
```
- name: logstash-output-influxdb
state: present
```
* `logstash_config` - hash with the configuration (see [logstash documentation](https://www.elastic.co/guide/en/logstash/current/configuration.html))
```
path.data: /var/lib/logstash
path.logs: /var/log/logstash
```
- `logstash_inputs` - hash with the inputs configurations
```
file:
path: /var/log/syslog
beats:
port: 5444
```
- `logstash_outputs` - array with the outputs configuration
```
- >
file {
path => "/var/log/syslog"
codec => "json"
}
```
- `logstash_filters` - array with the filters configuration
```
- >
grok {
match => { "message" => "%{IP:client} %{WORD:method} %{URIPATHPARAM:request} %{NUMBER:bytes} %{NUMBER:duration}" }
}
```
## How to use
```
- hosts: server
roles:
- logstash
```
## Development
### Test syntax with yamllint
* install `python` and `python-pip`
* install yamllint `pip install yamllint`
* run `yamllint .`
### Test syntax with ansible-lint
* install `python` and `python-pip`
* install yamllint `pip install ansible-lint`
* run `ansible-lint .`
### Tests with docker
* install [docker](https://docs.docker.com/engine/installation/)
* install ruby
* install bundler `gem install bundler`
* install dependencies `bundle install`
* run the tests `kitchen test`
## License
```
Copyright (c) 2019 Adrien Waksberg
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```