Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

254 lines (167 sloc) 7.544 kb

Presentation of the Shinken project

Welcome to the Shinken project.

Shinken is a modern, Nagios compatible monitoring tool, written in Python. Its main goal is to give users a flexible architecture for their monitoring system that is designed to scale to large environments. It’s as simple as the “cloud computing” makerting slides, but here, it’s real!

Shinken is backwards-compatible with the Nagios configuration standard and plug-ins. It works on any operating system and architecture that supports Python, which includes Windows and GNU/Linux.

Requirements

There are common and conditional requirements for the three installation methods which are described below. Keep in mind that you should not mix the methods. Thus if you installed with the first method, you have to use that method as well when you update or remove your installation.

The recommended method is the "install script" which tries to do all the necessary steps for you. You can choose that one if your OS is compatible with it. If you choose it, you can skip/skim

over the requirements section and come back to it later if needed.

However, it is recommended to check any requirement manually to confirm they are installed correctly.

Common Requirements

shinken requires

  • `Python`__ 2.4 or higher (Python 2.6 or higher is recommended if you want to use the Web interface)
  • `setuptools`__ or distribute Python package for installation (see below)
  • `pyro`__ Python package version less then 4.14 for all and not 3.x for debian squeeze
  • `multiprocessing`__ Python package when using Python 2.4 or 2.5 (multiprocessing is already included in Python 2.6 and higher)
  • python-devel Package

Conditional Requirements

If you plan to use the livestatus module or the web interface, you will also need the following Python packages.

Installing/Checking Common Requirements on Windows

There is an installation guide for Windows and an installation package.

Installing/Checking Common Requirements on Linux

Python

For Python itself, the version which comes with almost all distributions should be okay.

Pyro

Under ubuntu, you can grab the Pyro module with:

sudo apt-get install pyro

Under other distributions, you can search for it:

yum search pyro

And if you do not find it, or need to install a specific version, you can install it from PyPI:

easy_install pyro

How to install Shinken

Preliminary Steps

  • Download and untar shinken.

  • Create a user account and a group for shinken on your system (not necessary if using install script):

    useradd --user-group shinken
    usermod --lock shinken
    

Important Note:: NEVER MIX THE DIFFERENT INSTALLATION METHODS. THIS CAUSES PROBLEMS. CHOOSE ONE AND UNINSTALL BEFORE TRYING THE OTHER.

First method: install script (recommended for end users)

Install

You can use the install script utility located at the root of the shinken sources. The script creates the user and group, installs all dependencies and then it installs shinken. It is compatible with Debian, Ubuntu, Centos/Redhat 5.x and 6.x The only requirement is an internet connection for the server on which you want to install shinken. It also allows to modify the installation folder in a configuration file.

If you want shinken installed in seconds (default in /usr/local/shinken), just run

install -i

see install.d/README file for further information.

Update

1 - grab the latest shinken archive and extract its content

2 - cd into the resulting folder

3 - backup shinken configuration plugins and addons and copy the backup id:

./install -b

4 - remove shinken (if you installed addons with the installer say no to the question about removing the addons):

./install -u

5 - install the new version:

./install -i

6 - restore the backup:

./install -r backupid

Remove

cd into shinken source folder and run::
./install -u

Running

The install script also installs some init.d scripts, enables them at boot time and starts them right after the install process ends.

Second method: district directory (offline compatible)

Install

In fact you can install the application by using the setup.py script. No compilation is needed! setup.py will install the shinken library in the python path, create the /etc/shinken and /var/lib/shinken directory (you can change them in the setup.cfg file before launching setup.py). You will need the python-setuptools package for it. Then just run:

sudo python setup.py install --install-scripts=/usr/bin/

Update

For this way you can launch ::
sudo python setup.py update --install-scripts=/usr/bin/

Remove

There is a script called clean.sh in the source directory for this task. It contains relative paths so it should be run from within the source dir. Beware, it will delete all Shinken related files!

Running

The setup.py installs some init.d scripts, let's use them:

/etc/init.d/shinken-scheduler start
/etc/init.d/shinken-poller start
/etc/init.d/shinken-reactionner start
/etc/init.d/shinken-broker start
/etc/init.d/shinken-arbiter start

Third method: all in a directory (ugly but quick method ;)

Install

After unpacking the tarball move the shinken directory to the desired destination and give it to the shinken user:

mv shinken /usr/local
chown -R shinken:shinken /usr/local/shinken

Update / Remove

Should be easy here.

Running

It's easy, there is already a launch script for you:

shinken/bin/launch_all.sh

Where is the configuration?

The configuration is where you put the etc directory, /etc/shinken. (in /usr/local/shinken/etc for the quick and dirty method, /etc/shinken for the first two methods).

The nagios.cfg file is meant to be shared with Nagios. All Shinken specific objects (like links to daemons or realms) are in the file shinken-specific.cfg.

Do I need to change my existing Nagios configuration?

No, there is no need to change the existing configuration - unless you want to add some new hosts and services. Once you are comfortable with Shinken you can start to use its unique and powerful features.

Learn more about how to use and configure Shinken

Jump to the Shinken documentation wiki.

Known bugs

You can consult the open issues list or submit a new issue at: https://github.com/naparuba/shinken/issues

Jump to Line
Something went wrong with that request. Please try again.