logstash-filter-exceptioncategory 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15665749908c8facf793c3d8ba86bb7f29ad64a9
-  data.tar.gz: b4f6c2ba582343f96bdeba2f966b24d7f699d5dd
+  metadata.gz: 1fc9c7edbf457edfbf86475a5069da09613afe25
+  data.tar.gz: 0bc32e1c5c4485a8120dd51068d5d2726b80c576
 SHA512:
-  metadata.gz: 9fc6094f6c818d416c90749eb83ff87d3390bc04a36f14632d0b1363d97c3075db9699405e40f5ab47552b26daad46c048d52761bdc21e7c9a3db0d48eff3ff2
-  data.tar.gz: 193f95d7c6a6c8b46d2b77e58e71694788e4713dd8a4b79ea5a08d7dc430bf2b594d16fd5155379f60c152a16fa731b345af0040490e858b3fdade34640ea93a
+  metadata.gz: e53b5a33d28b22e4f0b075eb13bacadcfe839f0216da0a38d1acb664ed2d27ba40e9e7656f5e9d3027aa82904b2f35c2c8a43eab0981ca4d50936484d6097c70
+  data.tar.gz: c40aa5e7f9c5f9453975715368d443161b7cb71db1ac8b94962c5e72a24792166a01fc82e3939b547f98ff2126b238105d5dd01c3839c47d55a1d294705a8783

data/Gemfile

@@ -1,2 +1,2 @@
-source 'https://rubygems.org'
-gemspec
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -1 +1,13 @@
-Apache License 2.0
+Copyright [yyyy] [author]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,25 +1,27 @@
-# ExceptionsCategory
-
-This Logstash filter sends an html request for a json document.
-It then looks up the @Exception attached to the event in that json document.
-If that exception is present in the json document and has an attached category, it then attaches the category as @Category.
-
-Usage:
-```
-filter {
-    exceptionscategory {
-        category_url => "url/to/json"
-    }
-}
-```
-Where _category_url_ is a required parameter, pointing to the url of the json document.
-
-The json document must be structured as follows:
-```json
-{
-    "Exceptions": {
-        "BadException": "Severe",
-        "GoodException": "Warning"
-    }
-}
-```
+# ExceptionsCategory
+
+This Logstash filter sends an html request for a json document.
+It then looks up the @Exception attached to the event and tries to match that to a category from the json document.
+If it fails to do so, it looks up the Title attached to the event and tries the same thing with the Title.
+
+If neither of those attributes are attached to the event, or if neither of them are present in the json document, it attached a _None_ category to the event.
+
+Usage:
+```
+filter {
+    exceptionscategory {
+        category_url => "url/to/json"
+    }
+}
+```
+Where _category_url_ is a required parameter, pointing to the url of the json document.
+
+The json document must be structured as follows:
+```json
+{
+    "Exceptions": {
+        "BadException": "Severe",
+        "GoodException": "Warning"
+    }
+}
+```

data/lib/logstash/filters/exceptioncategory.rb

@@ -1,49 +1,56 @@
-# encoding: utf-8
-require "logstash/filters/base"
-require "logstash/namespace"
-require 'net/http'
-require 'json'
-
-class LogStash::Filters::ExceptionCategory < LogStash::Filters::Base
-
-  config_name "exceptioncategory"
-
-  config :category_url, :validate => :string, :required => true
-
-  public
-  def register
-    uri = URI(@category_url)
-    response = Net::HTTP.get(uri)
-    begin
-      @exceptions = JSON.parse(response)
-    rescue JSON::ParserError => e
-      @logger.error("The URL does not respond with a valid JSON object", :exception => e)
-      raise e 
-    end
-
-    checkJSON()
-
-  end # def register
-
-  public
-  def filter(event)
-    event_exception = event["@Exception"]
-    
-    event_exception && category = @exceptions["Exceptions"][event_exception]
-    event["@Category"] = (category ? category : "None")
-
-    filter_matched(event)
-  end # def filter
-
-  def checkJSON()
-    unless @exceptions["Exceptions"]
-      @logger.error("JSON Object does not contain Exceptions field")
-      raise "Malformed JSON"
-    end
-
-    unless @exceptions["Exceptions"].respond_to?(:has_key?)
-      @logger.error("Malformed JSON Object, Exceptions should include a JSON object, not an array")
-      raise "Malformed JSON"
-    end
-  end #def checkJSON
-end # class LogStash::Filters::Example
+# encoding: utf-8
+require 'logstash/filters/base'
+require 'logstash/namespace'
+require 'net/http'
+require 'json'
+
+class LogStash::Filters::ExceptionCategory < LogStash::Filters::Base
+
+	config_name "exceptioncategory"
+
+	config :category_url, :validate => :string, :required => true
+
+	public
+	def register
+		uri = URI(@category_url)
+		response = Net::HTTP.get(uri)
+		begin
+			@Exceptions = JSON.parse(response)
+		rescue JSON::ParserError => e
+			@logger.error("The URL does not respond with a valid JSON object", :exception => e)
+			raise e
+		end
+
+		checkJSON()
+	end # def register
+
+	public
+	def filter(event)
+
+		event["Title"] = "System.Security.SecurityException"
+
+		categories = @Exceptions["Exceptions"]
+		event_exception = event["@Exception"]
+
+		unless categories.key?(event_exception)
+			event_exception = event["Title"]
+		end
+
+		event_exception && category = categories[event_exception]
+		event["@Category"] = (category ? category : "None")
+
+		filter_matched(event)
+	end #def filter
+
+	def checkJSON()
+		unless @Exceptions["Exceptions"]
+			@logger.error("JSON Object does not contain Exceptions field")
+			raise "Malformed JSON"
+		end
+
+		unless @Exceptions["Exceptions"].respond_to?(:has_key?)
+			@logger.error("Malformed JSON Object, Exceptions should include a JSON object, not an array")
+			raise "Malformed JSON"
+		end
+	end #def checkJSON
+end # LogStash::Filters::Example

data/logstash-filter-exceptioncategory.gemspec

@@ -1,19 +1,20 @@
-Gem::Specification.new do |s|
-  s.name = 'logstash-filter-exceptioncategory'
-  s.version = '0.1.1'
-  s.licenses = ['Apache License (2.0)']
-  s.summary = "Example filter"
-  s.description = "This is an example filter"
-  s.authors = ['Raggi']
-  s.email = "info@elastic.co"
-  s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
-  s.require_paths = ["lib"]
-
-  # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
-
-  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
-
-  s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
-  s.add_development_dependency "logstash-devutils", '~> 0'
-end
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+	s.name = 'logstash-filter-exceptioncategory'
+	s.version = '0.1.2'
+	s.licenses = ['Apache License (2.0)']
+	s.summary = "Categorizes exceptions"
+	s.description = "Fetches a remote json file which includes categorization of exceptions. Uses that categorization to attach a category to an event depending on which exception the event has."
+	s.authors = ['Ragnar Adolf Árnason']
+	s.email = "ragnara@tmsoftware.is"
+	s.homepage = "http://www.tmsoftware.is"
+	s.require_paths = ["lib"]
+
+	s.files = Dir['lib/**/*', 'spec/**/*', '*.gemspec', '*.md', 'Gemfile', 'LICENSE']
+
+	s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+	s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
+	s.add_development_dependency "logstash-devutils", "~> 0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-exceptioncategory
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- Raggi
+- Ragnar Adolf Árnason
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-09 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -38,8 +38,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0'
-description: This is an example filter
-email: info@elastic.co
+description: Fetches a remote json file which includes categorization of exceptions. Uses that categorization to attach a category to an event depending on which exception the event has.
+email: ragnara@tmsoftware.is
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -49,8 +49,8 @@ files:
 - README.md
 - lib/logstash/filters/exceptioncategory.rb
 - logstash-filter-exceptioncategory.gemspec
-- spec/filters/example_spec.rb
-homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+- spec/filters/exceptioncategory_spec.rb
+homepage: http://www.tmsoftware.is
 licenses:
 - Apache License (2.0)
 metadata:
@@ -75,5 +75,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
-summary: Example filter
+summary: Categorizes exceptions
 test_files: []