Skip to content

CodersOfTheNight/oshino

Repository files navigation

About

Oshino - named after character Meme Oshino from anime called Bakemonogatari:

Meme Oshino (忍野 メメ, Oshino Meme) is a middle-aged man who lives with the mysterious Shinobu Oshino in an abandoned cram school building in the town Koyomi Araragi resides in Bakemonogatari. An expert in the supernatural, he is the reason why Koyomi was able to return back to normal after being bitten by a vampire, and he becomes Koyomi's informant when it comes to oddities for some time. Source

Just like anime character, this service likes to deal with supernatural - system availability.

Heavily inspired by collectd and riemann-tools, and unintentionally similar to python-diamond

Alerting and Monitoring based on Riemann

Build Status Coverage Status Documentation Status

Requirements

  • Python 3.5+ version
  • Have Riemann node running

How to install

pip install oshino

Quickstart

It is highly recommended for new users to use Quickstart Guide

Riemann. What? Why? How?

Riemann is a backbone of this system. It does alerting, it receives metrics, it aggregates metrics and it decides where to send them (eg.: Graphite, Logstash). However, it is rather unknown to the most of people, and configuring can be not trivial at all.

To mitigate this problem, documentation for setuping Riemann for this scenario has been made: riemann

Example config

---
interval: 10
riemann:
  host: localhost
  port: 5555
agents:
  - name: health-check
    module: oshino.agents.http_agent.HttpAgent
    url: http://python.org
    tag: healthcheck

Custom Agents

Documentation about additional agents can be found here

More documentation

More documentation can be found under docs directory

Contributing

Refer to CONTRIBUTING.md