Project

nephelae

0.0
No commit activity in last 3 years
No release in over 3 years
Nephelae is a daemon process that will upload custom cloud watch metrics in AWS
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Nephelae

The Nephelae were the nymph of clouds (http://www.theoi.com/Nymphe/Nephelai.html) carrying water from Earth to Heaven. In this particular case the nephelae carry data from servers to Amazon EC2 Cloud Watch. It was written to send disk space and memory usage of EC2 servers but can be extended to query any metrics and upload them on a regular basis.

For example the Redis plugin will collect the UsedMemory, ConnectedSlaves, ConnectedClients, ChangesSinceLastSave, MasterIOSecondsAgo, MasterLinkStatus and Up of a Redis instance and send this to AWS CloudWatch. We use this to put CloudWatch Alarms on the Up and MasterLinkStatus metrics to notify if Redis goes down or loses connection with the Master

The Nephelae gem contains a daemon process which has a number of plugins to collect stats. The daemon process is configured through a yaml file

Installation

To install as a gem

$ gem install nephelae

Usage

To run the nephelae deamon

$ nephelae start

This will start with default settings looking for a config yaml file in .etc/nephelae.yml. It will use /var/log as a log directory and /var/run for a pid directory

To start in the background (this uses the daemon gem http://daemons.rubyforge.org/)

$ nephelae start --piddir /home/nephelae/nephelae.pid --loglevel debug

To start in the foreground

$ nephelae --foreground

Other command line options

--loglevel *level* (debug, info, warn, error, fatal) default: warn
--config *path*
--instance-name *override the instance-id*

Configuration

The config yaml file is used to define the AWS access keys and plugin settings

An example configuration file

:aws_secret_access_key: your_secret_key
:aws_access_key_id: your_access_key
:region: ec2_region
:plugins:
  :disk_space:
    :plugin_class: DiskSpace
    :path: /
    :schedule: 1m
  :mem_usage:
    :plugin_class: MemUsage
    :schedule: 1m

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request