fluent-plugin-spectrum 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6ce4a6b4bf074348bde00e83c87e8559e07549c
-  data.tar.gz: cf2079f18bffc80dee8fe1c547d26460ff2a862e
+  metadata.gz: 0c949d2e99ee26e2c94f69cc95f51691bfcb6c06
+  data.tar.gz: a0a20f56156aebccbbb21da927b1d7e145622d60
 SHA512:
-  metadata.gz: dde69f607871058aa60138bd5a177323a0e0fac45ff6b62c0f13ef74699a5b948974161759b1417609abf02f0e01fc16bb26c5da60971da4dcbc85e6909c83dd
-  data.tar.gz: 656594019157e6a2555673e9d61094d89a420533c7fca7b1c0d6b909d5e669701edd895618c0b75e47af5c2c5438504dcab801101bbb0486dde1d14578aab052
+  metadata.gz: 00b234557427b77bc8ed240f432f74ebb6114cb844af5740eca0215d308ee38e16bde66cdf5147081323794a596ee29cb39cd6515b962849b1f34afc9e9b45cd
+  data.tar.gz: 51d6ba395c211abea598b69cabb28178c91b03d2238c631b1909597fd5a6d8f102db1d8a0bca665450c77da34dc38a383a63503637496b17e52ced3327dc652c

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 rvm:
+  - 1.9.3
   - 2.0.0
-  - 2.0.0-p451
   - 2.1.0
+  - 2.2.1
 
 gemfile:
  - Gemfile

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
-
 # Specify your gem's dependencies in fluent-plugin-spectrum.gemspec
 gemspec

data/README.md

@@ -3,9 +3,11 @@
 fluent-plugin-spectrum is an input plug-in for [Fluentd](http://fluentd.org)
 
 ## Status
-[![Gem Version](https://badge.fury.io/rb/fluent-plugin-spectrum.png)](http://badge.fury.io/rb/fluent-plugin-spectrum)
 [![Build Status](https://travis-ci.org/Bigel0w/fluent-plugin-spectrum.png?branch=master)](https://travis-ci.org/Bigel0w/fluent-plugin-spectrum)
 [![Coverage Status](https://coveralls.io/repos/Bigel0w/fluent-plugin-spectrum/badge.png?branch=master)](https://coveralls.io/r/Bigel0w/fluent-plugin-spectrum?branch=master)
+[![Dependency Status](https://gemnasium.com/Bigel0w/fluent-plugin-spectrum.svg)](https://gemnasium.com/Bigel0w/fluent-plugin-spectrum)
+[![Code Climate](https://codeclimate.com/github/Bigel0w/fluent-plugin-spectrum/badges/gpa.svg)](https://codeclimate.com/github/Bigel0w/fluent-plugin-spectrum)
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-spectrum.png)](http://badge.fury.io/rb/fluent-plugin-spectrum)
 
 ## Installation
 
@@ -94,8 +96,6 @@ Verify:
 		2015-03-05 15:04:00 -0800 alert.spectrum: {"event_type":"alert.spectrum","intermediary_source":"spectrumapi001.corp.yourdomain.net","ALARM_ID":"54f8e0e0-e706-12c2-0165-005056a07ac5","CREATION_DATE":"1425596640","SEVERITY":"3","ALARM_TITLE":"LOGMATCH TRAPSEND CRIT","HOSTNAME":"yourhost001.corp.yourdomain.net","IP_ADDRESS":"10.10.0.14","ORIGINATING_EVENT_ATTR":"A SEC logmatch trapsend CRIT Your Alert Message here","MODEL_STRING":"Host_Device","ACKNOWLEDGED":"false","ALARM_STATUS":"","OCCURRENCES":"1","TROUBLE_SHOOTER":"","USER_CLEARABLE":"true","TROUBLE_TICKET_ID":"","PERSISTENT":"true","GC_NAME":"Your_Global_Collection"}
 
 ## To Do
-* Add retry login. On timeout/failure retry, how often, increasing delay? (how would that affect polling time, possible duplicates?)
 * All flag to allow specifying spectrum attributes to get or get _ALL_
 * Add flag to allow start date/time if users want to backfill data from a specific date. then start loop. 
-* Add flag to disable loop, if users only wanted to backfill from datetime to now or specific end time. 
-* Change loop to allow multiple runs to stack on eachother to avoid missing data?
+* Add flag to disable loop, if users only wanted to backfill from datetime to now or specific end time. 

data/Rakefile

@@ -1,5 +1,5 @@
-#!/usr/bin/env rake
 require 'bundler'
+require "bundler/gem_tasks"
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -10,4 +10,4 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :default => [:build]
+task :default => [:test]

data/fluent-plugin-spectrum.gemspec

@@ -3,12 +3,12 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-spectrum"
-  gem.version       = "0.0.5"
-  gem.date          = '2015-03-31'
+  gem.version       = "0.0.6"
+  gem.date          = '2015-04-04'
   gem.authors       = ["Alex Pena"]
   gem.email         = ["pena.alex@gmail.com"]
-  gem.summary       = %q{Fluentd input plugin for pulling alerts from CA Spectrum}
-  gem.description   = %q{Fluentd plugin for pulling monitoring alerts from CA Spectrum}
+  gem.summary       = %q{Fluentd plugin for managing monitoring alerts from CA Spectrum}
+  gem.description   = %q{Fluentd input/output plugin for managing monitoring alerts from CA Spectrum. Input supports polling CA Spectrum APIs. Output currently only supports updating events retrieved from Spectrum.}
   gem.homepage      = 'https://github.com/Bigel0w/fluent-plugin-spectrum'
   gem.license       = 'MIT'
 
@@ -16,10 +16,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
-
-  gem.add_development_dependency "rake", '~> 0.9', '>= 0.9.6'
-
-  gem.add_runtime_dependency "fluentd", '~> 0.10', '>= 0.10.52'
-  gem.add_runtime_dependency "json", '~> 1.1', '>= 1.8.2'
-  gem.add_runtime_dependency "rest-client", '~> 1.7', '>= 1.7.3'
+  # dev deps
+  gem.add_development_dependency "rake", '~> 10.0'
+  gem.add_development_dependency "bundler", '~> 1.6'
+  gem.add_development_dependency "test-unit", '~> 3.0'
+  # runtime deps
+  gem.add_runtime_dependency "fluentd", '~> 0.12'
+  gem.add_runtime_dependency "json", '~> 1.8'
+  gem.add_runtime_dependency "rest-client", '~> 1.8'
 end

data/lib/fluent/plugin/in_spectrum.rb

@@ -1,16 +1,19 @@
 module Fluent
   class SpectrumInput < Input
     Fluent::Plugin.register_input('spectrum', self)
-    config_param :tag, :string, :default => "alert.spectrum"
-    config_param :endpoint, :string, :default => nil
-    config_param :username, :string, :default => nil
-    config_param :password, :string, :default => nil
-    config_param :interval, :integer, :default => 300 # shoud stay above 10, avg response is 5-7 seconds
-
-    config_param :state_file, :string, :default => nil
-    config_param :include_raw, :string, :default => "false"
-    config_param :attributes, :string, :default => "ALL"
-    config_param :select_limit, :time, :default => 10000
+    
+    # Configurations
+    INTERVAL_MIN = 10 # shoud stay above 10, avg response is 5-7 seconds
+    config_param  :tag,           :string,  :default => "alert.spectrum"
+    config_param  :endpoint,      :string,  :default => nil
+    config_param  :username,      :string,  :default => nil
+    config_param  :password,      :string,  :default => nil
+    config_param  :state_file,    :string,  :default => nil
+    config_param  :attributes,    :string,  :default => "ALL"
+    config_param  :interval,      :integer, :default => INTERVAL_MIN
+    config_param  :select_limit,  :integer, :default => 10000
+    config_param  :include_raw,   :bool,    :default => "false"
+    config_param  :debug_mode,    :bool,    :default => false
 
     # Classes
     class TimerWatcher < Coolio::TimerWatcher
@@ -90,10 +93,22 @@ module Fluent
     def configure(conf)
       super 
       @conf = conf
-
+      # Only check configs if debug is off
+      unless @debug_mode
+        # Verify configs
+        # Stop if required fields are not set
+        unless @endpoint && @username && @password
+          raise ConfigError, "Spectrum :: ConfigError 'endpoint' and 'username' and 'password' must be all specified."
+        end
+        # Enforce min interval
+        if @interval.to_i < INTERVAL_MIN
+          raise ConfigError, "Spectrum :: ConfigError 'interval' must be #{INTERVAL_MIN} or over."
+        end
+      end
+      # Warn about optional state file
       unless @state_file
-        $log.warn "'state_file PATH' parameter is not set to a valid source."
-        $log.warn "this parameter is highly recommended to save the last known good timestamp to resume event consuming"
+        $log.warn "Spectrum :: 'state_file PATH' parameter is not set to a valid source."
+        $log.warn "Spectrum :: this parameter is highly recommended to save the last known good timestamp to resume event consuming"
       end
       # map of Spectrum attribute codes to names
       @spectrum_access_code={
@@ -144,13 +159,11 @@ module Fluent
       @spectrum_access_code.each do |key, array|
         @attr_of_interest += " <rs:requested-attribute id=\"#{key}\"/>"
       end
-      
-      # Setup URL Resource
+      # URL Resource
       def resource
         @url = 'http://' + @endpoint.to_s + '/spectrum/restful/alarms'
-        RestClient::Resource.new(@url, :user => @username, :password => @password, :open_timeout => 3, :timeout => (@interval * 2))
+        RestClient::Resource.new(@url, :user => @username, :password => @password, :open_timeout => 5, :timeout => (@interval * 3))
       end
-
       ### need to add this but first figure out how to pass a one time override for timeout since get takes a longtime to return
       #test = resource.get
       #if test.code.to_s == 200
@@ -187,15 +200,20 @@ module Fluent
         pollingStart = Engine.now.to_i
         if @state_store.last_records.has_key?("spectrum") 
           alertStartTime = @state_store.last_records['spectrum']
-          #$log.info "Spectrum :: Got time record from state_store - #{alertStartTime}" 
+          if @debug_mode
+            $log.info "Spectrum :: Got time record from state_store - #{alertStartTime}"
+          end 
         else
           alertStartTime = (pollingStart.to_i - @interval.to_i)
-          #$log.info "Spectrum :: Got time record from initial config - #{alertStartTime}"
+          if @debug_mode
+            $log.info "Spectrum :: Got time record from initial config - #{alertStartTime}"
+          end
         end
         pollingEnd = ''
         pollingDuration = ''
-        #$log.info "Spectrum :: Polling alerts for time period < #{alertStartTime.to_i}"
-
+        if @debug_mode
+          $log.info "Spectrum :: Polling alerts for time period < #{alertStartTime.to_i}"
+        end
         # Format XML for spectrum post
         @xml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
         <rs:alarm-request throttlesize=\"#{select_limit}\"
@@ -219,7 +237,9 @@ module Fluent
         # Post to Spectrum and parse results
         begin
           res=resource.post @xml,:content_type => 'application/xml',:accept => 'application/json'
-          #$log.info "Response code #{res.code.to_s}"
+          if @debug_mode
+            $log.info "Spectrum :: Response code #{res.code.to_s}"
+          end
           body = JSON.parse(res.body)
           pollingEnd = Engine.now.to_i
           @state_store.last_records['spectrum'] = pollingEnd
@@ -236,7 +256,7 @@ module Fluent
             raw_array = Array.new # temp hash to hold attributes of alarm for raw
             record_hash['event_type'] = @tag.to_s
             record_hash['intermediary_source'] = @endpoint.to_s
-            record_hash['recieved_time_input'] = pollingEnd.to_s
+            record_hash['receive_time_input'] = pollingEnd.to_s
             # iterate though alarm attributes
             alarm['ns1.attribute'].each do |attribute|
               key,value = parseAttributes(attribute)
@@ -259,7 +279,7 @@ module Fluent
           raw_array = Array.new # temp hash to hold attributes of alarm for raw
           record_hash['event_type'] = @tag.to_s
           record_hash['intermediary_source'] = @endpoint.to_s
-          record_hash['recieved_time_input'] = pollingEnd.to_s
+          record_hash['receive_time_input'] = pollingEnd.to_s
           # iterate though alarm attributes and add to temp hash  
           body['ns1.alarm-response-list']['ns1.alarm-responses']['ns1.alarm']['ns1.attribute'].each do |attribute|
             key,value = parseAttributes(attribute)

data/test/helper.rb

@@ -1,5 +1,7 @@
-require 'rubygems'
 require 'bundler'
+require 'test/unit'
+require 'fluent/test'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -7,11 +9,10 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'test/unit'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'fluent/test'
+
 unless ENV.has_key?('VERBOSE')
   nulllogger = Object.new
   nulllogger.instance_eval {|obj|

data/test/plugin/test_in_spectrum.rb

@@ -1,24 +1,33 @@
 require 'helper'
 
 class SpectrumInputTest < Test::Unit::TestCase
+
   def setup
     Fluent::Test.setup
   end
 
   CONFIG = %[
+    username test_username
+    password test_password
+    endpoint test.endpoint.com
   ]
 
-  def create_driver(conf=CONFIG)
+  def create_driver(conf = CONFIG)
     Fluent::Test::InputTestDriver.new(Fluent::SpectrumInput).configure(conf)
   end
 
   def test_configure
-    d = create_driver('')
-    #assert_equal "pleasechangeme.com", d.instance.endpoint
-    #assert_equal "username", d.instance.user
-    #assert_equal "password", d.instance.pass
-    assert_equal "300".to_i, d.instance.interval
+    assert_nothing_raised { create_driver }
+  end
+
+  def test_params
+    d = create_driver
+    assert_equal "test.endpoint.com", d.instance.endpoint
+    assert_equal "test_username", d.instance.username
+    assert_equal "test_password", d.instance.password
+    assert_equal "10".to_i, d.instance.interval
     assert_equal "false", d.instance.include_raw
     assert_equal 'alert.spectrum', d.instance.tag
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-spectrum
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Alex Pena
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,81 +16,87 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.52
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.52
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.3
-description: Fluentd plugin for pulling monitoring alerts from CA Spectrum
+        version: '1.8'
+description: Fluentd input/output plugin for managing monitoring alerts from CA Spectrum.
+  Input supports polling CA Spectrum APIs. Output currently only supports updating
+  events retrieved from Spectrum.
 email:
 - pena.alex@gmail.com
 executables: []
@@ -132,7 +138,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Fluentd input plugin for pulling alerts from CA Spectrum
+summary: Fluentd plugin for managing monitoring alerts from CA Spectrum
 test_files:
 - test/helper.rb
 - test/plugin/test_in_spectrum.rb