fluent-plugin-spectrum 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a907d9e3749f2604e633e9d2e7d208b2595eca8
-  data.tar.gz: 6bf4af623fa6d9aed08638ea59d474a694bf2e87
+  metadata.gz: 2d4288f068c625207769f4fa29e28d38f942ad83
+  data.tar.gz: fb7cbc18c897472e626cea9320d0680cfc2de45d
 SHA512:
-  metadata.gz: b6d14688b87fa043d58a4eaef3394507a82c64b0178a7d32f435a00d5d1c6ea429a1ed44853cd8c4af268d997ca7d3a0748b78e40d4dbf2e75fc020440783266
-  data.tar.gz: a48028226c73f7a715a43861ed31fe9eec1ecf2aac9ba7ec536a88cfa6ed39ba1b81b2314326fc1ea29021001115ba012266d206837b214fc2f3783407e91378
+  metadata.gz: 52fa80683e053aea5ae9cbc7a4575a6c7076fa72f01ebc6f650028e0ee36cc908cf6f7119c975de14f8099b4a5d50f11877ea6a726795b728dc27525851cf56c
+  data.tar.gz: 270493f647b3fa8d156941e27772b2f9f3662b8eb91f4c256edea218e72b5c1db04e54189b474884afa15505de36136ddc534f8ed11704aab8da8908fc8ff365

data/README.md

@@ -20,30 +20,70 @@ Or install it yourself as:
 ## Usage
 Add the following into your fluentd config.
 
+Simple:
+
 	<source>
-	 type spectrum # required, choosing the input plugin
-	 endpoint spectrumapi.corp.yourdomain.net # required, FQDN of spectrum endpoint
-	 user username # required, username for APIs
-	 pass password # required, password for APIs
-	 tag alert.spectrum # optional, tag to assign to events, default is alert.spectrum
-	 interval 60 # optional, interval in seconds for how often to poll, defaults to 300
-	 include_raw false # optional, include original object as key raw
-	</source>
+		type spectrum 						# required, choosing the input plugin
+    	endpoint spectrum.yourdomain.com 	# required, FQDN of spectrum endpoint
+    	user username 						# required, username for APIs
+    	pass password 						# required, password for APIs
+    	tag alert.spectrum 					# optional, tag to assign to events, default is alert.spectrum
+    	interval 60 						# optional, interval in seconds for how often to poll, defaults to 300
+    	include_raw false 					# optional, include original object as key raw
+    </source>
 
 	<match alert.spectrum>
-	 type stdout
+  		type stdout
+	</match>
+
+Advanced:
+
+	<source>
+		type spectrum 						# required, choosing the input plugin
+    	endpoint spectrum.yourdomain.com 	# required, FQDN of spectrum endpoint
+    	user username 						# required, username for APIs
+    	pass password 						# required, password for APIs
+    	tag alert.spectrum 					# optional, tag to assign to events, default is alert.spectrum
+    	interval 60 						# optional, interval in seconds for how often to poll, defaults to 300
+    	include_raw true 					# optional, include original object as key raw
+    </source>
+    # using rename_key to map to new keynames
+	<match alert.spectrum>
+  		type rename_key
+  		deep_rename false
+  		remove_tag_prefix alert.spectrum
+  		append_tag alert
+  		rename_rule1 HOSTNAME source_hostname
+  		rename_rule2 IP_ADDRESS source_ip
+  		rename_rule3 ALARM_TITLE event_name
+  		rename_rule4 SEVERITY criticality
+  		rename_rule5 CREATION_DATE creation_time
+  		rename_rule6 ORIGINATING_EVENT_ATTR alert_description
+  		rename_rule7 MODEL_STRING source_type
+  		rename_rule8 ALARM_ID source_event_id
+  		rename_rule9 GC_NAME environment
+	</match>
+	# using key_picker to remove extra fields
+	<match alert>
+  		type key_picker
+  		keys event_type,intermediary_source,source_event_id,creation_time,criticality,event_name,source_hostname,source_ip,alert_description,source_type,environment,raw
+  		add_tag_prefix processed.
+	</match>
+	<match processed.alert>
+  		type stdout
 	</match>
 
 Now startup fluentd
 
     $ sudo fluentd -c fluent.conf &
 
-Send a test 
-    TBD
+Send a test
+
+	TBD: Still need to create an example
 
 ## 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 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?

data/fluent-plugin-spectrum.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-spectrum"
-  gem.version       = "0.0.2"
+  gem.version       = "0.0.3"
   gem.date          = '2015-02-24'
   gem.authors       = ["Alex Pena"]
   gem.email         = ["alex_pena@intuit.com"]
@@ -21,5 +21,5 @@ Gem::Specification.new do |gem|
 
   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.1', '>= 1.8.3'
+  gem.add_runtime_dependency "rest-client", '~> 1.7', '>= 1.7.3'
 end

data/lib/fluent/plugin/in_spectrum.rb

@@ -37,7 +37,7 @@ module Fluent
     end
 
     def initialize
-      require 'rest_client'
+      require 'rest-client'
       require 'json'
       super
     end # def initialize

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-spectrum
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alex Pena
@@ -71,25 +71,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.8.2
 - !ruby/object:Gem::Dependency
-  name: rest_client
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 1.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 1.7.3
 description: Fluentd plugin for Spectrum Alerts... WIP
 email:
 - alex_pena@intuit.com