Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qk4l/zabbix-cachet
Python script which sync Zabbix IT Services with Cachet
https://github.com/qk4l/zabbix-cachet
cachet zabbix zabbix-cachet
Last synced: 14 days ago
JSON representation
Python script which sync Zabbix IT Services with Cachet
- Host: GitHub
- URL: https://github.com/qk4l/zabbix-cachet
- Owner: qk4l
- License: mit
- Created: 2016-04-02T16:19:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-06T09:32:31.000Z (4 months ago)
- Last Synced: 2024-08-01T19:39:53.221Z (3 months ago)
- Topics: cachet, zabbix, zabbix-cachet
- Language: Python
- Homepage:
- Size: 201 KB
- Stars: 80
- Watchers: 7
- Forks: 32
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zabbix-Cachet
This is python script which provides synchronisation between [Zabbix IT Services](https://www.zabbix.com/documentation/3.0/manual/it_services)
and [Cachet](https://cachethq.io/)
# Description
The idea of Zabbix-Cachet is providing the easiest way to export Zabbix terms to Cachet.
With this script you can maintain Cachet though Zabbix.
Zabbix-Cachet reads pre-configured [Zabbix IT Services](https://www.zabbix.com/documentation/3.0/manual/it_services) and automatically creates Cachet components.
After that Zabbix-Cachet periodically checks Zabbix triggers (that linked to you IT Services) and manipulate with Cachet incidents and Component statuses based on triggers.
Zabbix-Cachet communicate with Zabbix and Cachet via API interface.
To make it works you need a zabbix user with sufficient permissions to read triggers,
items of services that is exported to Cachet and Cachet`s API key.
# Features
* Automatically creates Cachet Components and Components group
* Automatically creates Cachet Incidents and update them with [acknowledgement messages](https://www.zabbix.com/documentation/3.0/manual/acknowledges)
* Allow to specify root IT service where Zabbix-Cachet will work
# Example
## Zabbix IT Services.
* _Cachet_ - `root_service` for zabbix-cachet script.
* _Bitbucket_, _Network Connectivity_ - parent services. They will be _Components Groups_ in Cachet.
* _GIT https_, _GIT ssh_ - Components in Cachet. Do not forget to set Zabbix trigger to this group.
## Cachet
# Requirements
* Cachet 2.2, 2.3
* Zabbix 2.X, 3.X, 4.0, 5.0, 6.0, 6.4, 7.0
* python 3.6+
# Installation
# Docker Installation
1. Create `/etc/zabbix-cachet.yml` file based `config-example.yml`.
2. Run Docker container
```
docker run --name zabbix-cachet -v /etc/zabbix-cachet.yml:/config.yml qk4l/zabbix-cachet
```
3. Drink a cup of tea (optional)
## Python package
1. Install python package via pip
```bash
pip install zabbix-cachet
```
2. Rename `config-example.yml` to `config.yml` and fill a file with your settings.
3. Define `CONFIG_FILE` environment variable which point to your `config.yml` or change current work directory to folder with config
4. Launch `zabbix-cachet`
## Apt (outdated release)
1. Add official Zabbix-Cachet [PPA](https://launchpad.net/~reg-tem4uk/+archive/ubuntu/zabbix-cachet):
```bash
add-apt-repository ppa:reg-tem4uk/zabbix-cachet
apt-get update
```
2. Install the package: `apt-get install zabbix-cachet`
3. Configure it: `nano /etc/zabbix-cachet.yml`
4. Restart it: `systemctl enable zabbix-cachet && systemctl restart zabbix-cachet`
# Configuration
Settings are storing in `config.yml` file which should be placed in script's working directory.
If you want to use another path for `config.yml` use `CONFIG_FILE` environment variable.