nagira 0.2.12 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a336625df06fa45529696e6c76a24a514c658acc
-  data.tar.gz: 06c24925a8f55086540c180432c78a16012c9bf4
+  metadata.gz: 5a527fc662d7e3b6219167e10099f3c34ffa6e84
+  data.tar.gz: 77ec09dd1e3fab0057f3679168efb249fef63ea1
 SHA512:
-  metadata.gz: ea2dbe47313fa3f3b1a5ca50e328cff6e35df7869918fea89022a7ccb1856a54cab7a62bf123406d681394bb9bf9a735bbd140892fa6fee3b3a83d8ef0fd3ccd
-  data.tar.gz: 9008b71560d0196af7130b684d814d3512a22a6c694d2b966f6932841e5fc8703ddaf73fe53de514a1167b48304a011655eea8e5c33e059525c5b0b0e5d974eb
+  metadata.gz: 8dd228893c307314d2a672a41f8b6a9481f78fbb757b16076c6863b69f1fd8f22cb45aa12e1dc1407530de100a5162921c9f00aa168a01b940bc5d91ad051038
+  data.tar.gz: 4b9a585a556f951961b2435e93a6fecfc8f2a48d9bd57d63a96a8e23276d74ba03ec7aea9b2f8d8dd1a7a982b9ad3334cd44fff34ce5d7d674fa68d6033c1175

data/History.md

@@ -1,3 +1,9 @@
+### v.0.3.0
+* Mon Aug 26 2013 -- Dmytro Kovalov
+  - Feature: Configurable hostname regex (see `NAGIOS_HOST_CUSTOM_REGEXi` in `config/nagira.defaults`)
+* Mon Aug 12 2013 -- Dmytro Kovalov
+  - rake ask for collecting debug information (issues #2)
+
 ### v.0.2.12
 * Thr Aug 08 2013 -- Dmytro Kovalov
   - Implementation for GET comments endpoints:

data/Rakefile

@@ -1,128 +1,16 @@
 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
+$nagira_root   = File.dirname File.expand_path __FILE__ # Where Nagira installed
 
+Dir.glob(File.join($nagira_root, 'lib', 'tasks','*.rake')).each do |rake|
+  load rake
 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
+def log_user msg
+  puts "#{Time.now} -- #{msg.chomp}"
+end
 
-    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/config/defaults.rb

@@ -53,7 +53,29 @@ DEFAULT = {
   # 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')
+  start_background_parser: (ENV['NAGIRA_BG_PARSING'] == '1'),
+
+  ##
+  # By default hostname regular expression accepts alpha-numerics,
+  # dashes and dots, as specified by http://tools.ietf.org/html/rfc952
+  # for hostnames. Extended to accept dots in the middle for FQHN's.
+  # 
+  #
+  # - default: '\w([\w\-\.]+)?\w'
+  # - simple hostname: '\w([\w\-]+)?\w'
+  # - allow space in hostname: '\w([\w\-\.(%20)]+)?\w' 
+  #
+  # Explanation regarding spaces: 
+  # ---------------------------------
+  #
+  # Nagios works OK with hostnames with spaces. This is against RFC's
+  # and can't really used for real hosts, but for aggregated checks
+  # (like cluster name for example), you might want to consider this
+  # option.
+
+  hostname_regex: ENV['NAGIOS_HOST_CUSTOM_REGEX'] || '\w([\w\-\.]+)?\w'
+
+
 }
 
 require 'sinatra'

data/config/nagira.defaults

@@ -64,3 +64,28 @@
 # not need to change.
 #
 # NAGIOS_CFG_FILE=/etc/nagios/nagios.cfg
+#
+# ----------------------
+# Custom regex for hostnames
+# ----------------------
+#
+# By default hostname regular expression accepts alpha-numerics,
+# dashes and dots, as specified by http://tools.ietf.org/html/rfc952
+# for hostnames. Extended to accept dots in the middle for FQHN's.
+#
+# Possible settings:
+#
+# - default: '\w([\w\-\.]+)?\w' FQHN
+# - short hostname: '\w([\w\-]+)?\w'
+# - FQHN allow space in hostname: '\w([\w\-\.(%20)]+)?\w' 
+#
+# Explanation regarding spaces: 
+# ---------------------------------
+#
+# Nagios works OK with hostnames with spaces. This is against RFC's
+# and can't really used for real hosts, but for aggregated checks
+# (like cluster name for example), you might want to consider this
+# option.
+# 
+# NAGIOS_HOST_CUSTOM_REGEX='\w([\w\-\.]+)?\w'
+#

data/lib/app/routes/get/status.rb

@@ -87,7 +87,7 @@ class Nagira < Sinatra::Base
   # @!macro state
   # @!macro list
   # @!macro full
-  get %r{^/_status/(?<hostname>[\w\-\.]+)/_(?<service>(services|hostcomments|servicecomments))$} do |hostname,service|
+  get %r{^/_status/(?<hostname>#{hostname_regex})/_(?<service>(services|hostcomments|servicecomments))$} do |hostname,service|
 
     hostname = hostname.to_i if hostname =~ /^\d+$/
     key = case service
@@ -156,6 +156,10 @@ class Nagira < Sinatra::Base
   #
   # @method get_status_hostname
   #
+  # Endpoint
+  #
+  # - get "/_status/:hostname"
+  #
   # @!macro hostname
   #
   # @!macro accepted
@@ -165,7 +169,7 @@ class Nagira < Sinatra::Base
   # - plural resources: N/A
   # - object access by ID: NO (TODO)
 
-  get "/_status/:hostname" do |hostname|
+  get %r{^/_status/(?<hostname>#{hostname_regex})$} do |hostname|
 
 
     hostname = hostname.to_i if hostname =~ /^\d+$/

data/lib/tasks/config.rake

@@ -0,0 +1,109 @@
+namespace :config do
+
+  @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/lib/tasks/debug.rake

@@ -0,0 +1,49 @@
+namespace :debug do
+  require 'fileutils'
+
+  #
+  # These are default configured files. 
+  #
+  files = %w{ /etc/init.d/nagira /etc/sysconfig/nagira /etc/default/nagira /var/log/nagios/nagira.log }
+  files += Dir.glob(
+                    [
+                      "/etc/nagios*/nagios.cfg", 
+                      "/usr/local/nagios/etc/nagios.cfg"
+                      ]
+                    )
+  files << ENV['NAGIOS_CFG_FILE'] if ENV['NAGIOS_CFG_FILE']
+
+  desc "Collect debugging information: config files, permissions etc."
+  task :collect do
+
+    output = "nagira-debug-output.#{Time.now.to_s.gsub(' ', '_')}.tgz"
+    os_info = %x{ $GEM_HOME/bin/sherlock 2>&1 }
+    permissions = %x{  ls -liL #{files.join ' '} 2>&1 }
+    environment = %x{ (set; export) 2>&1 }
+
+    puts "Creating file #{output}. Please send this file for investigation."
+
+    Dir.mktmpdir {  |dir|
+        
+      $stdout.reopen("#{dir}/stdout.txt", "w")
+      require_relative '../../lib/nagira.rb'
+      require_relative '../../lib/app.rb'
+      #
+      # These files from parsed config.
+      # 
+      files << $nagios[:config].path
+      files << $nagios[:status].path
+      files << $nagios[:objects].path
+      
+      open("#{dir}/sherlock.txt", "w")    { |f| f.puts os_info }
+      open("#{dir}/permissions.txt", "w") { |f| f.puts permissions }
+      open("#{dir}/environment.txt", "w") { |f| f.puts environment }
+      
+      files.each do |ff|
+        FileUtils.cp(ff, "#{dir}/#{ff.gsub('/','_')}") if File.exist? ff
+      end
+      
+      %x{ tar cfz #{output} #{dir} 1>&2 }
+    }
+  end
+end

data/lib/tasks/doc.rake

@@ -0,0 +1,8 @@
+namespace :doc do
+  
+  desc 'Generate YARD documentation'
+  task :yard do
+    sh 'yardoc'
+  end
+
+end

data/spec/get/endpoints_spec.rb

@@ -7,20 +7,30 @@ require 'spec_helper'
 shared_examples_for :fail_on_random_url do |base|  
   RANDOM.each do |url|
     ep = "#{base}/#{url}"
-    it "fails on #{ep} string" do
+    it "fails on '#{ep}' string" do
       get ep
       last_response.status.should be 404
     end
   end
 end
 
-shared_examples_for :respond_to_valid_url do |base, urls|
-  urls.each do |url|
-    ep = "#{base}/#{url}"
-    it "responds to #{ep}" do
-      get ep
-      last_response.should be_ok
+shared_examples_for :respond_to_valid_url do |base, urls, custom_regex|
+
+  case urls
+    when Array
+    urls.each do |url|
+      ep = "#{base}/#{url}"
+      it "responds to #{ep}" do
+        get ep
+        last_response.should be_ok
+      end
     end
+    when nil
+      ep = "#{base}"
+      it "responds to #{ep}" do
+        get ep
+        last_response.should be_ok
+      end
   end
 end
 
@@ -41,7 +51,9 @@ describe Nagira do
   
   context "API endpoints" do
     
-    host = IMPLEMENTED[:hosts].first 
+    host   = IMPLEMENTED[:hosts].first 
+    spaces = "host%20with%20space"
+
 
     context :top do 
       it_should_behave_like :respond_to_valid_url,  '', IMPLEMENTED[:top]
@@ -59,14 +71,33 @@ describe Nagira do
       it_should_behave_like :respond_to_valid_url,  "/_status/#{host}", IMPLEMENTED[:status]
       it_should_behave_like :fail_on_random_url,    "/_status/#{host}"
 
+      context "hostname with space" do
+        it_should_behave_like :fail_on_bad_url,  "/_status/#{spaces}"
+      end
+
       context :unknown_host do
         it_should_behave_like :fail_on_bad_url,       '/_status/unknown_host'
         it_should_behave_like :fail_on_random_url,    "/_status/unknown_host"
       end
+    end                         # /_status/:host
+
+    context "/_status/:host/_services" do 
+      it_should_behave_like :respond_to_valid_url,  "/_status/#{host}/_services"
+      it_should_behave_like :respond_to_valid_url,  "/_status/#{host}/_services", ["SSH", "PING"]
 
+      context "hostname with space" do
+        it_should_behave_like :fail_on_bad_url,  "/_status/#{spaces}/_services"
+      end
     end
 
-  end                           # API endpoints
 
+    context "custom hostname regex - host with spaces" do
+        
+      it { pending "Need to figure out how to change hostname regex on the fly" }
+        #it_should_behave_like :respond_to_valid_url,  "/_status/#{spaces}", nil, '\w[(%20)\w\-\.]+'
+        #it_should_behave_like :respond_to_valid_url,  "/_status/#{spaces}/_services"
+    end                         # custom hostname regex
+    
+  end                           # API endpoints
     
 end

data/spec/get/services_spec.rb

@@ -1,4 +1,8 @@
 require 'spec_helper'
+#
+# Specs for returned data for /_status/* endpoints.
+#
+# Endpoint checks (i.e. check HTTP success) are in  endpoints_spec.rb
 
 describe Nagira do 
   

data/test/data/status.dat

@@ -112,6 +112,63 @@ hoststatus {
 	scheduled_downtime_depth=0
 	}
 
+hoststatus {
+	host_name=host with space
+	modified_attributes=0
+	check_command=check-host-alive
+	check_period=
+	notification_period=_24x7
+	check_interval=5.000000
+	retry_interval=1.000000
+	event_handler=
+	has_been_checked=1
+	should_be_scheduled=1
+	check_execution_time=3.011
+	check_latency=0.071
+	check_type=0
+	current_state=1
+	last_hard_state=1
+	last_event_id=19699
+	current_event_id=19702
+	current_problem_id=8664
+	last_problem_id=8611
+	plugin_output=CRITICAL - Host Unreachable (192.168.2.72)
+	long_plugin_output=
+	performance_data=
+	last_check=1325284831
+	next_check=1325285141
+	check_options=0
+	current_attempt=1
+	max_attempts=10
+	current_event_id=19702
+	last_event_id=19699
+	state_type=1
+	last_state_change=1324805581
+	last_hard_state_change=1324805581
+	last_time_up=1324787230
+	last_time_down=1325284841
+	last_time_unreachable=0
+	last_notification=1324805581
+	next_notification=1324805581
+	no_more_notifications=1
+	current_notification_number=1
+	current_notification_id=2118
+	notifications_enabled=1
+	problem_has_been_acknowledged=0
+	acknowledgement_type=0
+	active_checks_enabled=1
+	passive_checks_enabled=1
+	event_handler_enabled=1
+	flap_detection_enabled=1
+	failure_prediction_enabled=1
+	process_performance_data=1
+	obsess_over_host=1
+	last_update=1325285001
+	is_flapping=0
+	percent_state_change=0.00
+	scheduled_downtime_depth=0
+	}
+
 hoststatus {
 	host_name=gateway
 	modified_attributes=0
@@ -575,6 +632,67 @@ servicestatus {
 	scheduled_downtime_depth=0
 	}
 
+
+servicestatus {
+	host_name=host with space
+	service_description=SSH
+	modified_attributes=0
+	check_command=check_ssh
+	check_period=_24x7
+	notification_period=_24x7
+	check_interval=5.000000
+	retry_interval=1.000000
+	event_handler=
+	has_been_checked=1
+	should_be_scheduled=1
+	check_execution_time=3.012
+	check_latency=0.226
+	check_type=0
+	current_state=2
+	last_hard_state=2
+	last_event_id=19664
+	current_event_id=19686
+	current_problem_id=8675
+	last_problem_id=8662
+	current_attempt=1
+	max_attempts=4
+	current_event_id=19686
+	last_event_id=19664
+	state_type=1
+	last_state_change=1324805222
+	last_hard_state_change=1324805222
+	last_time_ok=1324787091
+	last_time_warning=0
+	last_time_unknown=0
+	last_time_critical=1325284922
+	plugin_output=No route to host
+	long_plugin_output=
+	performance_data=
+	last_check=1325284922
+	next_check=1325285222
+	check_options=0
+	current_notification_number=0
+	current_notification_id=0
+	last_notification=0
+	next_notification=0
+	no_more_notifications=0
+	notifications_enabled=1
+	active_checks_enabled=1
+	passive_checks_enabled=1
+	event_handler_enabled=1
+	problem_has_been_acknowledged=0
+	acknowledgement_type=0
+	flap_detection_enabled=1
+	failure_prediction_enabled=1
+	process_performance_data=1
+	obsess_over_service=1
+	last_update=1325285001
+	is_flapping=0
+	percent_state_change=0.00
+	scheduled_downtime_depth=0
+	}
+
+
 servicestatus {
 	host_name=kurobka
 	service_description=Check time

data/version.txt

@@ -1 +1 @@
-0.2.12
+0.3.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nagira
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.3.0
 platform: ruby
 authors:
 - Dmytro Kovalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -293,6 +293,9 @@ files:
 - lib/nagira/nagios.rb
 - lib/nagira/timed_parse.rb
 - lib/nagira.rb
+- lib/tasks/config.rake
+- lib/tasks/debug.rake
+- lib/tasks/doc.rake
 - spec/00_configuration_spec.rb
 - spec/01_data_format/01_nagira_response_spec.rb
 - spec/01_data_format/02_0_status_spec.rb
@@ -348,7 +351,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: 'Nagira : Nagios RESTful API'