Skip to main content

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%"
}
}
}
```

Project details


Download files

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

Source Distribution

om-0.0.1.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

om-0.0.1-py2-none-any.whl (13.1 kB view details)

Uploaded Python 2

File details

Details for the file om-0.0.1.tar.gz.

File metadata

  • Download URL: om-0.0.1.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for om-0.0.1.tar.gz
Algorithm Hash digest
SHA256 fb209b13421ac5086fb332b67c9bf2ba098cbcbdd1b87e5e08365481faca6a20
MD5 3c4f55c347dea8d7d75abff76c4790e2
BLAKE2b-256 cc61f0776a5e4e0f960c24cfb504b50c80af3aa1e5cad8e202e3de66b5af59bb

See more details on using hashes here.

File details

Details for the file om-0.0.1-py2-none-any.whl.

File metadata

File hashes

Hashes for om-0.0.1-py2-none-any.whl
Algorithm Hash digest
SHA256 931312351f9952374f7f810f4ad4e0fca58c31dd973cc68603e2c69b83394e5d
MD5 756eaad70eb27950cf6d36d27cd72a92
BLAKE2b-256 4da774ecbe62825f1d9c4b04b3556a2fea5b783b61e05409441835ac58734ffc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page