Skip to content
This repository

Flexible and scalable monitoring framework

Merge pull request #1176 from driskell/bugs/fix_pip_install_missing_e…

…tc_modules

Fix missing modules folder in the pip installation
latest commit 55f444a8fd
Gabès Jean authored April 18, 2014
Octocat-spinner-32 bin Add: CLI allow help for sub commands April 15, 2014
Octocat-spinner-32 cli Add: CLI --download-only option for the install call April 15, 2014
Octocat-spinner-32 contrib Fix: deprecate shinken-admin, should be manage by a cli cmd in the fu… March 14, 2014
Octocat-spinner-32 doc Enh : Doc - Remove shinken-specific references April 16, 2014
Octocat-spinner-32 etc Merge branch 'master' of https://github.com/naparuba/shinken April 17, 2014
Octocat-spinner-32 external_commands Clean-up shell-scripts. July 16, 2012
Octocat-spinner-32 for_fedora Add man page for RPMs March 25, 2014
Octocat-spinner-32 inventory Fix: various setup.py fail like missing etc/modules or etc/packs, and… March 04, 2014
Octocat-spinner-32 libexec Change default check logfile storage dir April 15, 2014
Octocat-spinner-32 modules Fix: (reported by:6jo6jo) multi hostgroup/servicegroup entries. fix #… April 08, 2014
Octocat-spinner-32 share Enh: clean the repo before 2.0 January 02, 2014
Octocat-spinner-32 shinken Fix : SSL - SSL_VERIFYHOST = 2 is better than 1 April 17, 2014
Octocat-spinner-32 test Fix : Broken test after ssl fix April 17, 2014
Octocat-spinner-32 var Enh : Big one. Export modules from the python lib to another director… June 04, 2013
Octocat-spinner-32 windows Enh: disable teh injector by default, should be add for 2.2 only March 14, 2014
Octocat-spinner-32 .gitignore Enh gitignore March 22, 2014
Octocat-spinner-32 COPYING Change licence to AGPLv3. This must not so be important, but I don't … July 15, 2009
Octocat-spinner-32 Changelog Update Changelog with @geektophe feature April 06, 2014
Octocat-spinner-32 FOR_PACKAGERS Update FOR_PACKAGERS April 08, 2014
Octocat-spinner-32 MANIFEST.in Fix missing modules folder in the pip installation April 17, 2014
Octocat-spinner-32 README Rename README to README.rst and add a README symlink April 11, 2011
Octocat-spinner-32 README.rst Update README.rst March 06, 2014
Octocat-spinner-32 THANKS Fix: (reported by:jylenhofgfi) shinekn cli module got problem to be p… February 24, 2014
Octocat-spinner-32 clean.sh Add: move ini files into a etc/daemons directory. July 11, 2013
Octocat-spinner-32 setup.cfg Add: setup.py for packagers that need --root February 28, 2014
Octocat-spinner-32 setup.py TAG: go 2.0.1 April 17, 2014
Octocat-spinner-32 setuppackage.py delete missing configuration file. April 17, 2014
README.rst

Presentation of the Shinken project

Welcome to the Shinken project.

Shinken is a modern, Nagios compatible monitoring framework, 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.

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

Requirements

There are mandatory and conditional requirements for the installation methods which are described below.

Mandatory Requirements

shinken requires

  • Python 2.6 or higher (2.7 will get higher performances)
  • python-pycurl Python package for Shinken daemon communications
  • setuptools or distribute Python package for installation

Conditional Requirements

  • Python 2.7 is required for developers to run the test suite, shinken/test/
  • python-cherrypy3 (recommanded) enhanceddaemons communications, especially in HTTPS mode

Installing/Checking Common Requirements on Windows

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

Installing on Linux

How to install Shinken

You will need a specific user for running shinken :

useradd --user-group shinken

You simply need to launch:

python setup.py install

Update

Launch:

python setup.py update

It will only update the shinken lib and scripts, but won't touch your current configuration

Running

Shinken is installed with init.d scripts, enables them at boot time and starts them right after the install process ends. Based on your linux distro you only need to do:

chkconfig --add shinken chkconfig shinken on

or :

update-rc.d shinken defaults 20

Where is the configuration?

The configuration is on the directory, /etc/shinken.

Where are the logs?

Logs are in /var/log/shinken (what did you expect?)

I got a bug, how to launch the daemons in debug mode?

You only need to launch:

/etc/init.d/shinken -d start

Debug logs will be based on the log directory (/var/log/shinken)

I switched from Nagios, 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.

If you find a bug

Bugs are tracked in the issue list on GitHub . Always search for existing issues before filing a new one (use the search field at the top of the page). When filing a new bug, please remember to include:

  • A helpful title - use descriptive keywords in the title and body so others can find your bug (avoiding duplicates).
  • Steps to reproduce the problem, with actual vs. expected results
  • Shinken version (or if you're pulling directly from the Git repo, your current commit SHA - use git rev-parse HEAD)
  • OS version
  • If the problem happens with specific code, link to test files (gist.github.com is a great place to upload code).
  • Screenshots are very helpful if you're seeing an error message or a UI display problem. (Just drag an image into the issue description field to include it).
Something went wrong with that request. Please try again.