Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/madflojo/automatron

Infrastructure monitoring framework turning DevOps runbooks into automated actions
https://github.com/madflojo/automatron

devops devops-tools docker health-check jinja2 monitoring python remote-execution runbook self-healing

Last synced: about 2 months ago
JSON representation

Infrastructure monitoring framework turning DevOps runbooks into automated actions

Host: GitHub
URL: https://github.com/madflojo/automatron
Owner: madflojo
License: apache-2.0
Archived: true
Created: 2016-05-15T22:25:35.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2018-09-02T05:34:18.000Z (over 6 years ago)
Last Synced: 2024-08-01T06:21:42.656Z (5 months ago)
Topics: devops, devops-tools, docker, health-check, jinja2, monitoring, python, remote-execution, runbook, self-healing
Language: Python
Homepage: https://automatron.io
Size: 879 KB
Stars: 393
Watchers: 30
Forks: 59
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

[![Build Status](https://travis-ci.org/madflojo/automatron.svg?branch=master)](https://travis-ci.org/madflojo/automatron) [![Coverage Status](https://coveralls.io/repos/github/madflojo/automatron/badge.svg?branch=master)](https://coveralls.io/github/madflojo/automatron?branch=master)

![Automatron](https://raw.githubusercontent.com/madflojo/automatron/master/docs/img/logo_huge.png)

Automatron is a framework for creating self-healing infrastructure. Simply put, it detects system events & takes action to correct them.

The goal of Automatron is to allow users to automate the execution of common tasks performed during system events. These tasks can be as simple as **sending an email** to as complicated as **restarting services across multiple hosts**.

![Automatron Dashboard](https://raw.githubusercontent.com/madflojo/automatron/develop/docs/img/dashboard.png)

## Features

* Automatically detect and add new systems to monitor
* Monitoring is executed over SSH and completely **agent-less**
* Policy based Runbooks allow for monitoring policies rather than server specific configurations
* Supports Nagios compliant health check scripts
* Allows dead simple **arbitrary shell commands** for both checks and actions
* Runbook flexibility with **Jinja2** templating support
* Pluggable Architecture that simplifies customization

## Runbooks

The core of Automatron is based around **Runbooks**. Runbooks are policies that define health checks and actions. You can think of them in the same way you would think of a printed runbook. Except with Automatron, the actions are automated.

### A simple Runbook example

The below runbook is a very basic example, it will check if NGINX is running (every 2 minutes) and restart it after 2 unsuccessful checks.

```yaml+jinja
name: Check NGINX
schedule: "*/2 * * * *"
checks:
nginx_is_running:
execute_from: target
type: cmd
cmd: service nginx status
actions:
restart_nginx:
execute_from: target
trigger: 2
frequency: 300
call_on:
- WARNING
- CRITICAL
- UNKNOWN
type: cmd
cmd: service nginx restart
```

The above actions will be performed every 300 seconds (5 minutes) until the health check returns an OK status. This delay allows time for NGINX to restart after each execution.

### A complex Runbook with Jinja2

This next runbook example is a more complex version of the above. In this example we will use Jinja2 and Automatron's Facts to enhance our runbook further.

```yaml+jinja
name: Check NGINX
{% if "prod" in facts['hostname'] %}
schedule:
second: */20
{% else %}
schedule: "*/2 * * * *"
{% endif %}
checks:
nginx_is_running:
execute_from: target
type: cmd
cmd: service nginx status
actions:
restart_nginx:
execute_from: target
trigger: 2
frequency: 300
call_on:
- WARNING
- CRITICAL
- UNKNOWN
type: cmd
cmd: service nginx restart
remove_from_dns:
execute_from: remote
trigger: 0
frequency: 0
call_on:
- WARNING
- CRITICAL
- UNKNOWN
type: plugin
plugin: cloudflare/dns.py
args: remove [email protected] apikey123 example.com --content {{ facts['network']['eth0']['v4'][0] }}
```

The above example uses **Jinja2** and **Facts** to create a conditional schedule. If our target server has a hostname that contains the word "prod" within it. The schedule for the health check will be every 20 seconds. If not, it will be every 2 minutes.

Another addition is the `remove_from_dns` action, which will remove the target server's DNS entry using the **CloudFlare DNS** plugin.

By using **Facts** and **Jinja2** together you can customize a single runbook to cover unique actions for multiple hosts and environments.

## Stay in the loop

[![Twitter Follow](https://img.shields.io/twitter/follow/automatronio.svg?style=flat-square)](https://twitter.com/automatronio) [![Gitter](https://badges.gitter.im/madflojo/automatron.svg)](https://gitter.im/madflojo/automatron?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

## License

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