Skip to main content
Help us improve Python packaging – donate today!

Collect usage for remote boxes without configuration.

Project Description

# om

Collect disk usage, memory and cpu load info on remote boxes without having to install any software - as long as you can SSH into it.


## Features

- Disk and memory usage
- CPU load
- Supports email alerts when resources get to a critical state (e.g. nearly full disk, low free memory, high cpu load, etc)


## Usage

To collect usage for a host:

```shell
$ ./om 192.168.0.1
```

To collect usage for multiple hosts:

```shell
$ ./om 192.168.0.2,box2
```

The tool also supports username, password and port if needed:

```shell
$ ./om root:mypass@mybox:44445
```

## Installation

No packages have been released yet. For a development preview, please fetch the code:

```shell
$ git clone https://github.com/overseer-monitoring/om.git
$ cd overseer-mini
$ pip install -r requirements.txt
$ ./om
```

## Extra customization (optional)

You can tweak the ssh and metrics settings by saving the configs into a json config file.

Running against a config file:

```shell
$ ./om -c <config.json>
```

### config.json format

#### Machines

The config file is a JSON and informs which machines are to be monitored.

```json
{
"machines": {
"my_rails_app": {
"host": "125.22.13.12",
"ssh": {
"username": "foo",
"password": "bar"
}
}
}
}
```

The only required field is ''host''. ''ssh'' is entirely optional if your local agent is already able to use keys to get to the machine.

#### Metrics

The "metrics" section allows you to further customize your monitoring. Our current metrics are:

- disk_usage
- memory_usage

For instance, disk usages are reported as critical when they reach 80% usage. If for a certain box you want to be critical when it reaches 50%, then:

```json
{
"machines": {
"my_rails_app": {
"host": "125.22.13.12",
"metrics": {
"disk_usage": {
"critical": "50%"
}
}
}
}
}
```

You can also override the default value globally:

```json
{
"machines": {
"my_rails_app": {
"host": "125.22.13.12",
},
"my_postgres": {
"host": "postgresbox",
"disk_usage": {
"critical": "60%"
}
}
},
"metrics": {
"disk_usage": {
"critical": "50%"
}
}
}
```

Release history Release notifications

This version
History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
om-0.0.1-py2-none-any.whl (13.1 kB) Copy SHA256 hash SHA256 Wheel 2.7 Aug 25, 2014
om-0.0.1.tar.gz (9.4 kB) Copy SHA256 hash SHA256 Source None Aug 25, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page