Kapacitor
An Ansible role to install, configure, and manage Kapacitor (an open source framework for processing, monitoring, and alerting on time series data).
Requirements
- Using
- Ansible 2.4 +
- Testing
- Molecule 2.5
Prior knowledge/experience with InfluxDB and Kapacitor is highly recommended. Full documentation is available here.
Installation
Either clone this repository, or install through Ansible Galaxy directly using the command:
ansible-galaxy install mplachter.kapacitor
Role Variables
The high-level variables are stored in the defaults/main.yml file. The most important ones being:
# Channel of Kapacitor to install (stable, unstable, nightly)
kapacitor_install_version: stable
More advanced configuration options are stored in the vars/main.yml file, which includes all of the necessary bells and whistles to tweak your configuration.
Dependencies
Access to an InfluxDB instance is required to use Kapacitor, though they do not need to be located on the same server (can be configured using the kapacitor_influxdb_urls variable). Apart from that, no other Ansible dependencies are required.
This role was tested and developed with Ansible 1.9.4.
Example Playbook
An example playbook is included in the test.yml file. There is also a Vagrantfile, which can be used for quick local testing leveraging Vagrant. Since Kapacitor's use-case is very user-specific, the main goal of this repo is to install, configure, and setup Kapacitor in a customizable way. Currently to enable TICKscripts, specify them as a dictionary in the kapacitor_tasks_to_enable variable like so:
kapacitor_tasks_to_enable:
- name: cpu_alert
type: stream
tick: cpu_alert.tick
dbrp: telegraf.default
Where tick is the path to the TICKscript file. If placed in the /files directory of the role repository, you can just specify the name directly (for example, cpu_alert.tick).
Contributions and Feedback
Any contributions are welcome. For any bugs or feature requests, please open an issue through Github.
License
MIT
Author
Created by Ross McDonald. Updated and maintained by Matt Plachter & Stanislav Popov