nagira 0.2.5

data/History.md

@@ -0,0 +1,89 @@
+### v.0.2.5
+
+* Fri Mar 15 2013 -- Dmytro Kovalov
+  - Environment variables support and defaults file:
+    - `NAGIRA_TTL`
+    - `NAGIRA_BG_PARSING`
+    - `NAGIRA_PORT` - see Sinatra `set :port`
+    - `NAGIRA_BIND` - see Sinatra `set :bind`
+  - Packaged as gem
+    - nagira and nagira-setup binaries
+    - cleaner init.d script, support for Debian and RedHat
+    - defaults file in `/etc/sysconfig` or `/etc/default`
+    - tasks to check configuration by user
+  - Add partial ActiveSupport routes
+    - `/_objects/host` works as well as `/_objects/hosts`
+    - selection objects by ID is TODO
+* Feb 19, 2013 -- Dmytro Kovalov    
+  - Background parser. 
+  
+      To avoid delays on HTTP request from user. All data are parsed in separate thread.
+    - configurable TTL for background parsing
+    - can be disabled
+  - Start-up section for the Nagira app. 
+
+      All Nagios files are validated at start-up, rather than on first HTTP request. 
+
+      If there are permission problem or file don't exist error is reported to user.
+* Feb 9, 2013    
+  - Merge all custom changes to `ruby-nagios` into upstream, use `ruby-nagios` as gem, not git sub-module
+  - `nagios.cfg` file selection is in `ruby-nagios` now. 
+
+      Look for config in `/etc/nagios*/` and `/usr/local/nagios/etc/`. Can be overridden by `NAGIOS_CFG_FILE` environment.
+  
+### v.0.2.1 
+
+* Wed Dec 19 2012 - Dmytro Kovalov
+  - fix for DOS formatted and spaces in config ; better error reporting for spec. fixes #8
+  - Switch to markdown in documentation: README, CONFIGURAION etc.
+  - Configuration documentation. Examples of usage for JSON: example files and scripts.
+  - Nagira::INSTALL configuration constant. Use Nagira::INSTALL for init.d creation.
+  - ERB  template for /etc/init./d file
+  - Fixes for YARD formatting
+  - Use Travis CI for Nagira testing
+* Thu Oct  4 19:45:00 JST 2012 
+
+###  v.0.2.0
+
+  - lot of bug fixes
+  - API: first working PUT API for process host status and process service status external commands
+* 2012-09-28 Dmytro Kovalov - v. 0.1.5
+  - many changes for testing files nagios.cfg, objects, status. Tested to work both in dev/test and production environments. 
+  - more documentation
+  - API: additional modifier for output: `_full`. By default now `/_status` returns Hash with hoststatus only. Use ../_full to get both hoststatus and sevicestatus.
+
+### v. 0.1.4  
+
+* 2012-09-26 Dmytro Kovalov - 
+  - added support for JSON-P parameters (?callback=<nam>)
+  - change API to have all keywords underscored, to avoid clashes with object names (`/_status`, `_objects`, `/_status/_list` etc).
+
+### v. 0.1.3  
+
+* 2012-06-8 Dmytro Kovalov 
+  - specs for /config, /status, /objects - simple page loads and data
+    checks;
+  - /api route;
+  - bugfixes;
+  - YARD documentation;
+
+### v. 0.1.2  
+
+* 2012-06-2 Dmytro Kovalov 
+  - spec for configuration files 
+  - spec for basic responses from Sinatra (`GET /objects`, `GET /status`)
+  - CONFIGURATION.rdoc
+  - configuration cleanup
+* 2012-05-22 Dmytro Kovalov
+  - start using Gemfile 
+  - INSTALL.rdoc - simple description of installation procedure
+* 2012-01-12 Dmytro Kovalov
+  - History.rdoc and version.txt files
+  - Routes for objects configuration GET's
+  - FEATURES.rdoc
+  - YARD documentation 
+* 2012-01-02 Dmytro Kovalov
+  - First Sinatra application to return service state information
+* 2011-12-25 @dmytro
+  - Started Github project
+

data/Rakefile

@@ -0,0 +1,128 @@
+require 'fileutils'
+require_relative 'lib/nagira'
+
+def log_user msg
+  puts "#{Time.now} -- #{msg.chomp}"
+end
+
+namespace :doc do
+  
+  desc 'Generate YARD documentation'
+  task :yard do
+    sh 'yardoc'
+  end
+
+end
+
+namespace :config do
+
+  @nagira_root   = File.dirname File.expand_path __FILE__ # Where Nagira installed
+  @nagira_config = File.join(@nagira_root, 'config')      # Config directory of Nagira installation
+
+  target_os = nil
+
+  %x{ sherlock }.split($\).each do |line|
+    next unless line =~ /^FAMILY=/
+    l,target_os = line.chomp.split '='
+    target_os = target_os.chomp.strip.to_sym
+  end
+  
+  namespace :test do
+
+    desc "Test Nagira production config: Nagios files in proper locations and parseable"
+    task :prod do 
+      ENV['RACK_ENV'] = 'production'
+      Rake::Task['config:test:test'].invoke
+    end
+
+    desc "Test Nagira installation: test Nagios files and parse"
+    task :install do 
+      ENV['RACK_ENV'] = 'test'
+      Rake::Task['config:test:test'].invoke
+    end
+
+    task :test do
+      p "Starting test in #{ENV['RACK_ENV']} environment"
+      sh "rspec --format doc --color spec/00_configuration_spec.rb"
+    end
+
+  end
+
+  desc "Create Nagira configuration, allow start on boot and start it"
+  task :all => [:config, :chkconfig, :start]
+
+  def test?
+    ENV['RAKE_ENV'] == 'test'
+  end
+
+  etc     = test? ? 'tmp/etc' : "/etc"
+  init_d  = File.join etc, 'init.d'
+
+  directory etc
+  directory init_d
+
+
+  desc "Create configuration for Nagira in /etc"
+  task :config => [:init_d, :defaults]
+
+
+  #desc "Install /etc/init.d startup file for Nagira"
+  task :init_d => init_d do
+    src = File.join(@nagira_config, 'nagira.init_d')
+    dst = "#{init_d}/nagira"
+
+    FileUtils.copy  src, dst
+    FileUtils.chown 0, 0, dst unless test?
+    FileUtils.chmod 0755, dst
+
+    log_user "Installed startup file at #{dst}"
+  end
+
+  #desc "Install defaults file for Nagira service in /etc"
+  task :defaults do 
+    src = File.join(@nagira_config, 'nagira.defaults')
+    dst = case target_os
+          when :rh
+            '/etc/sysconfig/nagira'
+          when :debian
+            '/etc/default/nagira'
+          else
+            log_user "Unknown or unsupported target OS: #{target_os}"
+            log_user "    >>> Skipped defaults file installation"
+            next
+          end
+    unless File.exists? dst
+      FileUtils.copy src, dst
+      FileUtils.chown 0, 0, dst unless test?
+      FileUtils.chmod 0644, dst
+      
+      log_user "Installed new defaults file for Nagira in #{dst}."
+      log_user "    >>> You might want to tune some of the variables."
+    end
+  end
+
+  desc "Start Nagira API service"
+  task :start => [:init_d, :defaults] do
+    log_user "Starting Nagira for the first time"
+    sh "/etc/init.d/nagira start"
+  end
+  
+  desc "Configure Nagira to start on system boot"
+  task :chkconfig => [:init_d, :defaults] do
+
+    log_user "Configuring Nagira to start at boot"
+    case target_os
+    when :rh
+      sh "/sbin/chkconfig --add nagira"
+      sh "/sbin/chkconfig nagira on"
+    when :debian
+      sh "/usr/sbin/update-rc.d nagira defaults"
+    else
+      abort "Unknown or unsupported target OS: #{target_os}"
+    end
+    log_user "[OK]"
+  end
+
+end
+
+

data/bin/nagira

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+#
+begin
+  require 'app.rb'
+rescue LoadError => e
+  require 'rubygems'
+  path = File.expand_path '../../lib', __FILE__
+  $:.unshift(path) if File.directory?(path) && !$:.include?(path)
+  require 'app.rb'
+end
+Nagira.run!

data/bin/nagira-setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+#
+
+path = File.expand_path '..', __FILE__
+
+print %x{ cd #{path} && rake #{ARGV[0] || '-T'} }.gsub(/^rake/, File.basename(__FILE__))

data/config/defaults.rb

@@ -0,0 +1,74 @@
+
+
+##
+# This file sets some constants, that are used as defaults in Nagira
+# application. Instead of changing this please modify
+# config/environment.rb file to match your requirements. Settings in
+# environment.rb file override these defaults.
+#
+# Exception is ::DEFAULT[:ttl] which is not overriden by environment.rb
+# and should be changed here.
+
+
+DEFAULT = {
+   
+  format_extensions: '\.(json|yaml|xml)$', #  Regex for available
+                                           #  formats: xml, json, yaml
+
+  format: :xml, # default format for application to send output, if
+                # format is not specified
+
+
+  # No path to file configuration file by default. Main nagios config
+  # is defined by +nagios_cfg_glob+ or by Sintra's
+  # +settings.nagios_cfg+ variable. 
+  #
+  # status_cfg and objects_cfg are defined by parsing of nagios_cfg
+  # file. Sinatra's setting override parsed values.
+  nagios_cfg: nil, 
+  status_cfg: nil,
+  objects_cfg: nil,
+  command_file: nil,
+  
+  ##
+  # ttl used in Nagios::TimedParse module - extension
+  # to Nagios modules.
+  #
+  # @see Nagios::TimedParse
+  #
+  # Set some minimum interval for re-parsing of the status file: even
+  # if file changes often, we do not want to parse it more often, then
+  # this number of seconds. To disable timed parsing, set
+  # ttl to 0 or negative number.
+  
+  ttl: ENV['NAGIRA_TTL'].to_i || 5,
+  
+  ##
+  # start_background_parser used in Nagios::BackgroundParse class.
+  #
+  # @see Nagios::BackgroundParse
+  #
+  # If set to true then use background parser. This will prevent
+  # parsing delays on client request. Background parserruns on
+  # intervals slightly shorter than `ttl` to ensure that data are
+  # always updated. So, `ttl` should be larger than 1.
+  #
+  start_background_parser: (ENV['NAGIRA_BG_PARSING'] == '1')
+}
+
+require 'sinatra'
+class Nagira < Sinatra::Base
+
+##
+# For every key in the DEFAULT hash create setting with the same name
+# and value. Values can be overrriden in environment.rb file if
+# required.
+# @method define_methods_for_defaults
+configure do
+  ::DEFAULT.each do |key,val|
+    set key,val
+  end
+end
+
+
+end

data/config/environment.rb

@@ -0,0 +1,44 @@
+
+class Nagira < Sinatra::Base
+
+  disable :protection
+  enable :logging
+
+  set :port, ENV['NAGIRA_PORT'].to_i if ENV['NAGIRA_PORT']
+  set :bind, ENV['NAGIRA_BIND'] if ENV['NAGIRA_BIND']
+
+  configure do 
+    set :format, :json
+  end
+
+  if development?
+    require 'sinatra/reloader'
+    register Sinatra::Reloader
+    also_reload(File.dirname(File.dirname(__FILE__))+"/*.rb")
+    also_reload(File.dirname(File.dirname(__FILE__))+"/{app,lib}/**/*.rb")
+  end
+
+  ##
+  # Development and test environments use local files located in the
+  # development tree: ./test/data.
+  configure :development, :test do 
+
+    dir = File.expand_path(File.dirname(__FILE__) + '/../test/data/')
+    
+    set :nagios_cfg, "#{dir}/nagios.cfg"
+    set :status_cfg, "#{dir}/status.dat"
+    set :objects_cfg, "#{dir}/objects.cache"
+    set :command_file, "/tmp/nagios.cmd"
+
+    set :show_exceptions, false
+  end
+  
+
+# configure :production do
+#   # If your nagios.cfg file is in 'standard' location (in RH and
+#   # Debian it usially installed under /etc/nagios(3)?) you don't need
+#   # to define nagios_cfg.
+#   set :nagios_cfg, nil
+# end
+
+end

data/config/nagira.defaults

@@ -0,0 +1,66 @@
+#
+# Defaults configuration file for Nagira
+# --------------------------------------------
+#
+# ----------------------
+# Port. Default 4567
+# ----------------------
+# NAGIRA_PORT=
+#
+# ----------------------
+# BIND
+# ----------------------
+# String specifying the hostname or IP address of the interface to
+# listen on when the :run setting is enabled. The default value –
+# '0.0.0.0' – causes the server to listen on all available
+# interfaces. To listen on the loopback interface only, use: 'localhost'
+#
+# NAGIRA_BIND=localhost
+#
+# ----------------------
+# Environment
+# ----------------------
+# Usually needs to be production
+#
+# RACK_ENV=production
+#
+# ----------------------
+# Nagira user
+# ----------------------
+# Usually nagira process should be run by same user ID as Nagios. In
+# many cases this is nagios user.
+#
+# NAGIRA_USER=nagios
+#
+# ----------------------
+# RVM
+# ----------------------
+# RVM_STRING="rvm use default"
+#
+# ----------------------
+# Log file
+# ----------------------
+# NAGIRA_LOG=/var/log/nagios/nagira.log
+#
+# ----------------------
+# TTL for data
+# ----------------------
+# Number of seconds between re-parses. All Nagios file are parsed no
+# more often than this. Default is 5 sec. Setting this to 0 or
+# negative number disables TTL and backgroiund prser as well.
+#
+# NAGIRA_TTL=20
+#
+# ----------------------
+# Background parsing
+# ----------------------
+# Set this to 0, to disable background parsing.
+# NAGIRA_BG_PARSING=1
+#
+# ----------------------
+# Nagios configuration file
+# ----------------------
+# Where main Nagios configuration file is located. usually this does
+# not need to change.
+#
+# NAGIOS_CFG_FILE=/etc/nagios/nagios.cfg

data/config/nagira.init_d

@@ -0,0 +1,133 @@
+#!/bin/bash
+### BEGIN INIT INFO
+# Provides:          nagira
+# Required-Start:    
+# Required-Stop:     
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Nagira API application for Nagios
+# Description:       Controls Nagira API application for Nagios
+### END INIT INFO
+#
+# nagira:       
+#
+# Version:      1
+#
+# chkconfig: -  20 99
+# description: Start-up file for Nagira monitoring component, Nagios RESTful API. See also: http://dmytro.github.com/nagira
+# processname: ruby /.../nagira
+# config: /etc/sysconfig/nagira, /etc/default/nagira
+
+process_name="Sinatra Nagira services"
+
+pid_file=/var/run/nagira.pid
+
+
+load_defaults () {
+    which sherlock > /dev/null 2>&1 && eval $(sherlock | grep FAMILY) || { echo "sherlock not found"; exit 2; }
+    
+    case $FAMILY in
+        'rh')
+            DEFAULTS=/etc/sysconfig/nagira ;;
+        'debian')
+            DEFAULTS=/etc/default/nagira ;;
+        *)
+            echo "Unknown OS or distribution version: $FAMILY"
+        exit 1
+        ;;
+    esac
+    source $DEFAULTS || { echo "Can not load defaults file" ; exit 1 ; }
+}
+
+
+##
+# Some reasonable defaults if not set in defaults file
+#
+RACK_ENV=${RACK_ENV:-production}
+NAGIRA_USER=${NAGIRA_USER:-nagios}
+RVM_STRING=${RVM_STRING:-"true"} # i.e. do nothing special
+NAGIRA_LOG=${NAGIRA_LOG:-/var/log/nagios/nagira.log}
+# There's no default for NAGIOS_CFG_FILE. Default is actually to have
+# it unset, Nagira would be able to find nagios config if it is in one
+# of the standard locations (/etc or /usr/local). If your Nagios
+# installation is less than standard, you can override it by setting
+# NAGIOS_CFG_FILE
+#
+# NAGIOS_CFG_FILE=...
+
+export RACK_ENV NAGIRA_LOG NAGIRA_USER RVM_STRING
+
+get_pid () {
+# ps -U ${
+# ps -C ruby -o pid,comm,cmd 
+     #echo $(ps axo pid,command | awk '$2 ~ /ruby/ && $3 ~ /nagira/ {print $1}')
+     echo $(ps -C ruby -o pid,cmd | awk '$2 ~ /^\/usr.*bin\/nagira *$/ {print $1}')
+}
+
+
+start() {
+    [ ! -z "$(get_pid)" ] && { status; return 1; }
+    echo -n "Starting ${process_name}:    "
+    load_defaults
+    su - $NAGIRA_USER -s /bin/bash -c "$RVM_STRING ;  RACK_ENV=$RACK_ENV nagira&" > $NAGIRA_LOG  2>&1 
+    sleep 5
+    process=$(get_pid)
+    if [ -z "$process" ]; then
+        echo "[FAIL]"
+    else
+        echo $process > $pid_file
+        echo "[OK]"
+        status
+    fi
+}
+
+stop() {
+    local process=$(get_pid)
+    [ -z "$process" ] && { status; return 1; }
+
+    echo -n $"Shutting down ${process_name}:    "
+
+    kill $process
+    \rm -f $pid_file
+    RETVAL=$?
+    sleep 2
+    [ -z "$(get_pid)" ] && { echo OK; return $RETVAL; }
+    echo FAIL
+}
+
+status () {
+    local process=$(get_pid)
+    if [ -z "$process" ]; then
+        echo "Process $process_name is not running"
+    else
+        echo "Process $process_name is running with PID: $process"
+    fi
+}
+
+restart() {
+    stop
+    start
+}
+
+RETVAL=0
+
+# See how we were called.
+case "$1" in
+  start)
+        start
+        ;;
+  stop)
+        stop
+        ;;
+  status)
+        status
+        ;;
+  restart|force-reload)
+        restart
+        ;;
+  *)
+        echo $"Usage: $0 {start|stop|status|restart|force-reload}"
+        exit 1
+esac
+
+exit $?